| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | query | Guid? | No | |
| RecIDIn | query | Guid[] | No | |
| Name | query | string | No | |
| NameStartsWith | query | string | No | |
| NameEndsWith | query | string | No | |
| NameContains | query | string | No | |
| NameLike | query | string | No | |
| NameBetween | query | string[] | No | |
| NameIn | 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 | |
| RowHash | query | byte[] | No | |
| IsDefault | query | bool? | No | |
| IsEnabled | query | bool? | No | |
| IsReadOnly | query | bool? | No | |
| DefaultReadAccessLevel | query | byte? | No | |
| DefaultReadAccessLevelGreaterThanOrEqualTo | query | byte? | No | |
| DefaultReadAccessLevelGreaterThan | query | byte? | No | |
| DefaultReadAccessLevelLessThan | query | byte? | No | |
| DefaultReadAccessLevelLessThanOrEqualTo | query | byte? | No | |
| DefaultReadAccessLevelNotEqualTo | query | byte? | No | |
| DefaultReadAccessLevelBetween | query | byte[] | No | |
| DefaultReadAccessLevelIn | query | byte[] | No | |
| DefaultWriteAccessLevel | query | byte? | No | |
| DefaultWriteAccessLevelGreaterThanOrEqualTo | query | byte? | No | |
| DefaultWriteAccessLevelGreaterThan | query | byte? | No | |
| DefaultWriteAccessLevelLessThan | query | byte? | No | |
| DefaultWriteAccessLevelLessThanOrEqualTo | query | byte? | No | |
| DefaultWriteAccessLevelNotEqualTo | query | byte? | No | |
| DefaultWriteAccessLevelBetween | query | byte[] | No | |
| DefaultWriteAccessLevelIn | query | byte[] | No | |
| DefaultAbstractAccessLevel | query | byte? | No | |
| DefaultAbstractAccessLevelGreaterThanOrEqualTo | query | byte? | No | |
| DefaultAbstractAccessLevelGreaterThan | query | byte? | No | |
| DefaultAbstractAccessLevelLessThan | query | byte? | No | |
| DefaultAbstractAccessLevelLessThanOrEqualTo | query | byte? | No | |
| DefaultAbstractAccessLevelNotEqualTo | query | byte? | No | |
| DefaultAbstractAccessLevelBetween | query | byte[] | No | |
| DefaultAbstractAccessLevelIn | query | byte[] | No | |
| SY_Menu_RecID | query | string | No | |
| SY_Menu_RecIDStartsWith | query | string | No | |
| SY_Menu_RecIDEndsWith | query | string | No | |
| SY_Menu_RecIDContains | query | string | No | |
| SY_Menu_RecIDLike | query | string | No | |
| SY_Menu_RecIDBetween | query | string[] | No | |
| SY_Menu_RecIDIn | query | string[] | No | |
| DefaultRESTAPIAccessLevel | query | byte? | No | |
| DefaultRESTAPIAccessLevelGreaterThanOrEqualTo | query | byte? | No | |
| DefaultRESTAPIAccessLevelGreaterThan | query | byte? | No | |
| DefaultRESTAPIAccessLevelLessThan | query | byte? | No | |
| DefaultRESTAPIAccessLevelLessThanOrEqualTo | query | byte? | No | |
| DefaultRESTAPIAccessLevelNotEqualTo | query | byte? | No | |
| DefaultRESTAPIAccessLevelBetween | query | byte[] | No | |
| DefaultRESTAPIAccessLevelIn | 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 | |
| Name | form | string | No | |
| Description | form | string | No | |
| RowHash | form | byte[] | No | |
| IsDefault | form | bool | No | |
| IsEnabled | form | bool | No | |
| IsReadOnly | form | bool | No | |
| DefaultReadAccessLevel | form | byte | No | |
| DefaultWriteAccessLevel | form | byte | No | |
| DefaultAbstractAccessLevel | form | byte | No | |
| SY_Menu_RecID | form | string | No | |
| DefaultRESTAPIAccessLevel | 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_UserGroupsQuery 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"],"Name":"String","NameStartsWith":"String","NameEndsWith":"String","NameContains":"String","NameLike":"String","NameBetween":["String"],"NameIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"RowHash":"AA==","IsDefault":false,"IsEnabled":false,"IsReadOnly":false,"DefaultReadAccessLevel":0,"DefaultReadAccessLevelGreaterThanOrEqualTo":0,"DefaultReadAccessLevelGreaterThan":0,"DefaultReadAccessLevelLessThan":0,"DefaultReadAccessLevelLessThanOrEqualTo":0,"DefaultReadAccessLevelNotEqualTo":0,"DefaultReadAccessLevelBetween":"AA==","DefaultReadAccessLevelIn":"AA==","DefaultWriteAccessLevel":0,"DefaultWriteAccessLevelGreaterThanOrEqualTo":0,"DefaultWriteAccessLevelGreaterThan":0,"DefaultWriteAccessLevelLessThan":0,"DefaultWriteAccessLevelLessThanOrEqualTo":0,"DefaultWriteAccessLevelNotEqualTo":0,"DefaultWriteAccessLevelBetween":"AA==","DefaultWriteAccessLevelIn":"AA==","DefaultAbstractAccessLevel":0,"DefaultAbstractAccessLevelGreaterThanOrEqualTo":0,"DefaultAbstractAccessLevelGreaterThan":0,"DefaultAbstractAccessLevelLessThan":0,"DefaultAbstractAccessLevelLessThanOrEqualTo":0,"DefaultAbstractAccessLevelNotEqualTo":0,"DefaultAbstractAccessLevelBetween":"AA==","DefaultAbstractAccessLevelIn":"AA==","SY_Menu_RecID":"String","SY_Menu_RecIDStartsWith":"String","SY_Menu_RecIDEndsWith":"String","SY_Menu_RecIDContains":"String","SY_Menu_RecIDLike":"String","SY_Menu_RecIDBetween":["String"],"SY_Menu_RecIDIn":["String"],"DefaultRESTAPIAccessLevel":0,"DefaultRESTAPIAccessLevelGreaterThanOrEqualTo":0,"DefaultRESTAPIAccessLevelGreaterThan":0,"DefaultRESTAPIAccessLevelLessThan":0,"DefaultRESTAPIAccessLevelLessThanOrEqualTo":0,"DefaultRESTAPIAccessLevelNotEqualTo":0,"DefaultRESTAPIAccessLevelBetween":"AA==","DefaultRESTAPIAccessLevelIn":"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":[{"Name":"String","Description":"String","RowHash":"AA==","SY_Menu_RecID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}