GET | /Queries/SY_Report | Retrieves a list of reports. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RecID | query | string | No | |
RecIDStartsWith | query | string | No | |
RecIDEndsWith | query | string | No | |
RecIDContains | query | string | No | |
RecIDLike | query | string | No | |
RecIDBetween | query | string[] | No | |
RecIDIn | query | string[] | No | |
FileName | query | string | No | |
FileNameStartsWith | query | string | No | |
FileNameEndsWith | query | string | No | |
FileNameContains | query | string | No | |
FileNameLike | query | string | No | |
FileNameBetween | query | string[] | No | |
FileNameIn | query | string[] | No | |
Title | query | string | No | |
TitleStartsWith | query | string | No | |
TitleEndsWith | query | string | No | |
TitleContains | query | string | No | |
TitleLike | query | string | No | |
TitleBetween | query | string[] | No | |
TitleIn | query | string[] | No | |
Description | query | string | No | |
DescriptionStartsWith | query | string | No | |
DescriptionEndsWith | query | string | No | |
DescriptionContains | query | string | No | |
DescriptionLike | query | string | No | |
DescriptionBetween | query | string[] | No | |
DescriptionIn | query | string[] | No | |
Author | query | string | No | |
AuthorStartsWith | query | string | No | |
AuthorEndsWith | query | string | No | |
AuthorContains | query | string | No | |
AuthorLike | query | string | No | |
AuthorBetween | query | string[] | No | |
AuthorIn | query | string[] | No | |
SY_ReportSection_RecID | query | string | No | |
SY_ReportSection_RecIDStartsWith | query | string | No | |
SY_ReportSection_RecIDEndsWith | query | string | No | |
SY_ReportSection_RecIDContains | query | string | No | |
SY_ReportSection_RecIDLike | query | string | No | |
SY_ReportSection_RecIDBetween | query | string[] | No | |
SY_ReportSection_RecIDIn | query | string[] | No | |
ReportType | query | byte? | No | |
ReportTypeGreaterThanOrEqualTo | query | byte? | No | |
ReportTypeGreaterThan | query | byte? | No | |
ReportTypeLessThan | query | byte? | No | |
ReportTypeLessThanOrEqualTo | query | byte? | No | |
ReportTypeNotEqualTo | query | byte? | No | |
ReportTypeBetween | query | byte[] | No | |
ReportTypeIn | query | byte[] | No | |
IsEnabled | query | bool? | No | |
FileBinary | query | byte[] | No | |
FileHash | query | string | No | |
FileHashStartsWith | query | string | No | |
FileHashEndsWith | query | string | No | |
FileHashContains | query | string | No | |
FileHashLike | query | string | No | |
FileHashBetween | query | string[] | No | |
FileHashIn | query | string[] | No | |
Comment | query | string | No | |
CommentStartsWith | query | string | No | |
CommentEndsWith | query | string | No | |
CommentContains | query | string | No | |
CommentLike | query | string | No | |
CommentBetween | query | string[] | No | |
CommentIn | query | string[] | No | |
ItemNo | query | int? | No | |
ItemNoGreaterThanOrEqualTo | query | int? | No | |
ItemNoGreaterThan | query | int? | No | |
ItemNoLessThan | query | int? | No | |
ItemNoLessThanOrEqualTo | query | int? | No | |
ItemNoNotEqualTo | query | int? | No | |
ItemNoBetween | query | int[] | No | |
ItemNoIn | query | int[] | No | |
LastSavedDateTime | query | DateTime? | No | |
LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeGreaterThan | query | DateTime? | No | |
LastSavedDateTimeLessThan | query | DateTime? | No | |
LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
LastSavedDateTimeBetween | query | DateTime[] | No | |
LastSavedDateTimeIn | query | DateTime[] | No | |
RowHash | query | byte[] | No | |
IsReadOnly | query | bool? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RecID | form | string | No | |
FileName | form | string | No | |
Title | form | string | No | |
Description | form | string | No | |
Author | form | string | No | |
SY_ReportSection_RecID | form | string | No | |
ReportType | form | byte | No | |
IsEnabled | form | bool | No | |
FileBinary | form | byte[] | No | |
FileHash | form | string | No | |
Comment | form | string | No | |
ItemNo | form | int | No | |
LastSavedDateTime | form | DateTime | No | |
RowHash | form | byte[] | No | |
IsReadOnly | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>