JiwaAPI

<back to all web services

SH_BookInMainQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/SH_BookInMainRetrieves a list of shipment book ins.
SH_BookInMainQuery Parameters:
NameParameterData TypeRequiredDescription
BookInIDquerystringNo
BookInIDStartsWithquerystringNo
BookInIDEndsWithquerystringNo
BookInIDContainsquerystringNo
BookInIDLikequerystringNo
BookInIDBetweenquerystring[]No
BookInIDInquerystring[]No
BookInNoquerystringNo
BookInNoStartsWithquerystringNo
BookInNoEndsWithquerystringNo
BookInNoContainsquerystringNo
BookInNoLikequerystringNo
BookInNoBetweenquerystring[]No
BookInNoInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
ShipmentIDquerystringNo
ShipmentIDStartsWithquerystringNo
ShipmentIDEndsWithquerystringNo
ShipmentIDContainsquerystringNo
ShipmentIDLikequerystringNo
ShipmentIDBetweenquerystring[]No
ShipmentIDInquerystring[]No
BookInDatequeryDateTime?No
BookInDateGreaterThanOrEqualToqueryDateTime?No
BookInDateGreaterThanqueryDateTime?No
BookInDateLessThanqueryDateTime?No
BookInDateLessThanOrEqualToqueryDateTime?No
BookInDateNotEqualToqueryDateTime?No
BookInDateBetweenqueryNullable<DateTime>[]No
BookInDateInqueryNullable<DateTime>[]No
Statusquerybool?No
IN_LogicalIDquerystringNo
IN_LogicalIDStartsWithquerystringNo
IN_LogicalIDEndsWithquerystringNo
IN_LogicalIDContainsquerystringNo
IN_LogicalIDLikequerystringNo
IN_LogicalIDBetweenquerystring[]No
IN_LogicalIDInquerystring[]No
SETIDquerystringNo
SETIDStartsWithquerystringNo
SETIDEndsWithquerystringNo
SETIDContainsquerystringNo
SETIDLikequerystringNo
SETIDBetweenquerystring[]No
SETIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SH_BookInMain Parameters:
NameParameterData TypeRequiredDescription
BookInIDformstringNo
BookInNoformstringNo
LastSavedDateTimeformDateTime?No
ShipmentIDformstringNo
BookInDateformDateTime?No
StatusformboolNo
IN_LogicalIDformstringNo
SETIDformstringNo
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.

GET /Queries/SH_BookInMain HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"BookInID":"String","BookInNo":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","ShipmentID":"String","BookInDate":"0001-01-01T00:00:00.0000000","IN_LogicalID":"String","SETID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}