JiwaAPI

<back to all web services

DB_FreightForwardAddressQuery

Requires Authentication
DB_FreightForwardAddressQuery Parameters:
NameParameterData TypeRequiredDescription
FreightForwardIDquerystringNo
FreightForwardIDStartsWithquerystringNo
FreightForwardIDEndsWithquerystringNo
FreightForwardIDContainsquerystringNo
FreightForwardIDLikequerystringNo
FreightForwardIDBetweenquerystring[]No
FreightForwardIDInquerystring[]No
DebtorIDquerystringNo
DebtorIDStartsWithquerystringNo
DebtorIDEndsWithquerystringNo
DebtorIDContainsquerystringNo
DebtorIDLikequerystringNo
DebtorIDBetweenquerystring[]No
DebtorIDInquerystring[]No
Address1querystringNo
Address1StartsWithquerystringNo
Address1EndsWithquerystringNo
Address1ContainsquerystringNo
Address1LikequerystringNo
Address1Betweenquerystring[]No
Address1Inquerystring[]No
Address2querystringNo
Address2StartsWithquerystringNo
Address2EndsWithquerystringNo
Address2ContainsquerystringNo
Address2LikequerystringNo
Address2Betweenquerystring[]No
Address2Inquerystring[]No
Address3querystringNo
Address3StartsWithquerystringNo
Address3EndsWithquerystringNo
Address3ContainsquerystringNo
Address3LikequerystringNo
Address3Betweenquerystring[]No
Address3Inquerystring[]No
Address4querystringNo
Address4StartsWithquerystringNo
Address4EndsWithquerystringNo
Address4ContainsquerystringNo
Address4LikequerystringNo
Address4Betweenquerystring[]No
Address4Inquerystring[]No
NotesquerystringNo
NotesStartsWithquerystringNo
NotesEndsWithquerystringNo
NotesContainsquerystringNo
NotesLikequerystringNo
NotesBetweenquerystring[]No
NotesInquerystring[]No
DefaultItemquerybool?No
LineNumqueryint?No
LineNumGreaterThanOrEqualToqueryint?No
LineNumGreaterThanqueryint?No
LineNumLessThanqueryint?No
LineNumLessThanOrEqualToqueryint?No
LineNumNotEqualToqueryint?No
LineNumBetweenqueryNullable<Int32>[]No
LineNumInqueryNullable<Int32>[]No
CountryquerystringNo
CountryStartsWithquerystringNo
CountryEndsWithquerystringNo
CountryContainsquerystringNo
CountryLikequerystringNo
CountryBetweenquerystring[]No
CountryInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
DB_FreightForwardAddress Parameters:
NameParameterData TypeRequiredDescription
FreightForwardIDformstringNo
DebtorIDformstringNo
Address1formstringNo
Address2formstringNo
Address3formstringNo
Address4formstringNo
NotesformstringNo
DefaultItemformbool?No
LineNumformint?No
CountryformstringNo
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/DB_FreightForwardAddressQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DB_FreightForwardAddressQuery 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>
  <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>
  <FreightForwardID>String</FreightForwardID>
  <FreightForwardIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FreightForwardIDBetween>
  <FreightForwardIDContains>String</FreightForwardIDContains>
  <FreightForwardIDEndsWith>String</FreightForwardIDEndsWith>
  <FreightForwardIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FreightForwardIDIn>
  <FreightForwardIDLike>String</FreightForwardIDLike>
  <FreightForwardIDStartsWith>String</FreightForwardIDStartsWith>
  <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>
</DB_FreightForwardAddressQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfDB_FreightForwardAddress7kRqkrSv 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_FreightForwardAddress>
      <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_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_FreightForwardID_x003E_k__BackingField>String</d2p1:_x003C_FreightForwardID_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:DB_FreightForwardAddress>
  </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_FreightForwardAddress7kRqkrSv>