JiwaAPI

<back to all web services

AR_ProviderHeadersQuery

Requires Authentication
AR_ProviderHeadersQuery Parameters:
NameParameterData TypeRequiredDescription
ProviderIDquerystringNo
ProviderIDStartsWithquerystringNo
ProviderIDEndsWithquerystringNo
ProviderIDContainsquerystringNo
ProviderIDLikequerystringNo
ProviderIDBetweenquerystring[]No
ProviderIDInquerystring[]No
HeaderIDquerystringNo
HeaderIDStartsWithquerystringNo
HeaderIDEndsWithquerystringNo
HeaderIDContainsquerystringNo
HeaderIDLikequerystringNo
HeaderIDBetweenquerystring[]No
HeaderIDInquerystring[]No
HeaderNamequerystringNo
HeaderNameStartsWithquerystringNo
HeaderNameEndsWithquerystringNo
HeaderNameContainsquerystringNo
HeaderNameLikequerystringNo
HeaderNameBetweenquerystring[]No
HeaderNameInquerystring[]No
DataTypequeryint?No
DataTypeGreaterThanOrEqualToqueryint?No
DataTypeGreaterThanqueryint?No
DataTypeLessThanqueryint?No
DataTypeLessThanOrEqualToqueryint?No
DataTypeNotEqualToqueryint?No
DataTypeBetweenqueryint[]No
DataTypeInqueryint[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
OrdinalPositionqueryshort?No
OrdinalPositionGreaterThanOrEqualToqueryshort?No
OrdinalPositionGreaterThanqueryshort?No
OrdinalPositionLessThanqueryshort?No
OrdinalPositionLessThanOrEqualToqueryshort?No
OrdinalPositionNotEqualToqueryshort?No
OrdinalPositionBetweenqueryshort[]No
OrdinalPositionInqueryshort[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
AR_ProviderHeaders Parameters:
NameParameterData TypeRequiredDescription
ProviderIDformstringNo
HeaderIDformstringNo
HeaderNameformstringNo
DataTypeformintNo
LastSavedDateTimeformDateTimeNo
OrdinalPositionformshortNo
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_ProviderHeadersQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AR_ProviderHeadersQuery 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>
  <DataType>0</DataType>
  <DataTypeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </DataTypeBetween>
  <DataTypeGreaterThan>0</DataTypeGreaterThan>
  <DataTypeGreaterThanOrEqualTo>0</DataTypeGreaterThanOrEqualTo>
  <DataTypeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </DataTypeIn>
  <DataTypeLessThan>0</DataTypeLessThan>
  <DataTypeLessThanOrEqualTo>0</DataTypeLessThanOrEqualTo>
  <DataTypeNotEqualTo>0</DataTypeNotEqualTo>
  <HeaderID>String</HeaderID>
  <HeaderIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </HeaderIDBetween>
  <HeaderIDContains>String</HeaderIDContains>
  <HeaderIDEndsWith>String</HeaderIDEndsWith>
  <HeaderIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </HeaderIDIn>
  <HeaderIDLike>String</HeaderIDLike>
  <HeaderIDStartsWith>String</HeaderIDStartsWith>
  <HeaderName>String</HeaderName>
  <HeaderNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </HeaderNameBetween>
  <HeaderNameContains>String</HeaderNameContains>
  <HeaderNameEndsWith>String</HeaderNameEndsWith>
  <HeaderNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </HeaderNameIn>
  <HeaderNameLike>String</HeaderNameLike>
  <HeaderNameStartsWith>String</HeaderNameStartsWith>
  <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>
  <OrdinalPosition>0</OrdinalPosition>
  <OrdinalPositionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:short>0</d2p1:short>
  </OrdinalPositionBetween>
  <OrdinalPositionGreaterThan>0</OrdinalPositionGreaterThan>
  <OrdinalPositionGreaterThanOrEqualTo>0</OrdinalPositionGreaterThanOrEqualTo>
  <OrdinalPositionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:short>0</d2p1:short>
  </OrdinalPositionIn>
  <OrdinalPositionLessThan>0</OrdinalPositionLessThan>
  <OrdinalPositionLessThanOrEqualTo>0</OrdinalPositionLessThanOrEqualTo>
  <OrdinalPositionNotEqualTo>0</OrdinalPositionNotEqualTo>
  <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>
</AR_ProviderHeadersQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfAR_ProviderHeaders7kRqkrSv 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_ProviderHeaders>
      <d2p1:_x003C_DataType_x003E_k__BackingField>0</d2p1:_x003C_DataType_x003E_k__BackingField>
      <d2p1:_x003C_HeaderID_x003E_k__BackingField>String</d2p1:_x003C_HeaderID_x003E_k__BackingField>
      <d2p1:_x003C_HeaderName_x003E_k__BackingField>String</d2p1:_x003C_HeaderName_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_OrdinalPosition_x003E_k__BackingField>0</d2p1:_x003C_OrdinalPosition_x003E_k__BackingField>
      <d2p1:_x003C_ProviderID_x003E_k__BackingField>String</d2p1:_x003C_ProviderID_x003E_k__BackingField>
    </d2p1:AR_ProviderHeaders>
  </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_ProviderHeaders7kRqkrSv>