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 .xml suffix or ?format=xml

HTTP + 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>