JiwaAPI

<back to all web services

CarrierFreightDescriptionPOSTRequest

Requires Authentication
The following routes are available for this service:
POST/Carriers/{CarrierID}/FreightDescriptionsAppends a freight description to a carrier.
CarrierFreightDescriptionPOSTRequest Parameters:
NameParameterData TypeRequiredDescription
CarrierIDpathstringNo
CarrierFreightDescription Parameters:
NameParameterData TypeRequiredDescription
FreightDescriptionIDformstringNo
DescriptionformstringNo
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.

POST /Carriers/{CarrierID}/FreightDescriptions HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CarrierID":"String","Description":"String","DefaultItem":false,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","Enabled":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"FreightDescriptionID":"String","Description":"String","DefaultItem":false,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","Enabled":false}