| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | query | Guid? | No | |
| RecIDIn | query | Guid[] | No | |
| SY_UserGroups_RecID | query | Guid? | No | |
| SY_UserGroups_RecIDIn | query | Guid[] | No | |
| RESTPath | query | string | No | |
| RESTPathStartsWith | query | string | No | |
| RESTPathEndsWith | query | string | No | |
| RESTPathContains | query | string | No | |
| RESTPathLike | query | string | No | |
| RESTPathBetween | query | string[] | No | |
| RESTPathIn | query | string[] | No | |
| Verb | query | string | No | |
| VerbStartsWith | query | string | No | |
| VerbEndsWith | query | string | No | |
| VerbContains | query | string | No | |
| VerbLike | query | string | No | |
| VerbBetween | query | string[] | No | |
| VerbIn | query | string[] | No | |
| Summary | query | string | No | |
| SummaryStartsWith | query | string | No | |
| SummaryEndsWith | query | string | No | |
| SummaryContains | query | string | No | |
| SummaryLike | query | string | No | |
| SummaryBetween | query | string[] | No | |
| SummaryIn | query | string[] | No | |
| AccessLevel | query | byte? | No | |
| AccessLevelGreaterThanOrEqualTo | query | byte? | No | |
| AccessLevelGreaterThan | query | byte? | No | |
| AccessLevelLessThan | query | byte? | No | |
| AccessLevelLessThanOrEqualTo | query | byte? | No | |
| AccessLevelNotEqualTo | query | byte? | No | |
| AccessLevelBetween | query | byte[] | No | |
| AccessLevelIn | query | byte[] | 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 |
| 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 | |
| SY_UserGroups_RecID | form | Guid | No | |
| RESTPath | form | string | No | |
| Verb | form | string | No | |
| Summary | form | string | No | |
| AccessLevel | form | byte | No | |
| ItemNo | form | int | 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_UserGroupRESTAPIPermissionsQuery 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"],"SY_UserGroups_RecID":"00000000000000000000000000000000","SY_UserGroups_RecIDIn":["00000000-0000-0000-0000-000000000000"],"RESTPath":"String","RESTPathStartsWith":"String","RESTPathEndsWith":"String","RESTPathContains":"String","RESTPathLike":"String","RESTPathBetween":["String"],"RESTPathIn":["String"],"Verb":"String","VerbStartsWith":"String","VerbEndsWith":"String","VerbContains":"String","VerbLike":"String","VerbBetween":["String"],"VerbIn":["String"],"Summary":"String","SummaryStartsWith":"String","SummaryEndsWith":"String","SummaryContains":"String","SummaryLike":"String","SummaryBetween":["String"],"SummaryIn":["String"],"AccessLevel":0,"AccessLevelGreaterThanOrEqualTo":0,"AccessLevelGreaterThan":0,"AccessLevelLessThan":0,"AccessLevelLessThanOrEqualTo":0,"AccessLevelNotEqualTo":0,"AccessLevelBetween":"AA==","AccessLevelIn":"AA==","ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"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":[{"RESTPath":"String","Verb":"String","Summary":"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"}}}