API

Quality management APIs

PUT quality/issues/{qualityIssueId}/external-correspondences/{externalCorrespondenceId}

Updates an external correspondence

HTTP method PUT
URI https://api.rambase.net/quality/issues/{qualityIssueId}/external-correspondences/{externalCorrespondenceId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {qualityIssueId} Quality issue identifier
Integer, minimum 100000
- URI parameter {externalCorrespondenceId} External correspondence identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 4877, version 8

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.

Format:
1
<ExternalCorrespondence
ExternalCorrespondence

This field is optional.

>
2
     <Description
Description

Description

This field is optional.

>{String}</Description>
3
     <Cause
Cause

String list of causes

This field is optional.

>{String}</Cause>
4
     <Actions
Actions

This field is optional.

>
5
          <Suggested
Suggested

String list of suggested actions

This field is optional.

>{String}</Suggested>
6
          <Immediate
Immediate

String list of immediate actions.

This field is optional.

>{String}</Immediate>
7
          <Corrective
Corrective

String list of corrective actions

This field is optional.

>{String}</Corrective>
8
     </Actions>
9
     <Responsible
Responsible

This field is optional.

>
10
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>{Integer}</EmployeeId>
11
     </Responsible>
12
     <Context
Context

This field is optional.

>
13
          <AffectedQuantity
AffectedQuantity

Number of affected units

Minimum value: 0

This field is optional.

>{Integer}</AffectedQuantity>
14
          <TotalQuantity
TotalQuantity

Total amount of units

Minimum value: 0

This field is optional.

>{Integer}</TotalQuantity>
15
          <ProductUnits
ProductUnits

String list of product units

This field is optional.

>{String}</ProductUnits>
16
          <Product
Product

This field is optional.

>
17
               <ProductId
ProductId

Product source id

This field is optional.

>{Integer}</ProductId>
18
          </Product>
19
          <Customer
Customer

This field is optional.

>
20
               <CustomerId
CustomerId

Customer identifier

Minimum value: 10000

This field is optional.

>{Integer}</CustomerId>
21
          </Customer>
22
          <Supplier
Supplier

This field is optional.

>
23
               <SupplierId
SupplierId

RamBase supplier identifier

Minimum value: 100

This field is optional.

>{Integer}</SupplierId>
24
          </Supplier>
25
          <ProductionResource
ProductionResource

This field is optional.

>
26
               <ProductionResourceId
ProductionResourceId

Production resource identifier

Minimum value: 100000

This field is optional.

>{Integer}</ProductionResourceId>
27
          </ProductionResource>
28
          <SalesOrder
SalesOrder

This field is optional.

>
29
               <SalesOrderId
SalesOrderId

Sales order identifier

Minimum value: 100000

This field is optional.

>{Integer}</SalesOrderId>
30
          </SalesOrder>
31
          <Manufacturer
Manufacturer

This field is optional.

>
32
               <ManufacturerId
ManufacturerId

Manufacturer identifier

Minimum value: 1000

This field is optional.

>{Integer}</ManufacturerId>
33
          </Manufacturer>
34
          <Material
Material

This field is optional.

>
35
               <ProductId
ProductId

Product source id

This field is optional.

>{Integer}</ProductId>
36
          </Material>
37
          <ProductionWorkOrder
ProductionWorkOrder

This field is optional.

>
38
               <ProductionWorkOrderId
ProductionWorkOrderId

Production work order identifier

Minimum value: 100000

This field is optional.

>{Integer}</ProductionWorkOrderId>
39
          </ProductionWorkOrder>
40
          <PurchaseOrder
PurchaseOrder

This field is optional.

>
41
               <PurchaseOrderId
PurchaseOrderId

Purchase order identifier

Minimum value: 100000

This field is optional.

>{Integer}</PurchaseOrderId>
42
          </PurchaseOrder>
43
     </Context>
44
     <Response
Response

This field is optional.

>
45
          <Comment
Comment

Description of the response

This field is optional.

>{String}</Comment>
46
          <SuggestedAction
SuggestedAction

Action on the response

Applicable domain values can be found here

This field is optional.

>{Integer}</SuggestedAction>
47
     </Response>
48
</ExternalCorrespondence>
1
{
2
     "externalCorrespondence
ExternalCorrespondence

This field is optional.

": {
3
          "description
Description

Description

This field is optional.

": "{String}",
4
          "cause
Cause

String list of causes

This field is optional.

": "{String}",
5
          "actions
Actions

This field is optional.

": {
6
               "suggested
Suggested

String list of suggested actions

This field is optional.

": "{String}",
7
               "immediate
Immediate

String list of immediate actions.

This field is optional.

": "{String}",
8
               "corrective
Corrective

String list of corrective actions

This field is optional.

": "{String}"
9
          },
10
          "responsible
Responsible

This field is optional.

": {
11
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

": "{Integer}"
12
          },
13
          "context
Context

This field is optional.

": {
14
               "affectedQuantity
AffectedQuantity

Number of affected units

Minimum value: 0

This field is optional.

": "{Integer}",
15
               "totalQuantity
TotalQuantity

Total amount of units

Minimum value: 0

This field is optional.

": "{Integer}",
16
               "productUnits
ProductUnits

String list of product units

This field is optional.

": "{String}",
17
               "product
Product

This field is optional.

": {
18
                    "productId
ProductId

Product source id

This field is optional.

": "{Integer}"
19
               },
20
               "customer
Customer

This field is optional.

": {
21
                    "customerId
CustomerId

Customer identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
22
               },
23
               "supplier
Supplier

This field is optional.

": {
24
                    "supplierId
SupplierId

RamBase supplier identifier

Minimum value: 100

This field is optional.

": "{Integer}"
25
               },
26
               "productionResource
ProductionResource

This field is optional.

": {
27
                    "productionResourceId
ProductionResourceId

Production resource identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
28
               },
29
               "salesOrder
SalesOrder

This field is optional.

": {
30
                    "salesOrderId
SalesOrderId

Sales order identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
31
               },
32
               "manufacturer
Manufacturer

This field is optional.

": {
33
                    "manufacturerId
ManufacturerId

Manufacturer identifier

Minimum value: 1000

This field is optional.

": "{Integer}"
34
               },
35
               "material
Material

This field is optional.

": {
36
                    "productId
ProductId

Product source id

This field is optional.

": "{Integer}"
37
               },
38
               "productionWorkOrder
ProductionWorkOrder

This field is optional.

": {
39
                    "productionWorkOrderId
ProductionWorkOrderId

Production work order identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
40
               },
41
               "purchaseOrder
PurchaseOrder

This field is optional.

": {
42
                    "purchaseOrderId
PurchaseOrderId

Purchase order identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
43
               }
44
          },
45
          "response
Response

This field is optional.

": {
46
               "comment
Comment

Description of the response

This field is optional.

": "{String}",
47
               "suggestedAction
SuggestedAction

Action on the response

Applicable domain values can be found here

This field is optional.

": "{Integer}"
48
          }
49
     }
50
}

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.

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. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

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