REL documentation
Resource:bill of lading templates for given customerC# Rel Const:Rels.CustomerSvc.CustomerBolMessageURI template:{id}/bolmessages/{messagenum}Obtain URI from:
Get a single bill-of-lading message for a given customer
Success status: 200; ETag response header supplied
| Name (* = required) | Data Type | Description |
|---|---|---|
| id * | int | customer id |
| Type | Description | |
|---|---|---|
| Links | IList<WebApi.Hal.Link> | |
| - edit | If Link.Name contains 'Disallow: ' with DELETE in the list, then customerbolmessage cannot be deleted because it is in use. | |
| - /rels/customers/customer |
Sample accept: application/hal+json
{
"messageNum": 1,
"message": "str"
}
Update a bill-of-lading message for a given customer
If-Match request header required; Success status: 200; ETag response header supplied
| Name (* = required) | Data Type | Description |
|---|---|---|
| id * | int | customer id |
| Type | Description |
|---|
Sample content-type: application/hal+json |
{
"messageNum": 1,
"message": "str"
}
| Type | Description | |
|---|---|---|
| Links | IList<WebApi.Hal.Link> | |
| - edit | If Link.Name contains 'Disallow: ' with DELETE in the list, then customerbolmessage cannot be deleted because it is in use. | |
| - /rels/customers/customer |
Sample accept: application/hal+json
{
"messageNum": 1,
"message": "str"
}
Remove a bill-of-lading message for a given customer
If-Match request header required; Success status: 204
| Name (* = required) | Data Type | Description |
|---|---|---|
| id * | int | customer id |
This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.