GET | /Carriers/{CarrierID} | Retrieves a carrier. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CarrierID | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CarrierID | form | string | No | |
CarrierName | form | string | No | |
AccountNo | form | string | No | |
Enabled | form | bool? | No | |
Notes | form | string | No | |
LastSavedDateTime | form | DateTime? | No | |
Services | form | List<CarrierService> | No | |
FreightDescriptions | form | List<CarrierFreightDescription> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ServiceID | form | string | No | |
ServiceName | form | string | No | |
DefaultItem | form | bool? | No | |
LastSavedDateTime | form | DateTime? | No | |
Enabled | form | bool? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FreightDescriptionID | form | string | No | |
Description | form | string | No | |
DefaultItem | form | bool? | No | |
LastSavedDateTime | form | DateTime? | No | |
Enabled | form | bool? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Carriers/{CarrierID} HTTP/1.1 Host: api.jiwa.com.au Accept: text/csv
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"CarrierID":"String","CarrierName":"String","AccountNo":"String","Enabled":false,"Notes":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","Services":[{"ServiceID":"String","ServiceName":"String","DefaultItem":false,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","Enabled":false}],"FreightDescriptions":[{"FreightDescriptionID":"String","Description":"String","DefaultItem":false,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","Enabled":false}]}