Quality management APIs
Creates an external correspondence
| HTTP method | POST |
| URI | https://api.rambase.net/quality/issues/{qualityIssueId}/external-correspondences |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {qualityIssueId} |
Quality issue identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 4876, version 5 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
Type
Required/mandatory field
Type of external correspondence (CAR/NCR etc)
Applicable domain values can be found here
>{Integer}</Type>Description
Description
This field is optional.
>{String}</Description>Cause
String list of causes
This field is optional.
>{String}</Cause>Actions
This field is optional.
>Suggested
String list of suggested actions
This field is optional.
>{String}</Suggested>Immediate
String list of immediate actions.
This field is optional.
>{String}</Immediate>Corrective
String list of corrective actions
This field is optional.
>{String}</Corrective>Responsible
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>Context
This field is optional.
>AffectedQuantity
Number of affected units
Minimum value: 0
This field is optional.
>{Integer}</AffectedQuantity>TotalQuantity
Total amount of units
Minimum value: 0
This field is optional.
>{Integer}</TotalQuantity>ProductUnits
String list of product units
This field is optional.
>{String}</ProductUnits>Product
This field is optional.
>ProductId
Product source id
This field is optional.
>{Integer}</ProductId>Customer
This field is optional.
>CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
>{Integer}</CustomerId>Supplier
This field is optional.
>SupplierId
RamBase supplier identifier
Minimum value: 100
This field is optional.
>{Integer}</SupplierId>ProductionResource
This field is optional.
>ProductionResourceId
Production resource identifier
Minimum value: 100000
This field is optional.
>{Integer}</ProductionResourceId>SalesOrder
This field is optional.
>SalesOrderId
Sales order identifier
Minimum value: 100000
This field is optional.
>{Integer}</SalesOrderId>Manufacturer
This field is optional.
>ManufacturerId
Manufacturer identifier
Minimum value: 1000
This field is optional.
>{Integer}</ManufacturerId>Material
This field is optional.
>ProductId
Product source id
This field is optional.
>{Integer}</ProductId>ProductionWorkOrder
This field is optional.
>ProductionWorkOrderId
Production work order identifier
Minimum value: 100000
This field is optional.
>{Integer}</ProductionWorkOrderId>PurchaseOrder
This field is optional.
>PurchaseOrderId
Purchase order identifier
Minimum value: 100000
This field is optional.
>{Integer}</PurchaseOrderId>Type
Required/mandatory field
Type of external correspondence (CAR/NCR etc)
Applicable domain values can be found here
": "{Integer}",Description
Description
This field is optional.
": "{String}",Cause
String list of causes
This field is optional.
": "{String}",Actions
This field is optional.
": {Suggested
String list of suggested actions
This field is optional.
": "{String}",Immediate
String list of immediate actions.
This field is optional.
": "{String}",Corrective
String list of corrective actions
This field is optional.
": "{String}"Responsible
This field is optional.
": {EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"Context
This field is optional.
": {AffectedQuantity
Number of affected units
Minimum value: 0
This field is optional.
": "{Integer}",TotalQuantity
Total amount of units
Minimum value: 0
This field is optional.
": "{Integer}",ProductUnits
String list of product units
This field is optional.
": "{String}",Product
This field is optional.
": {ProductId
Product source id
This field is optional.
": "{Integer}"Customer
This field is optional.
": {CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
": "{Integer}"Supplier
This field is optional.
": {SupplierId
RamBase supplier identifier
Minimum value: 100
This field is optional.
": "{Integer}"ProductionResource
This field is optional.
": {ProductionResourceId
Production resource identifier
Minimum value: 100000
This field is optional.
": "{Integer}"SalesOrder
This field is optional.
": {SalesOrderId
Sales order identifier
Minimum value: 100000
This field is optional.
": "{Integer}"Manufacturer
This field is optional.
": {ManufacturerId
Manufacturer identifier
Minimum value: 1000
This field is optional.
": "{Integer}"Material
This field is optional.
": {ProductId
Product source id
This field is optional.
": "{Integer}"ProductionWorkOrder
This field is optional.
": {ProductionWorkOrderId
Production work order identifier
Minimum value: 100000
This field is optional.
": "{Integer}"PurchaseOrder
This field is optional.
": {PurchaseOrderId
Purchase order identifier
Minimum value: 100000
This field is optional.
": "{Integer}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
ExternalCorrespondenceId
External correspondence identifier
>{Integer}</ExternalCorrespondenceId>Status
Status of the external correspondence
Possible domain values can be found here
>{Integer}</Status>Type
Type of external correspondence (CAR/NCR etc)
Possible domain values can be found here
>{Integer}</Type>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Description
Description
>{String}</Description>Cause
String list of causes
>{String}</Cause>SentAt
Date and time when correspondence was sent.
>{Datetime}</SentAt>ClosedAt
Date and time when external correspondence was closed.
>{Datetime}</ClosedAt>Suggested
String list of suggested actions
>{String}</Suggested>Immediate
String list of immediate actions.
>{String}</Immediate>Corrective
String list of corrective actions
>{String}</Corrective>EmployeeId
Employee identifier
>{Integer}</EmployeeId>Name
Last name of employee
>{String}</Name>EmployeeLink
Employee reference
>{String}</EmployeeLink>EmployeeId
Employee identifier
>{Integer}</EmployeeId>Name
Last name of employee
>{String}</Name>EmployeeLink
Employee reference
>{String}</EmployeeLink>AffectedQuantity
Number of affected units
>{Integer}</AffectedQuantity>TotalQuantity
Total amount of units
>{Integer}</TotalQuantity>ProductUnits
String list of product units
>ProductId
Product source id
>{Integer}</ProductId>Description
Description of the product
>{String}</Description>Name
Name of the product
>{String}</Name>ProductClassificationId
Product classification identifier
>{String}</ProductClassificationId>ProductClassificationLink
Product classification reference
>{String}</ProductClassificationLink>ProductLink
Product reference
>{String}</ProductLink>Revision
The Revision of the product
>{String}</Revision>ProductStructureVersionId
Product structure identifier
>{Integer}</ProductStructureVersionId>Drawing
Drawing of the product structure
>Database
Database of the object
>{String}</Database>FileVersionId
File identifier
>{String}</FileVersionId>FileVersionLink
File reference
>{String}</FileVersionLink>ProductStructureId
Product structure identifier
>{Long}</ProductStructureId>ProductStructureVersionLink
Product structure reference
>{String}</ProductStructureVersionLink>CustomerId
Customer identifier
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>CustomerLink
Customer reference
>{String}</CustomerLink>SupplierId
RamBase supplier identifier
>{Integer}</SupplierId>Name
Name of supplier (name of company or surname/familyname/lastname of a person)
>{String}</Name>SupplierLink
Supplier general ledger account is the default account that should be used on incoming invoices for this supplier.
>{String}</SupplierLink>ProductionResourceId
Production resource identifier
>{Integer}</ProductionResourceId>Name
Name of production resource
>{String}</Name>ProductionResourceLink
Production resource reference
>{String}</ProductionResourceLink>SalesOrderId
Sales order identifier
>{Integer}</SalesOrderId>CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
>{String}</CustomersReferenceNumber>SalesOrderLink
Sales order reference
>{String}</SalesOrderLink>ManufacturerId
Manufacturer identifier
>{Integer}</ManufacturerId>Name
Company name of the manufacturer.
>{String}</Name>ManufacturerLink
Manufacturer reference
>{String}</ManufacturerLink>ProductId
Product source id
>{Integer}</ProductId>Description
Description of the product
>{String}</Description>Name
Name of the product
>{String}</Name>ProductClassificationId
Product classification identifier
>{String}</ProductClassificationId>ProductClassificationLink
Product classification reference
>{String}</ProductClassificationLink>ProductLink
Product reference
>{String}</ProductLink>ProductionWorkOrderId
Production work order identifier
>{Integer}</ProductionWorkOrderId>ProductionWorkOrderLink
Production work order reference
>{String}</ProductionWorkOrderLink>PurchaseOrderId
Purchase order identifier
>{Integer}</PurchaseOrderId>PurchaseOrderLink
Purchase order reference
>{String}</PurchaseOrderLink>IsRequired
If true, a response is required
>{Boolean}</IsRequired>ReceivedAt
Date and time when response was received.
>{Datetime}</ReceivedAt>Status
Quality external correspondence response status
Possible domain values can be found here
>{Integer}</Status>IsSigned
If true this response is signed
>{Boolean}</IsSigned>Comment
Description of the response
>{String}</Comment>SuggestedAction
Action on the response
Possible domain values can be found here
>{Integer}</SuggestedAction>ExternalCorrespondenceId
External correspondence identifier
": "{Integer}",Status
Status of the external correspondence
Possible domain values can be found here
": "{Integer}",Type
Type of external correspondence (CAR/NCR etc)
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Description
Description
": "{String}",Cause
String list of causes
": "{String}",SentAt
Date and time when correspondence was sent.
": "{Datetime}",ClosedAt
Date and time when external correspondence was closed.
": "{Datetime}",Suggested
String list of suggested actions
": "{String}",Immediate
String list of immediate actions.
": "{String}",Corrective
String list of corrective actions
": "{String}",EmployeeId
Employee identifier
": "{Integer}",Name
Last name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}",EmployeeId
Employee identifier
": "{Integer}",Name
Last name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}",AffectedQuantity
Number of affected units
": "{Integer}",TotalQuantity
Total amount of units
": "{Integer}",ProductUnits
String list of product units
": {ProductId
Product source id
": "{Integer}",Description
Description of the product
": "{String}",Name
Name of the product
": "{String}",ProductClassificationId
Product classification identifier
": "{String}",ProductClassificationLink
Product classification reference
": "{String}"ProductLink
Product reference
": "{String}",Revision
The Revision of the product
": "{String}",ProductStructureVersionId
Product structure identifier
": "{Integer}",Drawing
Drawing of the product structure
": {Database
Database of the object
": "{String}",FileVersionId
File identifier
": "{String}",FileVersionLink
File reference
": "{String}"ProductStructureId
Product structure identifier
": "{Long}"ProductStructureVersionLink
Product structure reference
": "{String}",CustomerId
Customer identifier
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",CustomerLink
Customer reference
": "{String}",SupplierId
RamBase supplier identifier
": "{Integer}",Name
Name of supplier (name of company or surname/familyname/lastname of a person)
": "{String}",SupplierLink
Supplier general ledger account is the default account that should be used on incoming invoices for this supplier.
": "{String}",ProductionResourceId
Production resource identifier
": "{Integer}",Name
Name of production resource
": "{String}",ProductionResourceLink
Production resource reference
": "{String}",SalesOrderId
Sales order identifier
": "{Integer}",CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
": "{String}",SalesOrderLink
Sales order reference
": "{String}",ManufacturerId
Manufacturer identifier
": "{Integer}",Name
Company name of the manufacturer.
": "{String}",ManufacturerLink
Manufacturer reference
": "{String}",ProductId
Product source id
": "{Integer}",Description
Description of the product
": "{String}",Name
Name of the product
": "{String}",ProductClassificationId
Product classification identifier
": "{String}",ProductClassificationLink
Product classification reference
": "{String}"ProductLink
Product reference
": "{String}",ProductionWorkOrderId
Production work order identifier
": "{Integer}",ProductionWorkOrderLink
Production work order reference
": "{String}",PurchaseOrderId
Purchase order identifier
": "{Integer}",PurchaseOrderLink
Purchase order reference
": "{String}"IsRequired
If true, a response is required
": "{Boolean}",ReceivedAt
Date and time when response was received.
": "{Datetime}",Status
Quality external correspondence response status
Possible domain values can be found here
": "{Integer}",IsSigned
If true this response is signed
": "{Boolean}",Comment
Description of the response
": "{String}",SuggestedAction
Action on the response
Possible domain values can be found here
": "{Integer}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 101015 HTTP 404 | Permission not found |
| Error 101420 HTTP 404 | Setting definition not found |