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 .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfSH_BookInMain7kRqkrSv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <Offset>0</Offset> <Total>0</Total> <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables"> <d2p1:SH_BookInMain> <d2p1:_x003C_BookInDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_BookInDate_x003E_k__BackingField> <d2p1:_x003C_BookInID_x003E_k__BackingField>String</d2p1:_x003C_BookInID_x003E_k__BackingField> <d2p1:_x003C_BookInNo_x003E_k__BackingField>String</d2p1:_x003C_BookInNo_x003E_k__BackingField> <d2p1:_x003C_IN_LogicalID_x003E_k__BackingField>String</d2p1:_x003C_IN_LogicalID_x003E_k__BackingField> <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField> <d2p1:_x003C_SETID_x003E_k__BackingField>String</d2p1:_x003C_SETID_x003E_k__BackingField> <d2p1:_x003C_ShipmentID_x003E_k__BackingField>String</d2p1:_x003C_ShipmentID_x003E_k__BackingField> <d2p1:_x003C_Status_x003E_k__BackingField>false</d2p1:_x003C_Status_x003E_k__BackingField> </d2p1:SH_BookInMain> </Results> <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </Meta> <ResponseStatus> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </Meta> </ResponseError> </Errors> <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </Meta> </ResponseStatus> </QueryResponseOfSH_BookInMain7kRqkrSv>