Resource URL Summary
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Retrieve the details of a specific Inventory Load
Create a new Inventory Load
Insert the details of a specific Inventory Load for a specific Load Number
Delete a specific Inventory Load
|
API Specific Parameters
Parameter | Description |
---|---|
| Identifies the REST Object Definitions Inventory Related Objects Inventory Load Object. |
Supported HTTP Methods
Method | Description | ||||||
---|---|---|---|---|---|---|---|
PUT | Creates a new Inventory Load object identified by the ${LoadNum} URL parameter. | ||||||
POST
| Creates a new Inventory Load object. Server will auto generate ${LoadNum} and will return it in HTTP response. |
Include Page | ||||
---|---|---|---|---|
|
API Specifics
Panel | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Retrieve the details of a specific Inventory LoadThis REST API will return an Inventory Load with the specified ID. The Inventory Load with the specified ID must already exist in the system. URL
HTTP Request BodyThis request does not require a request body. HTTP Response BodyOn success, an HTTP response code of 200 will be returned, and the response body will contain an REST Object Definitions Inventory Related Objects Inventory Load Object. Otherwise, on error, the response body will contain a descriptive reason for the error.
|
Panel | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
Create a new Inventory LoadThis REST API will insert a new Inventory Load, returning the ID for the created object. Once created, the Inventory Load object can no longer be updated by the backend system. URL
HTTP Request BodyThe HTTP request body must contain a valid REST Object Definitions Inventory Related Objects Inventory Load Object. HTTP ResponseOn success, an HTTP response code of 201 will be returned, and:
|
Panel | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
Insert the details of a specific Inventory Load for a specific Load NumberThis REST API will insert a new Inventory Load with the specified ID into the system, if a Inventory Load with the specified ID does not already exist in the system. Once created, the Inventory Load object can no longer be updated by the backend system. URL
HTTP Request BodyThe HTTP request body must contain a valid REST Object Definitions Inventory Related Objects Inventory Load Object. HTTP ResponseOn success the API will return a response code of 200. |
Panel | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
Delete a specific Inventory LoadThis REST API will delete an Inventory Load with the specified ID from the system. The Inventory Load with the specified ID must already exist in the system. URL
HTTP Request BodyThis request does not require a request body. HTTP ResponseOn success an HTTP response code of 200 will be returned. The system will return HTTP response code 410 in case of non-existent REST Object Definitions Inventory Related Objects Inventory Load Object. |