| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SavedReportRangeID | query | string | No | |
| SavedReportRangeIDStartsWith | query | string | No | |
| SavedReportRangeIDEndsWith | query | string | No | |
| SavedReportRangeIDContains | query | string | No | |
| SavedReportRangeIDLike | query | string | No | |
| SavedReportRangeIDBetween | query | string[] | No | |
| SavedReportRangeIDIn | query | string[] | 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 | |
| StaffID | query | string | No | |
| StaffIDStartsWith | query | string | No | |
| StaffIDEndsWith | query | string | No | |
| StaffIDContains | query | string | No | |
| StaffIDLike | query | string | No | |
| StaffIDBetween | query | string[] | No | |
| StaffIDIn | query | string[] | No | |
| IDKey | query | string | No | |
| IDKeyStartsWith | query | string | No | |
| IDKeyEndsWith | query | string | No | |
| IDKeyContains | query | string | No | |
| IDKeyLike | query | string | No | |
| IDKeyBetween | query | string[] | No | |
| IDKeyIn | 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 | |
| Contents | query | string | No | |
| ContentsStartsWith | query | string | No | |
| ContentsEndsWith | query | string | No | |
| ContentsContains | query | string | No | |
| ContentsLike | query | string | No | |
| ContentsBetween | query | string[] | No | |
| ContentsIn | query | string[] | 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 |
|---|---|---|---|---|
| SavedReportRangeID | form | string | No | |
| LastSavedDateTime | form | DateTime | No | |
| StaffID | form | string | No | |
| IDKey | form | string | No | |
| Description | form | string | No | |
| Contents | form | string | 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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/SY_SavedReportRangesQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"SavedReportRangeID":"String","SavedReportRangeIDStartsWith":"String","SavedReportRangeIDEndsWith":"String","SavedReportRangeIDContains":"String","SavedReportRangeIDLike":"String","SavedReportRangeIDBetween":["String"],"SavedReportRangeIDIn":["String"],"LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"LastSavedDateTimeIn":["0001-01-01T00:00:00.0000000"],"StaffID":"String","StaffIDStartsWith":"String","StaffIDEndsWith":"String","StaffIDContains":"String","StaffIDLike":"String","StaffIDBetween":["String"],"StaffIDIn":["String"],"IDKey":"String","IDKeyStartsWith":"String","IDKeyEndsWith":"String","IDKeyContains":"String","IDKeyLike":"String","IDKeyBetween":["String"],"IDKeyIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"Contents":"String","ContentsStartsWith":"String","ContentsEndsWith":"String","ContentsContains":"String","ContentsLike":"String","ContentsBetween":["String"],"ContentsIn":["String"],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Results":[{"SavedReportRangeID":"String","StaffID":"String","IDKey":"String","Description":"String","Contents":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}