JiwaAPI

<back to all web services

V_JIWA_Debtor_ALLQuery

Requires Authentication
V_JIWA_Debtor_ALLQuery Parameters:
NameParameterData TypeRequiredDescription
DebtorIDquerystringNo
DebtorIDStartsWithquerystringNo
DebtorIDEndsWithquerystringNo
DebtorIDContainsquerystringNo
DebtorIDLikequerystringNo
DebtorIDBetweenquerystring[]No
DebtorIDInquerystring[]No
SearchFieldquerystringNo
SearchFieldStartsWithquerystringNo
SearchFieldEndsWithquerystringNo
SearchFieldContainsquerystringNo
SearchFieldLikequerystringNo
SearchFieldBetweenquerystring[]No
SearchFieldInquerystring[]No
AccountNoquerystringNo
AccountNoStartsWithquerystringNo
AccountNoEndsWithquerystringNo
AccountNoContainsquerystringNo
AccountNoLikequerystringNo
AccountNoBetweenquerystring[]No
AccountNoInquerystring[]No
NamequerystringNo
NameStartsWithquerystringNo
NameEndsWithquerystringNo
NameContainsquerystringNo
NameLikequerystringNo
NameBetweenquerystring[]No
NameInquerystring[]No
PhonequerystringNo
PhoneStartsWithquerystringNo
PhoneEndsWithquerystringNo
PhoneContainsquerystringNo
PhoneLikequerystringNo
PhoneBetweenquerystring[]No
PhoneInquerystring[]No
PostCodequerystringNo
PostCodeStartsWithquerystringNo
PostCodeEndsWithquerystringNo
PostCodeContainsquerystringNo
PostCodeLikequerystringNo
PostCodeBetweenquerystring[]No
PostCodeInquerystring[]No
Address3querystringNo
Address3StartsWithquerystringNo
Address3EndsWithquerystringNo
Address3ContainsquerystringNo
Address3LikequerystringNo
Address3Betweenquerystring[]No
Address3Inquerystring[]No
Address2querystringNo
Address2StartsWithquerystringNo
Address2EndsWithquerystringNo
Address2ContainsquerystringNo
Address2LikequerystringNo
Address2Betweenquerystring[]No
Address2Inquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
V_JIWA_Debtor_ALL Parameters:
NameParameterData TypeRequiredDescription
DebtorIDformstringNo
SearchFieldformstringNo
AccountNoformstringNo
NameformstringNo
PhoneformstringNo
PostCodeformstringNo
Address3formstringNo
Address2formstringNo
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/V_JIWA_Debtor_ALLQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<V_JIWA_Debtor_ALLQuery 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>
  <AccountNo>String</AccountNo>
  <AccountNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AccountNoBetween>
  <AccountNoContains>String</AccountNoContains>
  <AccountNoEndsWith>String</AccountNoEndsWith>
  <AccountNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AccountNoIn>
  <AccountNoLike>String</AccountNoLike>
  <AccountNoStartsWith>String</AccountNoStartsWith>
  <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>
  <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>
  <Name>String</Name>
  <NameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NameBetween>
  <NameContains>String</NameContains>
  <NameEndsWith>String</NameEndsWith>
  <NameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NameIn>
  <NameLike>String</NameLike>
  <NameStartsWith>String</NameStartsWith>
  <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>
  <SearchField>String</SearchField>
  <SearchFieldBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SearchFieldBetween>
  <SearchFieldContains>String</SearchFieldContains>
  <SearchFieldEndsWith>String</SearchFieldEndsWith>
  <SearchFieldIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SearchFieldIn>
  <SearchFieldLike>String</SearchFieldLike>
  <SearchFieldStartsWith>String</SearchFieldStartsWith>
</V_JIWA_Debtor_ALLQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfV_JIWA_Debtor_ALL7kRqkrSv 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:V_JIWA_Debtor_ALL>
      <d2p1:_x003C_AccountNo_x003E_k__BackingField>String</d2p1:_x003C_AccountNo_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_DebtorID_x003E_k__BackingField>String</d2p1:_x003C_DebtorID_x003E_k__BackingField>
      <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_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_SearchField_x003E_k__BackingField>String</d2p1:_x003C_SearchField_x003E_k__BackingField>
    </d2p1:V_JIWA_Debtor_ALL>
  </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>
</QueryResponseOfV_JIWA_Debtor_ALL7kRqkrSv>