JiwaAPI

DB_DeliveryAddressQuery

**DB_DeliveryAddressQuery** Parameters:
Name	Parameter	Data Type	Required
DeliveryID	query	string	No
DeliveryIDStartsWith	query	string	No
DeliveryIDEndsWith	query	string	No
DeliveryIDContains	query	string	No
DeliveryIDLike	query	string	No
DeliveryIDBetween	query	string[]	No
DeliveryIDIn	query	string[]	No
DebtorID	query	string	No
DebtorIDStartsWith	query	string	No
DebtorIDEndsWith	query	string	No
DebtorIDContains	query	string	No
DebtorIDLike	query	string	No
DebtorIDBetween	query	string[]	No
DebtorIDIn	query	string[]	No
Address1	query	string	No
Address1StartsWith	query	string	No
Address1EndsWith	query	string	No
Address1Contains	query	string	No
Address1Like	query	string	No
Address1Between	query	string[]	No
Address1In	query	string[]	No
Address2	query	string	No
Address2StartsWith	query	string	No
Address2EndsWith	query	string	No
Address2Contains	query	string	No
Address2Like	query	string	No
Address2Between	query	string[]	No
Address2In	query	string[]	No
Address3	query	string	No
Address3StartsWith	query	string	No
Address3EndsWith	query	string	No
Address3Contains	query	string	No
Address3Like	query	string	No
Address3Between	query	string[]	No
Address3In	query	string[]	No
Address4	query	string	No
Address4StartsWith	query	string	No
Address4EndsWith	query	string	No
Address4Contains	query	string	No
Address4Like	query	string	No
Address4Between	query	string[]	No
Address4In	query	string[]	No
PostCode	query	string	No
PostCodeStartsWith	query	string	No
PostCodeEndsWith	query	string	No
PostCodeContains	query	string	No
PostCodeLike	query	string	No
PostCodeBetween	query	string[]	No
PostCodeIn	query	string[]	No
Notes	query	string	No
NotesStartsWith	query	string	No
NotesEndsWith	query	string	No
NotesContains	query	string	No
NotesLike	query	string	No
NotesBetween	query	string[]	No
NotesIn	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
DefaultItem	query	bool?	No
LineNum	query	int?	No
LineNumGreaterThanOrEqualTo	query	int?	No
LineNumGreaterThan	query	int?	No
LineNumLessThan	query	int?	No
LineNumLessThanOrEqualTo	query	int?	No
LineNumNotEqualTo	query	int?	No
LineNumBetween	query	Nullable<Int32>[]	No
LineNumIn	query	Nullable<Int32>[]	No
EDIStoreLocationCode	query	string	No
EDIStoreLocationCodeStartsWith	query	string	No
EDIStoreLocationCodeEndsWith	query	string	No
EDIStoreLocationCodeContains	query	string	No
EDIStoreLocationCodeLike	query	string	No
EDIStoreLocationCodeBetween	query	string[]	No
EDIStoreLocationCodeIn	query	string[]	No
DeliveryAddressCode	query	string	No
DeliveryAddressCodeStartsWith	query	string	No
DeliveryAddressCodeEndsWith	query	string	No
DeliveryAddressCodeContains	query	string	No
DeliveryAddressCodeLike	query	string	No
DeliveryAddressCodeBetween	query	string[]	No
DeliveryAddressCodeIn	query	string[]	No
DeliveryAddressName	query	string	No
DeliveryAddressNameStartsWith	query	string	No
DeliveryAddressNameEndsWith	query	string	No
DeliveryAddressNameContains	query	string	No
DeliveryAddressNameLike	query	string	No
DeliveryAddressNameBetween	query	string[]	No
DeliveryAddressNameIn	query	string[]	No
Country	query	string	No
CountryStartsWith	query	string	No
CountryEndsWith	query	string	No
CountryContains	query	string	No
CountryLike	query	string	No
CountryBetween	query	string[]	No
CountryIn	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

**DB_DeliveryAddress** Parameters:
Name	Parameter	Data Type	Required
DeliveryID	form	string	No
DebtorID	form	string	No
Address1	form	string	No
Address2	form	string	No
Address3	form	string	No
Address4	form	string	No
PostCode	form	string	No
Notes	form	string	No
CourierDetails	form	string	No
DefaultItem	form	bool?	No
LineNum	form	int?	No
EDIStoreLocationCode	form	string	No
DeliveryAddressCode	form	string	No
DeliveryAddressName	form	string	No
Country	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.

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

<DB_DeliveryAddressQuery 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>
  <Address1>String</Address1>
  <Address1Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Address1Between>
  <Address1Contains>String</Address1Contains>
  <Address1EndsWith>String</Address1EndsWith>
  <Address1In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Address1In>
  <Address1Like>String</Address1Like>
  <Address1StartsWith>String</Address1StartsWith>
  <Address2>String</Address2>
  <Address2Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Address2Between>
  <Address2Contains>String</Address2Contains>
  <Address2EndsWith>String</Address2EndsWith>
  <Address2In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Address2In>
  <Address2Like>String</Address2Like>
  <Address2StartsWith>String</Address2StartsWith>
  <Address3>String</Address3>
  <Address3Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Address3Between>
  <Address3Contains>String</Address3Contains>
  <Address3EndsWith>String</Address3EndsWith>
  <Address3In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Address3In>
  <Address3Like>String</Address3Like>
  <Address3StartsWith>String</Address3StartsWith>
  <Address4>String</Address4>
  <Address4Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Address4Between>
  <Address4Contains>String</Address4Contains>
  <Address4EndsWith>String</Address4EndsWith>
  <Address4In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Address4In>
  <Address4Like>String</Address4Like>
  <Address4StartsWith>String</Address4StartsWith>
  <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>
  <CourierDetails>String</CourierDetails>
  <CourierDetailsBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CourierDetailsBetween>
  <CourierDetailsContains>String</CourierDetailsContains>
  <CourierDetailsEndsWith>String</CourierDetailsEndsWith>
  <CourierDetailsIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CourierDetailsIn>
  <CourierDetailsLike>String</CourierDetailsLike>
  <CourierDetailsStartsWith>String</CourierDetailsStartsWith>
  <DebtorID>String</DebtorID>
  <DebtorIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DebtorIDBetween>
  <DebtorIDContains>String</DebtorIDContains>
  <DebtorIDEndsWith>String</DebtorIDEndsWith>
  <DebtorIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DebtorIDIn>
  <DebtorIDLike>String</DebtorIDLike>
  <DebtorIDStartsWith>String</DebtorIDStartsWith>
  <DefaultItem>false</DefaultItem>
  <DeliveryAddressCode>String</DeliveryAddressCode>
  <DeliveryAddressCodeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DeliveryAddressCodeBetween>
  <DeliveryAddressCodeContains>String</DeliveryAddressCodeContains>
  <DeliveryAddressCodeEndsWith>String</DeliveryAddressCodeEndsWith>
  <DeliveryAddressCodeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DeliveryAddressCodeIn>
  <DeliveryAddressCodeLike>String</DeliveryAddressCodeLike>
  <DeliveryAddressCodeStartsWith>String</DeliveryAddressCodeStartsWith>
  <DeliveryAddressName>String</DeliveryAddressName>
  <DeliveryAddressNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DeliveryAddressNameBetween>
  <DeliveryAddressNameContains>String</DeliveryAddressNameContains>
  <DeliveryAddressNameEndsWith>String</DeliveryAddressNameEndsWith>
  <DeliveryAddressNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DeliveryAddressNameIn>
  <DeliveryAddressNameLike>String</DeliveryAddressNameLike>
  <DeliveryAddressNameStartsWith>String</DeliveryAddressNameStartsWith>
  <DeliveryID>String</DeliveryID>
  <DeliveryIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DeliveryIDBetween>
  <DeliveryIDContains>String</DeliveryIDContains>
  <DeliveryIDEndsWith>String</DeliveryIDEndsWith>
  <DeliveryIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DeliveryIDIn>
  <DeliveryIDLike>String</DeliveryIDLike>
  <DeliveryIDStartsWith>String</DeliveryIDStartsWith>
  <EDIStoreLocationCode>String</EDIStoreLocationCode>
  <EDIStoreLocationCodeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EDIStoreLocationCodeBetween>
  <EDIStoreLocationCodeContains>String</EDIStoreLocationCodeContains>
  <EDIStoreLocationCodeEndsWith>String</EDIStoreLocationCodeEndsWith>
  <EDIStoreLocationCodeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EDIStoreLocationCodeIn>
  <EDIStoreLocationCodeLike>String</EDIStoreLocationCodeLike>
  <EDIStoreLocationCodeStartsWith>String</EDIStoreLocationCodeStartsWith>
  <LineNum>0</LineNum>
  <LineNumBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:int>0</d2p1:int>
  </LineNumBetween>
  <LineNumGreaterThan>0</LineNumGreaterThan>
  <LineNumGreaterThanOrEqualTo>0</LineNumGreaterThanOrEqualTo>
  <LineNumIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:int>0</d2p1:int>
  </LineNumIn>
  <LineNumLessThan>0</LineNumLessThan>
  <LineNumLessThanOrEqualTo>0</LineNumLessThanOrEqualTo>
  <LineNumNotEqualTo>0</LineNumNotEqualTo>
  <Notes>String</Notes>
  <NotesBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NotesBetween>
  <NotesContains>String</NotesContains>
  <NotesEndsWith>String</NotesEndsWith>
  <NotesIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NotesIn>
  <NotesLike>String</NotesLike>
  <NotesStartsWith>String</NotesStartsWith>
  <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>
</DB_DeliveryAddressQuery>

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

<QueryResponseOfDB_DeliveryAddress7kRqkrSv 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:DB_DeliveryAddress>
      <d2p1:_x003C_Address1_x003E_k__BackingField>String</d2p1:_x003C_Address1_x003E_k__BackingField>
      <d2p1:_x003C_Address2_x003E_k__BackingField>String</d2p1:_x003C_Address2_x003E_k__BackingField>
      <d2p1:_x003C_Address3_x003E_k__BackingField>String</d2p1:_x003C_Address3_x003E_k__BackingField>
      <d2p1:_x003C_Address4_x003E_k__BackingField>String</d2p1:_x003C_Address4_x003E_k__BackingField>
      <d2p1:_x003C_Country_x003E_k__BackingField>String</d2p1:_x003C_Country_x003E_k__BackingField>
      <d2p1:_x003C_CourierDetails_x003E_k__BackingField>String</d2p1:_x003C_CourierDetails_x003E_k__BackingField>
      <d2p1:_x003C_DebtorID_x003E_k__BackingField>String</d2p1:_x003C_DebtorID_x003E_k__BackingField>
      <d2p1:_x003C_DefaultItem_x003E_k__BackingField>false</d2p1:_x003C_DefaultItem_x003E_k__BackingField>
      <d2p1:_x003C_DeliveryAddressCode_x003E_k__BackingField>String</d2p1:_x003C_DeliveryAddressCode_x003E_k__BackingField>
      <d2p1:_x003C_DeliveryAddressName_x003E_k__BackingField>String</d2p1:_x003C_DeliveryAddressName_x003E_k__BackingField>
      <d2p1:_x003C_DeliveryID_x003E_k__BackingField>String</d2p1:_x003C_DeliveryID_x003E_k__BackingField>
      <d2p1:_x003C_EDIStoreLocationCode_x003E_k__BackingField>String</d2p1:_x003C_EDIStoreLocationCode_x003E_k__BackingField>
      <d2p1:_x003C_LineNum_x003E_k__BackingField>0</d2p1:_x003C_LineNum_x003E_k__BackingField>
      <d2p1:_x003C_Notes_x003E_k__BackingField>String</d2p1:_x003C_Notes_x003E_k__BackingField>
      <d2p1:_x003C_PostCode_x003E_k__BackingField>String</d2p1:_x003C_PostCode_x003E_k__BackingField>
    </d2p1:DB_DeliveryAddress>
  </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>
</QueryResponseOfDB_DeliveryAddress7kRqkrSv>