GET | /Queries/SH_BookInMain | Retrieves a list of shipment book ins. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BookInID | query | string | No | |
BookInIDStartsWith | query | string | No | |
BookInIDEndsWith | query | string | No | |
BookInIDContains | query | string | No | |
BookInIDLike | query | string | No | |
BookInIDBetween | query | string[] | No | |
BookInIDIn | query | string[] | No | |
BookInNo | query | string | No | |
BookInNoStartsWith | query | string | No | |
BookInNoEndsWith | query | string | No | |
BookInNoContains | query | string | No | |
BookInNoLike | query | string | No | |
BookInNoBetween | query | string[] | No | |
BookInNoIn | query | string[] | No | |
LastSavedDateTime | query | DateTime? | No | |
LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeGreaterThan | query | DateTime? | No | |
LastSavedDateTimeLessThan | query | DateTime? | No | |
LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
LastSavedDateTimeBetween | query | Nullable<DateTime>[] | No | |
LastSavedDateTimeIn | query | Nullable<DateTime>[] | No | |
ShipmentID | query | string | No | |
ShipmentIDStartsWith | query | string | No | |
ShipmentIDEndsWith | query | string | No | |
ShipmentIDContains | query | string | No | |
ShipmentIDLike | query | string | No | |
ShipmentIDBetween | query | string[] | No | |
ShipmentIDIn | query | string[] | No | |
BookInDate | query | DateTime? | No | |
BookInDateGreaterThanOrEqualTo | query | DateTime? | No | |
BookInDateGreaterThan | query | DateTime? | No | |
BookInDateLessThan | query | DateTime? | No | |
BookInDateLessThanOrEqualTo | query | DateTime? | No | |
BookInDateNotEqualTo | query | DateTime? | No | |
BookInDateBetween | query | Nullable<DateTime>[] | No | |
BookInDateIn | query | Nullable<DateTime>[] | No | |
Status | query | bool? | No | |
IN_LogicalID | query | string | No | |
IN_LogicalIDStartsWith | query | string | No | |
IN_LogicalIDEndsWith | query | string | No | |
IN_LogicalIDContains | query | string | No | |
IN_LogicalIDLike | query | string | No | |
IN_LogicalIDBetween | query | string[] | No | |
IN_LogicalIDIn | query | string[] | No | |
SETID | query | string | No | |
SETIDStartsWith | query | string | No | |
SETIDEndsWith | query | string | No | |
SETIDContains | query | string | No | |
SETIDLike | query | string | No | |
SETIDBetween | query | string[] | No | |
SETIDIn | query | string[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BookInID | form | string | No | |
BookInNo | form | string | No | |
LastSavedDateTime | form | DateTime? | No | |
ShipmentID | form | string | No | |
BookInDate | form | DateTime? | No | |
Status | form | bool | No | |
IN_LogicalID | form | string | No | |
SETID | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | 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 /Queries/SH_BookInMain HTTP/1.1 Host: api.jiwa.com.au Accept: text/csv
HTTP/1.1 200 OK Content-Type: text/csv 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"}}}