| 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 | |
| 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 | |
| SY_Report_RecID | query | string | No | |
| SY_Report_RecIDStartsWith | query | string | No | |
| SY_Report_RecIDEndsWith | query | string | No | |
| SY_Report_RecIDContains | query | string | No | |
| SY_Report_RecIDLike | query | string | No | |
| SY_Report_RecIDBetween | query | string[] | No | |
| SY_Report_RecIDIn | query | string[] | No | |
| SY_PrintGroupLogicalPrinter_RecID | query | string | No | |
| SY_PrintGroupLogicalPrinter_RecIDStartsWith | query | string | No | |
| SY_PrintGroupLogicalPrinter_RecIDEndsWith | query | string | No | |
| SY_PrintGroupLogicalPrinter_RecIDContains | query | string | No | |
| SY_PrintGroupLogicalPrinter_RecIDLike | query | string | No | |
| SY_PrintGroupLogicalPrinter_RecIDBetween | query | string[] | No | |
| SY_PrintGroupLogicalPrinter_RecIDIn | query | string[] | No | |
| SY_Forms_ClassName | query | string | No | |
| SY_Forms_ClassNameStartsWith | query | string | No | |
| SY_Forms_ClassNameEndsWith | query | string | No | |
| SY_Forms_ClassNameContains | query | string | No | |
| SY_Forms_ClassNameLike | query | string | No | |
| SY_Forms_ClassNameBetween | query | string[] | No | |
| SY_Forms_ClassNameIn | query | string[] | No | |
| SY_PrintGroup_RecID | query | string | No | |
| SY_PrintGroup_RecIDStartsWith | query | string | No | |
| SY_PrintGroup_RecIDEndsWith | query | string | No | |
| SY_PrintGroup_RecIDContains | query | string | No | |
| SY_PrintGroup_RecIDLike | query | string | No | |
| SY_PrintGroup_RecIDBetween | query | string[] | No | |
| SY_PrintGroup_RecIDIn | 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 | |
| RowHash | query | byte[] | 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 | |
| IsDefault | 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 | |
| Description | form | string | No | |
| SY_Report_RecID | form | string | No | |
| SY_PrintGroupLogicalPrinter_RecID | form | string | No | |
| SY_Forms_ClassName | form | string | No | |
| SY_PrintGroup_RecID | form | string | No | |
| ItemNo | form | int | No | |
| RowHash | form | byte[] | No | |
| LastSavedDateTime | form | DateTime | No | |
| IsDefault | 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 .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_FormReportDefinitionQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"SY_Report_RecID":"String","SY_Report_RecIDStartsWith":"String","SY_Report_RecIDEndsWith":"String","SY_Report_RecIDContains":"String","SY_Report_RecIDLike":"String","SY_Report_RecIDBetween":["String"],"SY_Report_RecIDIn":["String"],"SY_PrintGroupLogicalPrinter_RecID":"String","SY_PrintGroupLogicalPrinter_RecIDStartsWith":"String","SY_PrintGroupLogicalPrinter_RecIDEndsWith":"String","SY_PrintGroupLogicalPrinter_RecIDContains":"String","SY_PrintGroupLogicalPrinter_RecIDLike":"String","SY_PrintGroupLogicalPrinter_RecIDBetween":["String"],"SY_PrintGroupLogicalPrinter_RecIDIn":["String"],"SY_Forms_ClassName":"String","SY_Forms_ClassNameStartsWith":"String","SY_Forms_ClassNameEndsWith":"String","SY_Forms_ClassNameContains":"String","SY_Forms_ClassNameLike":"String","SY_Forms_ClassNameBetween":["String"],"SY_Forms_ClassNameIn":["String"],"SY_PrintGroup_RecID":"String","SY_PrintGroup_RecIDStartsWith":"String","SY_PrintGroup_RecIDEndsWith":"String","SY_PrintGroup_RecIDContains":"String","SY_PrintGroup_RecIDLike":"String","SY_PrintGroup_RecIDBetween":["String"],"SY_PrintGroup_RecIDIn":["String"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"RowHash":"AA==","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"],"IsDefault":false,"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":[{"RecID":"String","Description":"String","SY_Report_RecID":"String","SY_PrintGroupLogicalPrinter_RecID":"String","SY_Forms_ClassName":"String","SY_PrintGroup_RecID":"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"}}}