JiwaAPI

<back to all web services

RA_DocumentsQuery

Requires Authentication
RA_DocumentsQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
FileIDquerystringNo
FileIDStartsWithquerystringNo
FileIDEndsWithquerystringNo
FileIDContainsquerystringNo
FileIDLikequerystringNo
FileIDBetweenquerystring[]No
FileIDInquerystring[]No
ParentIDquerystringNo
ParentIDStartsWithquerystringNo
ParentIDEndsWithquerystringNo
ParentIDContainsquerystringNo
ParentIDLikequerystringNo
ParentIDBetweenquerystring[]No
ParentIDInquerystring[]No
RemarkquerystringNo
RemarkStartsWithquerystringNo
RemarkEndsWithquerystringNo
RemarkContainsquerystringNo
RemarkLikequerystringNo
RemarkBetweenquerystring[]No
RemarkInquerystring[]No
UserNamequerystringNo
UserNameStartsWithquerystringNo
UserNameEndsWithquerystringNo
UserNameContainsquerystringNo
UserNameLikequerystringNo
UserNameBetweenquerystring[]No
UserNameInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
DocTypeIDquerystringNo
DocTypeIDStartsWithquerystringNo
DocTypeIDEndsWithquerystringNo
DocTypeIDContainsquerystringNo
DocTypeIDLikequerystringNo
DocTypeIDBetweenquerystring[]No
DocTypeIDInquerystring[]No
ParentTypequeryshort?No
ParentTypeGreaterThanOrEqualToqueryshort?No
ParentTypeGreaterThanqueryshort?No
ParentTypeLessThanqueryshort?No
ParentTypeLessThanOrEqualToqueryshort?No
ParentTypeNotEqualToqueryshort?No
ParentTypeBetweenqueryshort[]No
ParentTypeInqueryshort[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
RA_Documents Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
FileIDformstringNo
ParentIDformstringNo
RemarkformstringNo
UserNameformstringNo
LastSavedDateTimeformDateTime?No
DocTypeIDformstringNo
ParentTypeformshortNo
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/RA_DocumentsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RA_DocumentsQuery 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>
  <DocTypeID>String</DocTypeID>
  <DocTypeIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DocTypeIDBetween>
  <DocTypeIDContains>String</DocTypeIDContains>
  <DocTypeIDEndsWith>String</DocTypeIDEndsWith>
  <DocTypeIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DocTypeIDIn>
  <DocTypeIDLike>String</DocTypeIDLike>
  <DocTypeIDStartsWith>String</DocTypeIDStartsWith>
  <FileID>String</FileID>
  <FileIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FileIDBetween>
  <FileIDContains>String</FileIDContains>
  <FileIDEndsWith>String</FileIDEndsWith>
  <FileIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FileIDIn>
  <FileIDLike>String</FileIDLike>
  <FileIDStartsWith>String</FileIDStartsWith>
  <LastSavedDateTime>0001-01-01T00:00:00</LastSavedDateTime>
  <LastSavedDateTimeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <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.datacontract.org/2004/07/System">
    <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>
  <ParentID>String</ParentID>
  <ParentIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ParentIDBetween>
  <ParentIDContains>String</ParentIDContains>
  <ParentIDEndsWith>String</ParentIDEndsWith>
  <ParentIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ParentIDIn>
  <ParentIDLike>String</ParentIDLike>
  <ParentIDStartsWith>String</ParentIDStartsWith>
  <ParentType>0</ParentType>
  <ParentTypeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:short>0</d2p1:short>
  </ParentTypeBetween>
  <ParentTypeGreaterThan>0</ParentTypeGreaterThan>
  <ParentTypeGreaterThanOrEqualTo>0</ParentTypeGreaterThanOrEqualTo>
  <ParentTypeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:short>0</d2p1:short>
  </ParentTypeIn>
  <ParentTypeLessThan>0</ParentTypeLessThan>
  <ParentTypeLessThanOrEqualTo>0</ParentTypeLessThanOrEqualTo>
  <ParentTypeNotEqualTo>0</ParentTypeNotEqualTo>
  <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>
  <Remark>String</Remark>
  <RemarkBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RemarkBetween>
  <RemarkContains>String</RemarkContains>
  <RemarkEndsWith>String</RemarkEndsWith>
  <RemarkIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RemarkIn>
  <RemarkLike>String</RemarkLike>
  <RemarkStartsWith>String</RemarkStartsWith>
  <UserName>String</UserName>
  <UserNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserNameBetween>
  <UserNameContains>String</UserNameContains>
  <UserNameEndsWith>String</UserNameEndsWith>
  <UserNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserNameIn>
  <UserNameLike>String</UserNameLike>
  <UserNameStartsWith>String</UserNameStartsWith>
</RA_DocumentsQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfRA_Documents7kRqkrSv 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:RA_Documents>
      <d2p1:_x003C_DocTypeID_x003E_k__BackingField>String</d2p1:_x003C_DocTypeID_x003E_k__BackingField>
      <d2p1:_x003C_FileID_x003E_k__BackingField>String</d2p1:_x003C_FileID_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_ParentID_x003E_k__BackingField>String</d2p1:_x003C_ParentID_x003E_k__BackingField>
      <d2p1:_x003C_ParentType_x003E_k__BackingField>0</d2p1:_x003C_ParentType_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField>
      <d2p1:_x003C_Remark_x003E_k__BackingField>String</d2p1:_x003C_Remark_x003E_k__BackingField>
      <d2p1:_x003C_UserName_x003E_k__BackingField>String</d2p1:_x003C_UserName_x003E_k__BackingField>
    </d2p1:RA_Documents>
  </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>
</QueryResponseOfRA_Documents7kRqkrSv>