JiwaAPI

<back to all web services

SY_ReportQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/SY_ReportRetrieves a list of reports.
SY_ReportQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
FileNamequerystringNo
FileNameStartsWithquerystringNo
FileNameEndsWithquerystringNo
FileNameContainsquerystringNo
FileNameLikequerystringNo
FileNameBetweenquerystring[]No
FileNameInquerystring[]No
TitlequerystringNo
TitleStartsWithquerystringNo
TitleEndsWithquerystringNo
TitleContainsquerystringNo
TitleLikequerystringNo
TitleBetweenquerystring[]No
TitleInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
AuthorquerystringNo
AuthorStartsWithquerystringNo
AuthorEndsWithquerystringNo
AuthorContainsquerystringNo
AuthorLikequerystringNo
AuthorBetweenquerystring[]No
AuthorInquerystring[]No
SY_ReportSection_RecIDquerystringNo
SY_ReportSection_RecIDStartsWithquerystringNo
SY_ReportSection_RecIDEndsWithquerystringNo
SY_ReportSection_RecIDContainsquerystringNo
SY_ReportSection_RecIDLikequerystringNo
SY_ReportSection_RecIDBetweenquerystring[]No
SY_ReportSection_RecIDInquerystring[]No
ReportTypequerybyte?No
ReportTypeGreaterThanOrEqualToquerybyte?No
ReportTypeGreaterThanquerybyte?No
ReportTypeLessThanquerybyte?No
ReportTypeLessThanOrEqualToquerybyte?No
ReportTypeNotEqualToquerybyte?No
ReportTypeBetweenquerybyte[]No
ReportTypeInquerybyte[]No
IsEnabledquerybool?No
FileBinaryquerybyte[]No
FileHashquerystringNo
FileHashStartsWithquerystringNo
FileHashEndsWithquerystringNo
FileHashContainsquerystringNo
FileHashLikequerystringNo
FileHashBetweenquerystring[]No
FileHashInquerystring[]No
CommentquerystringNo
CommentStartsWithquerystringNo
CommentEndsWithquerystringNo
CommentContainsquerystringNo
CommentLikequerystringNo
CommentBetweenquerystring[]No
CommentInquerystring[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
RowHashquerybyte[]No
IsReadOnlyquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_Report Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
FileNameformstringNo
TitleformstringNo
DescriptionformstringNo
AuthorformstringNo
SY_ReportSection_RecIDformstringNo
ReportTypeformbyteNo
IsEnabledformboolNo
FileBinaryformbyte[]No
FileHashformstringNo
CommentformstringNo
ItemNoformintNo
LastSavedDateTimeformDateTimeNo
RowHashformbyte[]No
IsReadOnlyformboolNo
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.

GET /Queries/SY_Report HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSY_Report7kRqkrSv 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_Report>
      <d2p1:_x003C_Author_x003E_k__BackingField>String</d2p1:_x003C_Author_x003E_k__BackingField>
      <d2p1:_x003C_Comment_x003E_k__BackingField>String</d2p1:_x003C_Comment_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_FileBinary_x003E_k__BackingField>AA==</d2p1:_x003C_FileBinary_x003E_k__BackingField>
      <d2p1:_x003C_FileHash_x003E_k__BackingField>String</d2p1:_x003C_FileHash_x003E_k__BackingField>
      <d2p1:_x003C_FileName_x003E_k__BackingField>String</d2p1:_x003C_FileName_x003E_k__BackingField>
      <d2p1:_x003C_IsEnabled_x003E_k__BackingField>false</d2p1:_x003C_IsEnabled_x003E_k__BackingField>
      <d2p1:_x003C_IsReadOnly_x003E_k__BackingField>false</d2p1:_x003C_IsReadOnly_x003E_k__BackingField>
      <d2p1:_x003C_ItemNo_x003E_k__BackingField>0</d2p1:_x003C_ItemNo_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField>
      <d2p1:_x003C_ReportType_x003E_k__BackingField>0</d2p1:_x003C_ReportType_x003E_k__BackingField>
      <d2p1:_x003C_RowHash_x003E_k__BackingField>AA==</d2p1:_x003C_RowHash_x003E_k__BackingField>
      <d2p1:_x003C_SY_ReportSection_RecID_x003E_k__BackingField>String</d2p1:_x003C_SY_ReportSection_RecID_x003E_k__BackingField>
      <d2p1:_x003C_Title_x003E_k__BackingField>String</d2p1:_x003C_Title_x003E_k__BackingField>
    </d2p1:SY_Report>
  </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_Report7kRqkrSv>