REL documentation
Resource:Collection: of customerbolmessageC# Rel Const:Rels.CustomerSvc.CustomerBolMessagesURI template:{id}/bolmessagesObtain URI from:
Get the list of bill-of-lading messages for a given customer
Success status: 200
| Name (* = required) | Data Type | Description |
|---|---|---|
| id * | int | customer id |
| Type | Description | |
|---|---|---|
| ResourceList | IList<Customer.Models.CustomerBolMessage> | |
| 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 | ||
| Links | IList<WebApi.Hal.Link> | |
| - /rels/customers/customer |
Sample accept: application/hal+json
{
"_embedded": {
"http://api.3plCentral.com/rels/customers/customerbolmessage": [
{
"messageNum": 1,
"message": "str"
}
]
}
}
Add a new bill-of-lading message for a given customer
Success status: 200; ETag response header supplied
| Name (* = required) | Data Type | Description |
|---|---|---|
| id * | int | customer id |
text to be inserted into a bill-of-lading
| 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"
}
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.