JiwaAPI

<back to all web services

V_SHBookinShipmentsQuery

Requires Authentication
V_SHBookinShipmentsQuery Parameters:
NameParameterData TypeRequiredDescription
ShipmentIDquerystringNo
ShipmentIDStartsWithquerystringNo
ShipmentIDEndsWithquerystringNo
ShipmentIDContainsquerystringNo
ShipmentIDLikequerystringNo
ShipmentIDBetweenquerystring[]No
ShipmentIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
V_SHBookinShipments Parameters:
NameParameterData TypeRequiredDescription
ShipmentIDformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/V_SHBookinShipmentsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ShipmentID":"String","ShipmentIDStartsWith":"String","ShipmentIDEndsWith":"String","ShipmentIDContains":"String","ShipmentIDLike":"String","ShipmentIDBetween":["String"],"ShipmentIDIn":["String"],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"ShipmentID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}