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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"RecID":"String","FileName":"String","Title":"String","Description":"String","Author":"String","SY_ReportSection_RecID":"String","FileBinary":"AA==","FileHash":"String","Comment":"String","RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}