JiwaAPI

<back to all web services

DB_DirectorsQuery

Requires Authentication
DB_DirectorsQuery Parameters:
NameParameterData TypeRequiredDescription
DirectorIDquerystringNo
DirectorIDStartsWithquerystringNo
DirectorIDEndsWithquerystringNo
DirectorIDContainsquerystringNo
DirectorIDLikequerystringNo
DirectorIDBetweenquerystring[]No
DirectorIDInquerystring[]No
DebtorIDquerystringNo
DebtorIDStartsWithquerystringNo
DebtorIDEndsWithquerystringNo
DebtorIDContainsquerystringNo
DebtorIDLikequerystringNo
DebtorIDBetweenquerystring[]No
DebtorIDInquerystring[]No
DirectorNamequerystringNo
DirectorNameStartsWithquerystringNo
DirectorNameEndsWithquerystringNo
DirectorNameContainsquerystringNo
DirectorNameLikequerystringNo
DirectorNameBetweenquerystring[]No
DirectorNameInquerystring[]No
AddressquerystringNo
AddressStartsWithquerystringNo
AddressEndsWithquerystringNo
AddressContainsquerystringNo
AddressLikequerystringNo
AddressBetweenquerystring[]No
AddressInquerystring[]No
OfficeHeldquerystringNo
OfficeHeldStartsWithquerystringNo
OfficeHeldEndsWithquerystringNo
OfficeHeldContainsquerystringNo
OfficeHeldLikequerystringNo
OfficeHeldBetweenquerystring[]No
OfficeHeldInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
DB_Directors Parameters:
NameParameterData TypeRequiredDescription
DirectorIDformstringNo
DebtorIDformstringNo
DirectorNameformstringNo
AddressformstringNo
OfficeHeldformstringNo
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_DirectorsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DB_DirectorsQuery 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>
  <Address>String</Address>
  <AddressBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AddressBetween>
  <AddressContains>String</AddressContains>
  <AddressEndsWith>String</AddressEndsWith>
  <AddressIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AddressIn>
  <AddressLike>String</AddressLike>
  <AddressStartsWith>String</AddressStartsWith>
  <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>
  <DirectorID>String</DirectorID>
  <DirectorIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DirectorIDBetween>
  <DirectorIDContains>String</DirectorIDContains>
  <DirectorIDEndsWith>String</DirectorIDEndsWith>
  <DirectorIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DirectorIDIn>
  <DirectorIDLike>String</DirectorIDLike>
  <DirectorIDStartsWith>String</DirectorIDStartsWith>
  <DirectorName>String</DirectorName>
  <DirectorNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DirectorNameBetween>
  <DirectorNameContains>String</DirectorNameContains>
  <DirectorNameEndsWith>String</DirectorNameEndsWith>
  <DirectorNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DirectorNameIn>
  <DirectorNameLike>String</DirectorNameLike>
  <DirectorNameStartsWith>String</DirectorNameStartsWith>
  <OfficeHeld>String</OfficeHeld>
  <OfficeHeldBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OfficeHeldBetween>
  <OfficeHeldContains>String</OfficeHeldContains>
  <OfficeHeldEndsWith>String</OfficeHeldEndsWith>
  <OfficeHeldIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OfficeHeldIn>
  <OfficeHeldLike>String</OfficeHeldLike>
  <OfficeHeldStartsWith>String</OfficeHeldStartsWith>
</DB_DirectorsQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfDB_Directors7kRqkrSv 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_Directors>
      <d2p1:_x003C_Address_x003E_k__BackingField>String</d2p1:_x003C_Address_x003E_k__BackingField>
      <d2p1:_x003C_DebtorID_x003E_k__BackingField>String</d2p1:_x003C_DebtorID_x003E_k__BackingField>
      <d2p1:_x003C_DirectorID_x003E_k__BackingField>String</d2p1:_x003C_DirectorID_x003E_k__BackingField>
      <d2p1:_x003C_DirectorName_x003E_k__BackingField>String</d2p1:_x003C_DirectorName_x003E_k__BackingField>
      <d2p1:_x003C_OfficeHeld_x003E_k__BackingField>String</d2p1:_x003C_OfficeHeld_x003E_k__BackingField>
    </d2p1:DB_Directors>
  </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_Directors7kRqkrSv>