JiwaAPI

<back to all web services

DB_EDIMainQuery

Requires Authentication
DB_EDIMainQuery Parameters:
NameParameterData TypeRequiredDescription
DebtorIDquerystringNo
DebtorIDStartsWithquerystringNo
DebtorIDEndsWithquerystringNo
DebtorIDContainsquerystringNo
DebtorIDLikequerystringNo
DebtorIDBetweenquerystring[]No
DebtorIDInquerystring[]No
EDIEnabledquerybool?No
EDIAddressquerystringNo
EDIAddressStartsWithquerystringNo
EDIAddressEndsWithquerystringNo
EDIAddressContainsquerystringNo
EDIAddressLikequerystringNo
EDIAddressBetweenquerystring[]No
EDIAddressInquerystring[]No
EDIOrderTypequerybyte?No
EDIOrderTypeGreaterThanOrEqualToquerybyte?No
EDIOrderTypeGreaterThanquerybyte?No
EDIOrderTypeLessThanquerybyte?No
EDIOrderTypeLessThanOrEqualToquerybyte?No
EDIOrderTypeNotEqualToquerybyte?No
EDIOrderTypeBetweenqueryNullable<Byte>[]No
EDIOrderTypeInqueryNullable<Byte>[]No
EDIPricesIncludeTaxquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
DB_EDIMain Parameters:
NameParameterData TypeRequiredDescription
DebtorIDformstringNo
EDIEnabledformbool?No
EDIAddressformstringNo
EDIOrderTypeformbyte?No
EDIPricesIncludeTaxformbool?No
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_EDIMainQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DB_EDIMainQuery 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>
  <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>
  <EDIAddress>String</EDIAddress>
  <EDIAddressBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EDIAddressBetween>
  <EDIAddressContains>String</EDIAddressContains>
  <EDIAddressEndsWith>String</EDIAddressEndsWith>
  <EDIAddressIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EDIAddressIn>
  <EDIAddressLike>String</EDIAddressLike>
  <EDIAddressStartsWith>String</EDIAddressStartsWith>
  <EDIEnabled>false</EDIEnabled>
  <EDIOrderType>0</EDIOrderType>
  <EDIOrderTypeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:unsignedByte>0</d2p1:unsignedByte>
  </EDIOrderTypeBetween>
  <EDIOrderTypeGreaterThan>0</EDIOrderTypeGreaterThan>
  <EDIOrderTypeGreaterThanOrEqualTo>0</EDIOrderTypeGreaterThanOrEqualTo>
  <EDIOrderTypeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:unsignedByte>0</d2p1:unsignedByte>
  </EDIOrderTypeIn>
  <EDIOrderTypeLessThan>0</EDIOrderTypeLessThan>
  <EDIOrderTypeLessThanOrEqualTo>0</EDIOrderTypeLessThanOrEqualTo>
  <EDIOrderTypeNotEqualTo>0</EDIOrderTypeNotEqualTo>
  <EDIPricesIncludeTax>false</EDIPricesIncludeTax>
</DB_EDIMainQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfDB_EDIMain7kRqkrSv 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_EDIMain>
      <d2p1:_x003C_DebtorID_x003E_k__BackingField>String</d2p1:_x003C_DebtorID_x003E_k__BackingField>
      <d2p1:_x003C_EDIAddress_x003E_k__BackingField>String</d2p1:_x003C_EDIAddress_x003E_k__BackingField>
      <d2p1:_x003C_EDIEnabled_x003E_k__BackingField>false</d2p1:_x003C_EDIEnabled_x003E_k__BackingField>
      <d2p1:_x003C_EDIOrderType_x003E_k__BackingField>0</d2p1:_x003C_EDIOrderType_x003E_k__BackingField>
      <d2p1:_x003C_EDIPricesIncludeTax_x003E_k__BackingField>false</d2p1:_x003C_EDIPricesIncludeTax_x003E_k__BackingField>
    </d2p1:DB_EDIMain>
  </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_EDIMain7kRqkrSv>