| 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 | |
| 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 | |
| ControlType | query | string | No | |
| ControlTypeStartsWith | query | string | No | |
| ControlTypeEndsWith | query | string | No | |
| ControlTypeContains | query | string | No | |
| ControlTypeLike | query | string | No | |
| ControlTypeBetween | query | string[] | No | |
| ControlTypeIn | query | string[] | No | |
| ControlName | query | string | No | |
| ControlNameStartsWith | query | string | No | |
| ControlNameEndsWith | query | string | No | |
| ControlNameContains | query | string | No | |
| ControlNameLike | query | string | No | |
| ControlNameBetween | query | string[] | No | |
| ControlNameIn | query | string[] | No | |
| ReadAccessLevel | query | byte? | No | |
| ReadAccessLevelGreaterThanOrEqualTo | query | byte? | No | |
| ReadAccessLevelGreaterThan | query | byte? | No | |
| ReadAccessLevelLessThan | query | byte? | No | |
| ReadAccessLevelLessThanOrEqualTo | query | byte? | No | |
| ReadAccessLevelNotEqualTo | query | byte? | No | |
| ReadAccessLevelBetween | query | byte[] | No | |
| ReadAccessLevelIn | query | byte[] | No | |
| WriteAccessLevel | query | byte? | No | |
| WriteAccessLevelGreaterThanOrEqualTo | query | byte? | No | |
| WriteAccessLevelGreaterThan | query | byte? | No | |
| WriteAccessLevelLessThan | query | byte? | No | |
| WriteAccessLevelLessThanOrEqualTo | query | byte? | No | |
| WriteAccessLevelNotEqualTo | query | byte? | No | |
| WriteAccessLevelBetween | query | byte[] | No | |
| WriteAccessLevelIn | 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 | |
| SY_Forms_ClassName | form | string | No | |
| ControlType | form | string | No | |
| ControlName | form | string | No | |
| ReadAccessLevel | form | byte | No | |
| WriteAccessLevel | 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/SY_UserGroupPermissionsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"RecID":"00000000000000000000000000000000","RecIDIn":["00000000-0000-0000-0000-000000000000"],"SY_UserGroups_RecID":"00000000000000000000000000000000","SY_UserGroups_RecIDIn":["00000000-0000-0000-0000-000000000000"],"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"],"ControlType":"String","ControlTypeStartsWith":"String","ControlTypeEndsWith":"String","ControlTypeContains":"String","ControlTypeLike":"String","ControlTypeBetween":["String"],"ControlTypeIn":["String"],"ControlName":"String","ControlNameStartsWith":"String","ControlNameEndsWith":"String","ControlNameContains":"String","ControlNameLike":"String","ControlNameBetween":["String"],"ControlNameIn":["String"],"ReadAccessLevel":0,"ReadAccessLevelGreaterThanOrEqualTo":0,"ReadAccessLevelGreaterThan":0,"ReadAccessLevelLessThan":0,"ReadAccessLevelLessThanOrEqualTo":0,"ReadAccessLevelNotEqualTo":0,"ReadAccessLevelBetween":"AA==","ReadAccessLevelIn":"AA==","WriteAccessLevel":0,"WriteAccessLevelGreaterThanOrEqualTo":0,"WriteAccessLevelGreaterThan":0,"WriteAccessLevelLessThan":0,"WriteAccessLevelLessThanOrEqualTo":0,"WriteAccessLevelNotEqualTo":0,"WriteAccessLevelBetween":"AA==","WriteAccessLevelIn":"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: application/json
Content-Length: length
{"Results":[{"SY_Forms_ClassName":"String","ControlType":"String","ControlName":"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"}}}