JiwaAPI

RA_ShipMainQuery

The following routes are available for this service:
GET	/Queries/RA_ShipMain	Retrieves RA_ShipMain Shipment header records

**RA_ShipMainQuery** Parameters:
Name	Parameter	Data Type	Required
RecID	query	string	No
RecIDStartsWith	query	string	No
RecIDEndsWith	query	string	No
RecIDContains	query	string	No
RecIDLike	query	string	No
RecIDBetween	query	string[]	No
RecIDIn	query	string[]	No
ShippingNo	query	string	No
ShippingNoStartsWith	query	string	No
ShippingNoEndsWith	query	string	No
ShippingNoContains	query	string	No
ShippingNoLike	query	string	No
ShippingNoBetween	query	string[]	No
ShippingNoIn	query	string[]	No
RANumber	query	string	No
RANumberStartsWith	query	string	No
RANumberEndsWith	query	string	No
RANumberContains	query	string	No
RANumberLike	query	string	No
RANumberBetween	query	string[]	No
RANumberIn	query	string[]	No
Reference	query	string	No
ReferenceStartsWith	query	string	No
ReferenceEndsWith	query	string	No
ReferenceContains	query	string	No
ReferenceLike	query	string	No
ReferenceBetween	query	string[]	No
ReferenceIn	query	string[]	No
WarehouseID	query	string	No
WarehouseIDStartsWith	query	string	No
WarehouseIDEndsWith	query	string	No
WarehouseIDContains	query	string	No
WarehouseIDLike	query	string	No
WarehouseIDBetween	query	string[]	No
WarehouseIDIn	query	string[]	No
Status	query	byte?	No
StatusGreaterThanOrEqualTo	query	byte?	No
StatusGreaterThan	query	byte?	No
StatusLessThan	query	byte?	No
StatusLessThanOrEqualTo	query	byte?	No
StatusNotEqualTo	query	byte?	No
StatusBetween	query	byte[]	No
StatusIn	query	byte[]	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	DateTime[]	No
LastSavedDateTimeIn	query	DateTime[]	No
CreatedBy	query	string	No
CreatedByStartsWith	query	string	No
CreatedByEndsWith	query	string	No
CreatedByContains	query	string	No
CreatedByLike	query	string	No
CreatedByBetween	query	string[]	No
CreatedByIn	query	string[]	No
ReturnCode	query	string	No
ReturnCodeStartsWith	query	string	No
ReturnCodeEndsWith	query	string	No
ReturnCodeContains	query	string	No
ReturnCodeLike	query	string	No
ReturnCodeBetween	query	string[]	No
ReturnCodeIn	query	string[]	No
DeliveryStreetAddress1	query	string	No
DeliveryStreetAddress1StartsWith	query	string	No
DeliveryStreetAddress1EndsWith	query	string	No
DeliveryStreetAddress1Contains	query	string	No
DeliveryStreetAddress1Like	query	string	No
DeliveryStreetAddress1Between	query	string[]	No
DeliveryStreetAddress1In	query	string[]	No
DeliveryStreetAddress2	query	string	No
DeliveryStreetAddress2StartsWith	query	string	No
DeliveryStreetAddress2EndsWith	query	string	No
DeliveryStreetAddress2Contains	query	string	No
DeliveryStreetAddress2Like	query	string	No
DeliveryStreetAddress2Between	query	string[]	No
DeliveryStreetAddress2In	query	string[]	No
DeliveryLocality	query	string	No
DeliveryLocalityStartsWith	query	string	No
DeliveryLocalityEndsWith	query	string	No
DeliveryLocalityContains	query	string	No
DeliveryLocalityLike	query	string	No
DeliveryLocalityBetween	query	string[]	No
DeliveryLocalityIn	query	string[]	No
DeliveryRegion	query	string	No
DeliveryRegionStartsWith	query	string	No
DeliveryRegionEndsWith	query	string	No
DeliveryRegionContains	query	string	No
DeliveryRegionLike	query	string	No
DeliveryRegionBetween	query	string[]	No
DeliveryRegionIn	query	string[]	No
DeliveryPostCode	query	string	No
DeliveryPostCodeStartsWith	query	string	No
DeliveryPostCodeEndsWith	query	string	No
DeliveryPostCodeContains	query	string	No
DeliveryPostCodeLike	query	string	No
DeliveryPostCodeBetween	query	string[]	No
DeliveryPostCodeIn	query	string[]	No
ContactName	query	string	No
ContactNameStartsWith	query	string	No
ContactNameEndsWith	query	string	No
ContactNameContains	query	string	No
ContactNameLike	query	string	No
ContactNameBetween	query	string[]	No
ContactNameIn	query	string[]	No
Note	query	string	No
NoteStartsWith	query	string	No
NoteEndsWith	query	string	No
NoteContains	query	string	No
NoteLike	query	string	No
NoteBetween	query	string[]	No
NoteIn	query	string[]	No
CourierDetails	query	string	No
CourierDetailsStartsWith	query	string	No
CourierDetailsEndsWith	query	string	No
CourierDetailsContains	query	string	No
CourierDetailsLike	query	string	No
CourierDetailsBetween	query	string[]	No
CourierDetailsIn	query	string[]	No
ShippingDate	query	DateTime?	No
ShippingDateGreaterThanOrEqualTo	query	DateTime?	No
ShippingDateGreaterThan	query	DateTime?	No
ShippingDateLessThan	query	DateTime?	No
ShippingDateLessThanOrEqualTo	query	DateTime?	No
ShippingDateNotEqualTo	query	DateTime?	No
ShippingDateBetween	query	DateTime[]	No
ShippingDateIn	query	DateTime[]	No
CreditorID	query	string	No
CreditorIDStartsWith	query	string	No
CreditorIDEndsWith	query	string	No
CreditorIDContains	query	string	No
CreditorIDLike	query	string	No
CreditorIDBetween	query	string[]	No
CreditorIDIn	query	string[]	No
TransitWarehouseID	query	string	No
TransitWarehouseIDStartsWith	query	string	No
TransitWarehouseIDEndsWith	query	string	No
TransitWarehouseIDContains	query	string	No
TransitWarehouseIDLike	query	string	No
TransitWarehouseIDBetween	query	string[]	No
TransitWarehouseIDIn	query	string[]	No
RowHash	query	byte[]	No
DeliveryAddressee	query	string	No
DeliveryAddresseeStartsWith	query	string	No
DeliveryAddresseeEndsWith	query	string	No
DeliveryAddresseeContains	query	string	No
DeliveryAddresseeLike	query	string	No
DeliveryAddresseeBetween	query	string[]	No
DeliveryAddresseeIn	query	string[]	No
DeliveryCountry	query	string	No
DeliveryCountryStartsWith	query	string	No
DeliveryCountryEndsWith	query	string	No
DeliveryCountryContains	query	string	No
DeliveryCountryLike	query	string	No
DeliveryCountryBetween	query	string[]	No
DeliveryCountryIn	query	string[]	No
DeliveryTelephone	query	string	No
DeliveryTelephoneStartsWith	query	string	No
DeliveryTelephoneEndsWith	query	string	No
DeliveryTelephoneContains	query	string	No
DeliveryTelephoneLike	query	string	No
DeliveryTelephoneBetween	query	string[]	No
DeliveryTelephoneIn	query	string[]	No
DeliveryFacsimile	query	string	No
DeliveryFacsimileStartsWith	query	string	No
DeliveryFacsimileEndsWith	query	string	No
DeliveryFacsimileContains	query	string	No
DeliveryFacsimileLike	query	string	No
DeliveryFacsimileBetween	query	string[]	No
DeliveryFacsimileIn	query	string[]	No

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
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

**RA_ShipMain** Parameters:
Name	Parameter	Data Type	Required
RecID	form	string	No
ShippingNo	form	string	No
RANumber	form	string	No
Reference	form	string	No
WarehouseID	form	string	No
Status	form	byte	No
LastSavedDateTime	form	DateTime	No
CreatedBy	form	string	No
ReturnCode	form	string	No
DeliveryStreetAddress1	form	string	No
DeliveryStreetAddress2	form	string	No
DeliveryLocality	form	string	No
DeliveryRegion	form	string	No
DeliveryPostCode	form	string	No
ContactName	form	string	No
Note	form	string	No
CourierDetails	form	string	No
ShippingDate	form	DateTime	No
CreditorID	form	string	No
TransitWarehouseID	form	string	No
RowHash	form	byte[]	No
DeliveryAddressee	form	string	No
DeliveryCountry	form	string	No
DeliveryTelephone	form	string	No
DeliveryFacsimile	form	string	No

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
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

HTTP + XML

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

GET /Queries/RA_ShipMain HTTP/1.1 
Host: apitrain.galipo.com.au 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfRA_ShipMain7kRqkrSv 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:RA_ShipMain>
      <d2p1:_x003C_ContactName_x003E_k__BackingField>String</d2p1:_x003C_ContactName_x003E_k__BackingField>
      <d2p1:_x003C_CourierDetails_x003E_k__BackingField>String</d2p1:_x003C_CourierDetails_x003E_k__BackingField>
      <d2p1:_x003C_CreatedBy_x003E_k__BackingField>String</d2p1:_x003C_CreatedBy_x003E_k__BackingField>
      <d2p1:_x003C_CreditorID_x003E_k__BackingField>String</d2p1:_x003C_CreditorID_x003E_k__BackingField>
      <d2p1:_x003C_DeliveryAddressee_x003E_k__BackingField>String</d2p1:_x003C_DeliveryAddressee_x003E_k__BackingField>
      <d2p1:_x003C_DeliveryCountry_x003E_k__BackingField>String</d2p1:_x003C_DeliveryCountry_x003E_k__BackingField>
      <d2p1:_x003C_DeliveryFacsimile_x003E_k__BackingField>String</d2p1:_x003C_DeliveryFacsimile_x003E_k__BackingField>
      <d2p1:_x003C_DeliveryLocality_x003E_k__BackingField>String</d2p1:_x003C_DeliveryLocality_x003E_k__BackingField>
      <d2p1:_x003C_DeliveryPostCode_x003E_k__BackingField>String</d2p1:_x003C_DeliveryPostCode_x003E_k__BackingField>
      <d2p1:_x003C_DeliveryRegion_x003E_k__BackingField>String</d2p1:_x003C_DeliveryRegion_x003E_k__BackingField>
      <d2p1:_x003C_DeliveryStreetAddress1_x003E_k__BackingField>String</d2p1:_x003C_DeliveryStreetAddress1_x003E_k__BackingField>
      <d2p1:_x003C_DeliveryStreetAddress2_x003E_k__BackingField>String</d2p1:_x003C_DeliveryStreetAddress2_x003E_k__BackingField>
      <d2p1:_x003C_DeliveryTelephone_x003E_k__BackingField>String</d2p1:_x003C_DeliveryTelephone_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_Note_x003E_k__BackingField>String</d2p1:_x003C_Note_x003E_k__BackingField>
      <d2p1:_x003C_RANumber_x003E_k__BackingField>String</d2p1:_x003C_RANumber_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField>
      <d2p1:_x003C_Reference_x003E_k__BackingField>String</d2p1:_x003C_Reference_x003E_k__BackingField>
      <d2p1:_x003C_ReturnCode_x003E_k__BackingField>String</d2p1:_x003C_ReturnCode_x003E_k__BackingField>
      <d2p1:_x003C_RowHash_x003E_k__BackingField>AA==</d2p1:_x003C_RowHash_x003E_k__BackingField>
      <d2p1:_x003C_ShippingDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_ShippingDate_x003E_k__BackingField>
      <d2p1:_x003C_ShippingNo_x003E_k__BackingField>String</d2p1:_x003C_ShippingNo_x003E_k__BackingField>
      <d2p1:_x003C_Status_x003E_k__BackingField>0</d2p1:_x003C_Status_x003E_k__BackingField>
      <d2p1:_x003C_TransitWarehouseID_x003E_k__BackingField>String</d2p1:_x003C_TransitWarehouseID_x003E_k__BackingField>
      <d2p1:_x003C_WarehouseID_x003E_k__BackingField>String</d2p1:_x003C_WarehouseID_x003E_k__BackingField>
    </d2p1:RA_ShipMain>
  </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>
</QueryResponseOfRA_ShipMain7kRqkrSv>