JiwaAPI

<back to all web services

IN_PriceSchemesQuery

Requires Authentication
IN_PriceSchemesQuery Parameters:
NameParameterData TypeRequiredDescription
PriceSchemeIDquerystringNo
PriceSchemeIDStartsWithquerystringNo
PriceSchemeIDEndsWithquerystringNo
PriceSchemeIDContainsquerystringNo
PriceSchemeIDLikequerystringNo
PriceSchemeIDBetweenquerystring[]No
PriceSchemeIDInquerystring[]No
PriceSchemeDescriptionquerystringNo
PriceSchemeDescriptionStartsWithquerystringNo
PriceSchemeDescriptionEndsWithquerystringNo
PriceSchemeDescriptionContainsquerystringNo
PriceSchemeDescriptionLikequerystringNo
PriceSchemeDescriptionBetweenquerystring[]No
PriceSchemeDescriptionInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
SchemeActivequerybool?No
FindTheCheapestquerybool?No
IsDefaultquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
IN_PriceSchemes Parameters:
NameParameterData TypeRequiredDescription
PriceSchemeIDformstringNo
PriceSchemeDescriptionformstringNo
LastSavedDateTimeformDateTimeNo
SchemeActiveformboolNo
FindTheCheapestformboolNo
IsDefaultformbool?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/IN_PriceSchemesQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<IN_PriceSchemesQuery 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>
  <FindTheCheapest>false</FindTheCheapest>
  <IsDefault>false</IsDefault>
  <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>
  <PriceSchemeDescription>String</PriceSchemeDescription>
  <PriceSchemeDescriptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PriceSchemeDescriptionBetween>
  <PriceSchemeDescriptionContains>String</PriceSchemeDescriptionContains>
  <PriceSchemeDescriptionEndsWith>String</PriceSchemeDescriptionEndsWith>
  <PriceSchemeDescriptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PriceSchemeDescriptionIn>
  <PriceSchemeDescriptionLike>String</PriceSchemeDescriptionLike>
  <PriceSchemeDescriptionStartsWith>String</PriceSchemeDescriptionStartsWith>
  <PriceSchemeID>String</PriceSchemeID>
  <PriceSchemeIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PriceSchemeIDBetween>
  <PriceSchemeIDContains>String</PriceSchemeIDContains>
  <PriceSchemeIDEndsWith>String</PriceSchemeIDEndsWith>
  <PriceSchemeIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PriceSchemeIDIn>
  <PriceSchemeIDLike>String</PriceSchemeIDLike>
  <PriceSchemeIDStartsWith>String</PriceSchemeIDStartsWith>
  <SchemeActive>false</SchemeActive>
</IN_PriceSchemesQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfIN_PriceSchemes7kRqkrSv 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:IN_PriceSchemes>
      <d2p1:_x003C_FindTheCheapest_x003E_k__BackingField>false</d2p1:_x003C_FindTheCheapest_x003E_k__BackingField>
      <d2p1:_x003C_IsDefault_x003E_k__BackingField>false</d2p1:_x003C_IsDefault_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_PriceSchemeDescription_x003E_k__BackingField>String</d2p1:_x003C_PriceSchemeDescription_x003E_k__BackingField>
      <d2p1:_x003C_PriceSchemeID_x003E_k__BackingField>String</d2p1:_x003C_PriceSchemeID_x003E_k__BackingField>
      <d2p1:_x003C_SchemeActive_x003E_k__BackingField>false</d2p1:_x003C_SchemeActive_x003E_k__BackingField>
    </d2p1:IN_PriceSchemes>
  </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>
</QueryResponseOfIN_PriceSchemes7kRqkrSv>