API

Production APIs

GET production/work-orders/{productionWorkOrderId}/material-deliveries

Gets material devlivery statistics fof given production work order

HTTP method GET
URI https://api.rambase.net/production/work-orders/{productionWorkOrderId}/material-deliveries
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {productionWorkOrderId} Production work order identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 4638, version 2

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
1

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.

$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select 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
<MaterialDeliveries>
2
     <Materials>
3
          <PendingPurchase
PendingPurchase

Number of units waiting to be purchased from supplier

>{Integer}</PendingPurchase>
4
          <Unconfirmed
Unconfirmed

Number of units whithout confirmed delivery date

>{Integer}</Unconfirmed>
5
          <Confirmed
Confirmed

Number of units with confirmed delivery date

>{Integer}</Confirmed>
6
          <Stock
Stock

Number of units on stock

>{Integer}</Stock>
7
          <Total
Total

Total number of units

>{Integer}</Total>
8
     </Materials>
9
     <OutsourcedOperations>
10
          <PendingPurchase
PendingPurchase

Number of external operations pending purchase

>{Integer}</PendingPurchase>
11
          <Unconfirmed
Unconfirmed

Number of external operations without confirmed delivery date

>{Integer}</Unconfirmed>
12
          <Confirmed
Confirmed

Number of external operations with confirmed delivery date

>{Integer}</Confirmed>
13
          <Stock
Stock

Number of external operations on stock

>{Integer}</Stock>
14
          <Total
Total

Total number of units

>{Integer}</Total>
15
     </OutsourcedOperations>
16
     <ConfirmedDeliveryDate>
17
          <Latest
Latest

Latest material confirmation date

>{Date}</Latest>
18
          <Earliest
Earliest

Latest material confirmation date

>{Date}</Earliest>
19
     </ConfirmedDeliveryDate>
20
</MaterialDeliveries>
1
{
2
     "materialDeliveries": {
3
          "materials": {
4
               "pendingPurchase
PendingPurchase

Number of units waiting to be purchased from supplier

": "{Integer}",
5
               "unconfirmed
Unconfirmed

Number of units whithout confirmed delivery date

": "{Integer}",
6
               "confirmed
Confirmed

Number of units with confirmed delivery date

": "{Integer}",
7
               "stock
Stock

Number of units on stock

": "{Integer}",
8
               "total
Total

Total number of units

": "{Integer}"
9
          },
10
          "outsourcedOperations": {
11
               "pendingPurchase
PendingPurchase

Number of external operations pending purchase

": "{Integer}",
12
               "unconfirmed
Unconfirmed

Number of external operations without confirmed delivery date

": "{Integer}",
13
               "confirmed
Confirmed

Number of external operations with confirmed delivery date

": "{Integer}",
14
               "stock
Stock

Number of external operations on stock

": "{Integer}",
15
               "total
Total

Total number of units

": "{Integer}"
16
          },
17
          "confirmedDeliveryDate": {
18
               "latest
Latest

Latest material confirmation date

": "{Date}",
19
               "earliest
Earliest

Latest material confirmation date

": "{Date}"
20
          }
21
     }
22
}

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 101231 HTTP 404 Production work order item not found