JiwaAPI

<back to all web services

CarrierGETRequest

Requires Authentication
The following routes are available for this service:
GET/Carriers/{CarrierID}Retrieves a carrier.
CarrierGETRequest Parameters:
NameParameterData TypeRequiredDescription
CarrierIDpathstringNo
Carrier Parameters:
NameParameterData TypeRequiredDescription
CarrierIDformstringNo
CarrierNameformstringNo
AccountNoformstringNo
Enabledformbool?No
NotesformstringNo
LastSavedDateTimeformDateTime?No
ServicesformList<CarrierService>No
FreightDescriptionsformList<CarrierFreightDescription>No
CarrierService Parameters:
NameParameterData TypeRequiredDescription
ServiceIDformstringNo
ServiceNameformstringNo
DefaultItemformbool?No
LastSavedDateTimeformDateTime?No
Enabledformbool?No
CarrierFreightDescription Parameters:
NameParameterData TypeRequiredDescription
FreightDescriptionIDformstringNo
DescriptionformstringNo
DefaultItemformbool?No
LastSavedDateTimeformDateTime?No
Enabledformbool?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + 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}]}