JiwaAPI

<back to all web services

AR_ProviderQuery

Requires Authentication
AR_ProviderQuery Parameters:
NameParameterData TypeRequiredDescription
ProviderIDquerystringNo
ProviderIDStartsWithquerystringNo
ProviderIDEndsWithquerystringNo
ProviderIDContainsquerystringNo
ProviderIDLikequerystringNo
ProviderIDBetweenquerystring[]No
ProviderIDInquerystring[]No
ProviderNamequerystringNo
ProviderNameStartsWithquerystringNo
ProviderNameEndsWithquerystringNo
ProviderNameContainsquerystringNo
ProviderNameLikequerystringNo
ProviderNameBetweenquerystring[]No
ProviderNameInquerystring[]No
StoredProcedureNamequerystringNo
StoredProcedureNameStartsWithquerystringNo
StoredProcedureNameEndsWithquerystringNo
StoredProcedureNameContainsquerystringNo
StoredProcedureNameLikequerystringNo
StoredProcedureNameBetweenquerystring[]No
StoredProcedureNameInquerystring[]No
ProviderDescriptionquerystringNo
ProviderDescriptionStartsWithquerystringNo
ProviderDescriptionEndsWithquerystringNo
ProviderDescriptionContainsquerystringNo
ProviderDescriptionLikequerystringNo
ProviderDescriptionBetweenquerystring[]No
ProviderDescriptionInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
AR_Provider Parameters:
NameParameterData TypeRequiredDescription
ProviderIDformstringNo
ProviderNameformstringNo
StoredProcedureNameformstringNo
ProviderDescriptionformstringNo
LastSavedDateTimeformDateTimeNo
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/AR_ProviderQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AR_ProviderQuery 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>
  <LastSavedDateTime>0001-01-01T00:00:00</LastSavedDateTime>
  <LastSavedDateTimeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </LastSavedDateTimeBetween>
  <LastSavedDateTimeGreaterThan>0001-01-01T00:00:00</LastSavedDateTimeGreaterThan>
  <LastSavedDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeGreaterThanOrEqualTo>
  <LastSavedDateTimeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </LastSavedDateTimeIn>
  <LastSavedDateTimeLessThan>0001-01-01T00:00:00</LastSavedDateTimeLessThan>
  <LastSavedDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeLessThanOrEqualTo>
  <LastSavedDateTimeNotEqualTo>0001-01-01T00:00:00</LastSavedDateTimeNotEqualTo>
  <ProviderDescription>String</ProviderDescription>
  <ProviderDescriptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ProviderDescriptionBetween>
  <ProviderDescriptionContains>String</ProviderDescriptionContains>
  <ProviderDescriptionEndsWith>String</ProviderDescriptionEndsWith>
  <ProviderDescriptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ProviderDescriptionIn>
  <ProviderDescriptionLike>String</ProviderDescriptionLike>
  <ProviderDescriptionStartsWith>String</ProviderDescriptionStartsWith>
  <ProviderID>String</ProviderID>
  <ProviderIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ProviderIDBetween>
  <ProviderIDContains>String</ProviderIDContains>
  <ProviderIDEndsWith>String</ProviderIDEndsWith>
  <ProviderIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ProviderIDIn>
  <ProviderIDLike>String</ProviderIDLike>
  <ProviderIDStartsWith>String</ProviderIDStartsWith>
  <ProviderName>String</ProviderName>
  <ProviderNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ProviderNameBetween>
  <ProviderNameContains>String</ProviderNameContains>
  <ProviderNameEndsWith>String</ProviderNameEndsWith>
  <ProviderNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ProviderNameIn>
  <ProviderNameLike>String</ProviderNameLike>
  <ProviderNameStartsWith>String</ProviderNameStartsWith>
  <StoredProcedureName>String</StoredProcedureName>
  <StoredProcedureNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </StoredProcedureNameBetween>
  <StoredProcedureNameContains>String</StoredProcedureNameContains>
  <StoredProcedureNameEndsWith>String</StoredProcedureNameEndsWith>
  <StoredProcedureNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </StoredProcedureNameIn>
  <StoredProcedureNameLike>String</StoredProcedureNameLike>
  <StoredProcedureNameStartsWith>String</StoredProcedureNameStartsWith>
</AR_ProviderQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfAR_Provider7kRqkrSv 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:AR_Provider>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_ProviderDescription_x003E_k__BackingField>String</d2p1:_x003C_ProviderDescription_x003E_k__BackingField>
      <d2p1:_x003C_ProviderID_x003E_k__BackingField>String</d2p1:_x003C_ProviderID_x003E_k__BackingField>
      <d2p1:_x003C_ProviderName_x003E_k__BackingField>String</d2p1:_x003C_ProviderName_x003E_k__BackingField>
      <d2p1:_x003C_StoredProcedureName_x003E_k__BackingField>String</d2p1:_x003C_StoredProcedureName_x003E_k__BackingField>
    </d2p1:AR_Provider>
  </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>
</QueryResponseOfAR_Provider7kRqkrSv>