JiwaAPI

<back to all web services

PO_ShippingAddressQuery

Requires Authentication
PO_ShippingAddressQuery Parameters:
NameParameterData TypeRequiredDescription
OrderIDquerystringNo
OrderIDStartsWithquerystringNo
OrderIDEndsWithquerystringNo
OrderIDContainsquerystringNo
OrderIDLikequerystringNo
OrderIDBetweenquerystring[]No
OrderIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
AddressLine1querystringNo
AddressLine1StartsWithquerystringNo
AddressLine1EndsWithquerystringNo
AddressLine1ContainsquerystringNo
AddressLine1LikequerystringNo
AddressLine1Betweenquerystring[]No
AddressLine1Inquerystring[]No
AddressLine2querystringNo
AddressLine2StartsWithquerystringNo
AddressLine2EndsWithquerystringNo
AddressLine2ContainsquerystringNo
AddressLine2LikequerystringNo
AddressLine2Betweenquerystring[]No
AddressLine2Inquerystring[]No
AddressLine3querystringNo
AddressLine3StartsWithquerystringNo
AddressLine3EndsWithquerystringNo
AddressLine3ContainsquerystringNo
AddressLine3LikequerystringNo
AddressLine3Betweenquerystring[]No
AddressLine3Inquerystring[]No
AddressLine4querystringNo
AddressLine4StartsWithquerystringNo
AddressLine4EndsWithquerystringNo
AddressLine4ContainsquerystringNo
AddressLine4LikequerystringNo
AddressLine4Betweenquerystring[]No
AddressLine4Inquerystring[]No
CountryquerystringNo
CountryStartsWithquerystringNo
CountryEndsWithquerystringNo
CountryContainsquerystringNo
CountryLikequerystringNo
CountryBetweenquerystring[]No
CountryInquerystring[]No
PostcodequerystringNo
PostcodeStartsWithquerystringNo
PostcodeEndsWithquerystringNo
PostcodeContainsquerystringNo
PostcodeLikequerystringNo
PostcodeBetweenquerystring[]No
PostcodeInquerystring[]No
ContactNamequerystringNo
ContactNameStartsWithquerystringNo
ContactNameEndsWithquerystringNo
ContactNameContainsquerystringNo
ContactNameLikequerystringNo
ContactNameBetweenquerystring[]No
ContactNameInquerystring[]No
PhonequerystringNo
PhoneStartsWithquerystringNo
PhoneEndsWithquerystringNo
PhoneContainsquerystringNo
PhoneLikequerystringNo
PhoneBetweenquerystring[]No
PhoneInquerystring[]No
FaxquerystringNo
FaxStartsWithquerystringNo
FaxEndsWithquerystringNo
FaxContainsquerystringNo
FaxLikequerystringNo
FaxBetweenquerystring[]No
FaxInquerystring[]No
Spare1querystringNo
Spare1StartsWithquerystringNo
Spare1EndsWithquerystringNo
Spare1ContainsquerystringNo
Spare1LikequerystringNo
Spare1Betweenquerystring[]No
Spare1Inquerystring[]No
Spare2querystringNo
Spare2StartsWithquerystringNo
Spare2EndsWithquerystringNo
Spare2ContainsquerystringNo
Spare2LikequerystringNo
Spare2Betweenquerystring[]No
Spare2Inquerystring[]No
Spare3querystringNo
Spare3StartsWithquerystringNo
Spare3EndsWithquerystringNo
Spare3ContainsquerystringNo
Spare3LikequerystringNo
Spare3Betweenquerystring[]No
Spare3Inquerystring[]No
Spare4querystringNo
Spare4StartsWithquerystringNo
Spare4EndsWithquerystringNo
Spare4ContainsquerystringNo
Spare4LikequerystringNo
Spare4Betweenquerystring[]No
Spare4Inquerystring[]No
Spare5querystringNo
Spare5StartsWithquerystringNo
Spare5EndsWithquerystringNo
Spare5ContainsquerystringNo
Spare5LikequerystringNo
Spare5Betweenquerystring[]No
Spare5Inquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
PO_ShippingAddress Parameters:
NameParameterData TypeRequiredDescription
OrderIDformstringNo
LastSavedDateTimeformDateTimeNo
AddressLine1formstringNo
AddressLine2formstringNo
AddressLine3formstringNo
AddressLine4formstringNo
CountryformstringNo
PostcodeformstringNo
ContactNameformstringNo
PhoneformstringNo
FaxformstringNo
Spare1formstringNo
Spare2formstringNo
Spare3formstringNo
Spare4formstringNo
Spare5formstringNo
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.

POST /xml/reply/PO_ShippingAddressQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PO_ShippingAddressQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <AddressLine1>String</AddressLine1>
  <AddressLine1Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AddressLine1Between>
  <AddressLine1Contains>String</AddressLine1Contains>
  <AddressLine1EndsWith>String</AddressLine1EndsWith>
  <AddressLine1In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AddressLine1In>
  <AddressLine1Like>String</AddressLine1Like>
  <AddressLine1StartsWith>String</AddressLine1StartsWith>
  <AddressLine2>String</AddressLine2>
  <AddressLine2Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AddressLine2Between>
  <AddressLine2Contains>String</AddressLine2Contains>
  <AddressLine2EndsWith>String</AddressLine2EndsWith>
  <AddressLine2In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AddressLine2In>
  <AddressLine2Like>String</AddressLine2Like>
  <AddressLine2StartsWith>String</AddressLine2StartsWith>
  <AddressLine3>String</AddressLine3>
  <AddressLine3Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AddressLine3Between>
  <AddressLine3Contains>String</AddressLine3Contains>
  <AddressLine3EndsWith>String</AddressLine3EndsWith>
  <AddressLine3In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AddressLine3In>
  <AddressLine3Like>String</AddressLine3Like>
  <AddressLine3StartsWith>String</AddressLine3StartsWith>
  <AddressLine4>String</AddressLine4>
  <AddressLine4Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AddressLine4Between>
  <AddressLine4Contains>String</AddressLine4Contains>
  <AddressLine4EndsWith>String</AddressLine4EndsWith>
  <AddressLine4In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AddressLine4In>
  <AddressLine4Like>String</AddressLine4Like>
  <AddressLine4StartsWith>String</AddressLine4StartsWith>
  <ContactName>String</ContactName>
  <ContactNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ContactNameBetween>
  <ContactNameContains>String</ContactNameContains>
  <ContactNameEndsWith>String</ContactNameEndsWith>
  <ContactNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ContactNameIn>
  <ContactNameLike>String</ContactNameLike>
  <ContactNameStartsWith>String</ContactNameStartsWith>
  <Country>String</Country>
  <CountryBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CountryBetween>
  <CountryContains>String</CountryContains>
  <CountryEndsWith>String</CountryEndsWith>
  <CountryIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CountryIn>
  <CountryLike>String</CountryLike>
  <CountryStartsWith>String</CountryStartsWith>
  <Fax>String</Fax>
  <FaxBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FaxBetween>
  <FaxContains>String</FaxContains>
  <FaxEndsWith>String</FaxEndsWith>
  <FaxIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FaxIn>
  <FaxLike>String</FaxLike>
  <FaxStartsWith>String</FaxStartsWith>
  <LastSavedDateTime>0001-01-01T00:00:00</LastSavedDateTime>
  <LastSavedDateTimeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </LastSavedDateTimeBetween>
  <LastSavedDateTimeGreaterThan>0001-01-01T00:00:00</LastSavedDateTimeGreaterThan>
  <LastSavedDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeGreaterThanOrEqualTo>
  <LastSavedDateTimeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </LastSavedDateTimeIn>
  <LastSavedDateTimeLessThan>0001-01-01T00:00:00</LastSavedDateTimeLessThan>
  <LastSavedDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeLessThanOrEqualTo>
  <LastSavedDateTimeNotEqualTo>0001-01-01T00:00:00</LastSavedDateTimeNotEqualTo>
  <OrderID>String</OrderID>
  <OrderIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OrderIDBetween>
  <OrderIDContains>String</OrderIDContains>
  <OrderIDEndsWith>String</OrderIDEndsWith>
  <OrderIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OrderIDIn>
  <OrderIDLike>String</OrderIDLike>
  <OrderIDStartsWith>String</OrderIDStartsWith>
  <Phone>String</Phone>
  <PhoneBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PhoneBetween>
  <PhoneContains>String</PhoneContains>
  <PhoneEndsWith>String</PhoneEndsWith>
  <PhoneIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PhoneIn>
  <PhoneLike>String</PhoneLike>
  <PhoneStartsWith>String</PhoneStartsWith>
  <Postcode>String</Postcode>
  <PostcodeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PostcodeBetween>
  <PostcodeContains>String</PostcodeContains>
  <PostcodeEndsWith>String</PostcodeEndsWith>
  <PostcodeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PostcodeIn>
  <PostcodeLike>String</PostcodeLike>
  <PostcodeStartsWith>String</PostcodeStartsWith>
  <Spare1>String</Spare1>
  <Spare1Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Spare1Between>
  <Spare1Contains>String</Spare1Contains>
  <Spare1EndsWith>String</Spare1EndsWith>
  <Spare1In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Spare1In>
  <Spare1Like>String</Spare1Like>
  <Spare1StartsWith>String</Spare1StartsWith>
  <Spare2>String</Spare2>
  <Spare2Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Spare2Between>
  <Spare2Contains>String</Spare2Contains>
  <Spare2EndsWith>String</Spare2EndsWith>
  <Spare2In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Spare2In>
  <Spare2Like>String</Spare2Like>
  <Spare2StartsWith>String</Spare2StartsWith>
  <Spare3>String</Spare3>
  <Spare3Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Spare3Between>
  <Spare3Contains>String</Spare3Contains>
  <Spare3EndsWith>String</Spare3EndsWith>
  <Spare3In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Spare3In>
  <Spare3Like>String</Spare3Like>
  <Spare3StartsWith>String</Spare3StartsWith>
  <Spare4>String</Spare4>
  <Spare4Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Spare4Between>
  <Spare4Contains>String</Spare4Contains>
  <Spare4EndsWith>String</Spare4EndsWith>
  <Spare4In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Spare4In>
  <Spare4Like>String</Spare4Like>
  <Spare4StartsWith>String</Spare4StartsWith>
  <Spare5>String</Spare5>
  <Spare5Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Spare5Between>
  <Spare5Contains>String</Spare5Contains>
  <Spare5EndsWith>String</Spare5EndsWith>
  <Spare5In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Spare5In>
  <Spare5Like>String</Spare5Like>
  <Spare5StartsWith>String</Spare5StartsWith>
</PO_ShippingAddressQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfPO_ShippingAddress7kRqkrSv 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:PO_ShippingAddress>
      <d2p1:_x003C_AddressLine1_x003E_k__BackingField>String</d2p1:_x003C_AddressLine1_x003E_k__BackingField>
      <d2p1:_x003C_AddressLine2_x003E_k__BackingField>String</d2p1:_x003C_AddressLine2_x003E_k__BackingField>
      <d2p1:_x003C_AddressLine3_x003E_k__BackingField>String</d2p1:_x003C_AddressLine3_x003E_k__BackingField>
      <d2p1:_x003C_AddressLine4_x003E_k__BackingField>String</d2p1:_x003C_AddressLine4_x003E_k__BackingField>
      <d2p1:_x003C_ContactName_x003E_k__BackingField>String</d2p1:_x003C_ContactName_x003E_k__BackingField>
      <d2p1:_x003C_Country_x003E_k__BackingField>String</d2p1:_x003C_Country_x003E_k__BackingField>
      <d2p1:_x003C_Fax_x003E_k__BackingField>String</d2p1:_x003C_Fax_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_OrderID_x003E_k__BackingField>String</d2p1:_x003C_OrderID_x003E_k__BackingField>
      <d2p1:_x003C_Phone_x003E_k__BackingField>String</d2p1:_x003C_Phone_x003E_k__BackingField>
      <d2p1:_x003C_Postcode_x003E_k__BackingField>String</d2p1:_x003C_Postcode_x003E_k__BackingField>
      <d2p1:_x003C_Spare1_x003E_k__BackingField>String</d2p1:_x003C_Spare1_x003E_k__BackingField>
      <d2p1:_x003C_Spare2_x003E_k__BackingField>String</d2p1:_x003C_Spare2_x003E_k__BackingField>
      <d2p1:_x003C_Spare3_x003E_k__BackingField>String</d2p1:_x003C_Spare3_x003E_k__BackingField>
      <d2p1:_x003C_Spare4_x003E_k__BackingField>String</d2p1:_x003C_Spare4_x003E_k__BackingField>
      <d2p1:_x003C_Spare5_x003E_k__BackingField>String</d2p1:_x003C_Spare5_x003E_k__BackingField>
    </d2p1:PO_ShippingAddress>
  </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>
</QueryResponseOfPO_ShippingAddress7kRqkrSv>