| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | query | Guid? | No | |
| RecIDIn | query | Guid[] | 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_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 | |
| HostTabControlName | query | string | No | |
| HostTabControlNameStartsWith | query | string | No | |
| HostTabControlNameEndsWith | query | string | No | |
| HostTabControlNameContains | query | string | No | |
| HostTabControlNameLike | query | string | No | |
| HostTabControlNameBetween | query | string[] | No | |
| HostTabControlNameIn | query | string[] | No | |
| TabKey | query | string | No | |
| TabKeyStartsWith | query | string | No | |
| TabKeyEndsWith | query | string | No | |
| TabKeyContains | query | string | No | |
| TabKeyLike | query | string | No | |
| TabKeyBetween | query | string[] | No | |
| TabKeyIn | query | string[] | No | |
| TabCaption | query | string | No | |
| TabCaptionStartsWith | query | string | No | |
| TabCaptionEndsWith | query | string | No | |
| TabCaptionContains | query | string | No | |
| TabCaptionLike | query | string | No | |
| TabCaptionBetween | query | string[] | No | |
| TabCaptionIn | query | string[] | No | |
| StoredProcedureName | query | string | No | |
| StoredProcedureNameStartsWith | query | string | No | |
| StoredProcedureNameEndsWith | query | string | No | |
| StoredProcedureNameContains | query | string | No | |
| StoredProcedureNameLike | query | string | No | |
| StoredProcedureNameBetween | query | string[] | No | |
| StoredProcedureNameIn | query | string[] | No | |
| IsEnabled | query | bool? | No | |
| RowHash | query | byte[] | 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 | Guid | No | |
| Description | form | string | No | |
| SY_Forms_ClassName | form | string | No | |
| HostTabControlName | form | string | No | |
| TabKey | form | string | No | |
| TabCaption | form | string | No | |
| StoredProcedureName | form | string | No | |
| IsEnabled | form | bool | No | |
| RowHash | form | byte[] | 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_Custom_MaintenanceForm_TabsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"RecID":"00000000000000000000000000000000","RecIDIn":["00000000-0000-0000-0000-000000000000"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["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"],"HostTabControlName":"String","HostTabControlNameStartsWith":"String","HostTabControlNameEndsWith":"String","HostTabControlNameContains":"String","HostTabControlNameLike":"String","HostTabControlNameBetween":["String"],"HostTabControlNameIn":["String"],"TabKey":"String","TabKeyStartsWith":"String","TabKeyEndsWith":"String","TabKeyContains":"String","TabKeyLike":"String","TabKeyBetween":["String"],"TabKeyIn":["String"],"TabCaption":"String","TabCaptionStartsWith":"String","TabCaptionEndsWith":"String","TabCaptionContains":"String","TabCaptionLike":"String","TabCaptionBetween":["String"],"TabCaptionIn":["String"],"StoredProcedureName":"String","StoredProcedureNameStartsWith":"String","StoredProcedureNameEndsWith":"String","StoredProcedureNameContains":"String","StoredProcedureNameLike":"String","StoredProcedureNameBetween":["String"],"StoredProcedureNameIn":["String"],"IsEnabled":false,"RowHash":"AA==","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":[{"Description":"String","SY_Forms_ClassName":"String","HostTabControlName":"String","TabKey":"String","TabCaption":"String","StoredProcedureName":"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"}}}