JiwaAPI

<back to all web services

SY_LicenceQuery

Requires Authentication
SY_LicenceQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
ResourceIDquerystringNo
ResourceIDStartsWithquerystringNo
ResourceIDEndsWithquerystringNo
ResourceIDContainsquerystringNo
ResourceIDLikequerystringNo
ResourceIDBetweenquerystring[]No
ResourceIDInquerystring[]No
ResourceNamequerystringNo
ResourceNameStartsWithquerystringNo
ResourceNameEndsWithquerystringNo
ResourceNameContainsquerystringNo
ResourceNameLikequerystringNo
ResourceNameBetweenquerystring[]No
ResourceNameInquerystring[]No
IssueDatequeryDateTime?No
IssueDateGreaterThanOrEqualToqueryDateTime?No
IssueDateGreaterThanqueryDateTime?No
IssueDateLessThanqueryDateTime?No
IssueDateLessThanOrEqualToqueryDateTime?No
IssueDateNotEqualToqueryDateTime?No
IssueDateBetweenqueryDateTime[]No
IssueDateInqueryDateTime[]No
ScopequerystringNo
ScopeStartsWithquerystringNo
ScopeEndsWithquerystringNo
ScopeContainsquerystringNo
ScopeLikequerystringNo
ScopeBetweenquerystring[]No
ScopeInquerystring[]No
NotequerystringNo
NoteStartsWithquerystringNo
NoteEndsWithquerystringNo
NoteContainsquerystringNo
NoteLikequerystringNo
NoteBetweenquerystring[]No
NoteInquerystring[]No
CommenceDatequeryDateTime?No
CommenceDateGreaterThanOrEqualToqueryDateTime?No
CommenceDateGreaterThanqueryDateTime?No
CommenceDateLessThanqueryDateTime?No
CommenceDateLessThanOrEqualToqueryDateTime?No
CommenceDateNotEqualToqueryDateTime?No
CommenceDateBetweenqueryDateTime[]No
CommenceDateInqueryDateTime[]No
ExpiryDatequeryDateTime?No
ExpiryDateGreaterThanOrEqualToqueryDateTime?No
ExpiryDateGreaterThanqueryDateTime?No
ExpiryDateLessThanqueryDateTime?No
ExpiryDateLessThanOrEqualToqueryDateTime?No
ExpiryDateNotEqualToqueryDateTime?No
ExpiryDateBetweenqueryDateTime[]No
ExpiryDateInqueryDateTime[]No
CALsqueryint?No
CALsGreaterThanOrEqualToqueryint?No
CALsGreaterThanqueryint?No
CALsLessThanqueryint?No
CALsLessThanOrEqualToqueryint?No
CALsNotEqualToqueryint?No
CALsBetweenqueryint[]No
CALsInqueryint[]No
VersionquerystringNo
VersionStartsWithquerystringNo
VersionEndsWithquerystringNo
VersionContainsquerystringNo
VersionLikequerystringNo
VersionBetweenquerystring[]No
VersionInquerystring[]No
CompanyNamequerystringNo
CompanyNameStartsWithquerystringNo
CompanyNameEndsWithquerystringNo
CompanyNameContainsquerystringNo
CompanyNameLikequerystringNo
CompanyNameBetweenquerystring[]No
CompanyNameInquerystring[]No
SignaturequerystringNo
SignatureStartsWithquerystringNo
SignatureEndsWithquerystringNo
SignatureContainsquerystringNo
SignatureLikequerystringNo
SignatureBetweenquerystring[]No
SignatureInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_Licence Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
ResourceIDformstringNo
ResourceNameformstringNo
IssueDateformDateTimeNo
ScopeformstringNo
NoteformstringNo
CommenceDateformDateTimeNo
ExpiryDateformDateTimeNo
CALsformintNo
VersionformstringNo
CompanyNameformstringNo
SignatureformstringNo
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/SY_LicenceQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SY_LicenceQuery 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>
  <CALs>0</CALs>
  <CALsBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </CALsBetween>
  <CALsGreaterThan>0</CALsGreaterThan>
  <CALsGreaterThanOrEqualTo>0</CALsGreaterThanOrEqualTo>
  <CALsIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </CALsIn>
  <CALsLessThan>0</CALsLessThan>
  <CALsLessThanOrEqualTo>0</CALsLessThanOrEqualTo>
  <CALsNotEqualTo>0</CALsNotEqualTo>
  <CommenceDate>0001-01-01T00:00:00</CommenceDate>
  <CommenceDateBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </CommenceDateBetween>
  <CommenceDateGreaterThan>0001-01-01T00:00:00</CommenceDateGreaterThan>
  <CommenceDateGreaterThanOrEqualTo>0001-01-01T00:00:00</CommenceDateGreaterThanOrEqualTo>
  <CommenceDateIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </CommenceDateIn>
  <CommenceDateLessThan>0001-01-01T00:00:00</CommenceDateLessThan>
  <CommenceDateLessThanOrEqualTo>0001-01-01T00:00:00</CommenceDateLessThanOrEqualTo>
  <CommenceDateNotEqualTo>0001-01-01T00:00:00</CommenceDateNotEqualTo>
  <CompanyName>String</CompanyName>
  <CompanyNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CompanyNameBetween>
  <CompanyNameContains>String</CompanyNameContains>
  <CompanyNameEndsWith>String</CompanyNameEndsWith>
  <CompanyNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CompanyNameIn>
  <CompanyNameLike>String</CompanyNameLike>
  <CompanyNameStartsWith>String</CompanyNameStartsWith>
  <ExpiryDate>0001-01-01T00:00:00</ExpiryDate>
  <ExpiryDateBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </ExpiryDateBetween>
  <ExpiryDateGreaterThan>0001-01-01T00:00:00</ExpiryDateGreaterThan>
  <ExpiryDateGreaterThanOrEqualTo>0001-01-01T00:00:00</ExpiryDateGreaterThanOrEqualTo>
  <ExpiryDateIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </ExpiryDateIn>
  <ExpiryDateLessThan>0001-01-01T00:00:00</ExpiryDateLessThan>
  <ExpiryDateLessThanOrEqualTo>0001-01-01T00:00:00</ExpiryDateLessThanOrEqualTo>
  <ExpiryDateNotEqualTo>0001-01-01T00:00:00</ExpiryDateNotEqualTo>
  <IssueDate>0001-01-01T00:00:00</IssueDate>
  <IssueDateBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </IssueDateBetween>
  <IssueDateGreaterThan>0001-01-01T00:00:00</IssueDateGreaterThan>
  <IssueDateGreaterThanOrEqualTo>0001-01-01T00:00:00</IssueDateGreaterThanOrEqualTo>
  <IssueDateIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </IssueDateIn>
  <IssueDateLessThan>0001-01-01T00:00:00</IssueDateLessThan>
  <IssueDateLessThanOrEqualTo>0001-01-01T00:00:00</IssueDateLessThanOrEqualTo>
  <IssueDateNotEqualTo>0001-01-01T00:00:00</IssueDateNotEqualTo>
  <Note>String</Note>
  <NoteBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NoteBetween>
  <NoteContains>String</NoteContains>
  <NoteEndsWith>String</NoteEndsWith>
  <NoteIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NoteIn>
  <NoteLike>String</NoteLike>
  <NoteStartsWith>String</NoteStartsWith>
  <RecID>String</RecID>
  <RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecIDBetween>
  <RecIDContains>String</RecIDContains>
  <RecIDEndsWith>String</RecIDEndsWith>
  <RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecIDIn>
  <RecIDLike>String</RecIDLike>
  <RecIDStartsWith>String</RecIDStartsWith>
  <ResourceID>String</ResourceID>
  <ResourceIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ResourceIDBetween>
  <ResourceIDContains>String</ResourceIDContains>
  <ResourceIDEndsWith>String</ResourceIDEndsWith>
  <ResourceIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ResourceIDIn>
  <ResourceIDLike>String</ResourceIDLike>
  <ResourceIDStartsWith>String</ResourceIDStartsWith>
  <ResourceName>String</ResourceName>
  <ResourceNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ResourceNameBetween>
  <ResourceNameContains>String</ResourceNameContains>
  <ResourceNameEndsWith>String</ResourceNameEndsWith>
  <ResourceNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ResourceNameIn>
  <ResourceNameLike>String</ResourceNameLike>
  <ResourceNameStartsWith>String</ResourceNameStartsWith>
  <Scope>String</Scope>
  <ScopeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ScopeBetween>
  <ScopeContains>String</ScopeContains>
  <ScopeEndsWith>String</ScopeEndsWith>
  <ScopeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ScopeIn>
  <ScopeLike>String</ScopeLike>
  <ScopeStartsWith>String</ScopeStartsWith>
  <Signature>String</Signature>
  <SignatureBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SignatureBetween>
  <SignatureContains>String</SignatureContains>
  <SignatureEndsWith>String</SignatureEndsWith>
  <SignatureIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SignatureIn>
  <SignatureLike>String</SignatureLike>
  <SignatureStartsWith>String</SignatureStartsWith>
  <Version>String</Version>
  <VersionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </VersionBetween>
  <VersionContains>String</VersionContains>
  <VersionEndsWith>String</VersionEndsWith>
  <VersionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </VersionIn>
  <VersionLike>String</VersionLike>
  <VersionStartsWith>String</VersionStartsWith>
</SY_LicenceQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSY_Licence7kRqkrSv 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:SY_Licence>
      <d2p1:_x003C_CALs_x003E_k__BackingField>0</d2p1:_x003C_CALs_x003E_k__BackingField>
      <d2p1:_x003C_CommenceDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_CommenceDate_x003E_k__BackingField>
      <d2p1:_x003C_CompanyName_x003E_k__BackingField>String</d2p1:_x003C_CompanyName_x003E_k__BackingField>
      <d2p1:_x003C_ExpiryDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_ExpiryDate_x003E_k__BackingField>
      <d2p1:_x003C_IssueDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_IssueDate_x003E_k__BackingField>
      <d2p1:_x003C_Note_x003E_k__BackingField>String</d2p1:_x003C_Note_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField>
      <d2p1:_x003C_ResourceID_x003E_k__BackingField>String</d2p1:_x003C_ResourceID_x003E_k__BackingField>
      <d2p1:_x003C_ResourceName_x003E_k__BackingField>String</d2p1:_x003C_ResourceName_x003E_k__BackingField>
      <d2p1:_x003C_Scope_x003E_k__BackingField>String</d2p1:_x003C_Scope_x003E_k__BackingField>
      <d2p1:_x003C_Signature_x003E_k__BackingField>String</d2p1:_x003C_Signature_x003E_k__BackingField>
      <d2p1:_x003C_Version_x003E_k__BackingField>String</d2p1:_x003C_Version_x003E_k__BackingField>
    </d2p1:SY_Licence>
  </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>
</QueryResponseOfSY_Licence7kRqkrSv>