JiwaAPI

<back to all web services

SY_UserGroupRESTAPIPermissionsQuery

Requires Authentication
SY_UserGroupRESTAPIPermissionsQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDqueryGuid?No
RecIDInqueryGuid[]No
SY_UserGroups_RecIDqueryGuid?No
SY_UserGroups_RecIDInqueryGuid[]No
RESTPathquerystringNo
RESTPathStartsWithquerystringNo
RESTPathEndsWithquerystringNo
RESTPathContainsquerystringNo
RESTPathLikequerystringNo
RESTPathBetweenquerystring[]No
RESTPathInquerystring[]No
VerbquerystringNo
VerbStartsWithquerystringNo
VerbEndsWithquerystringNo
VerbContainsquerystringNo
VerbLikequerystringNo
VerbBetweenquerystring[]No
VerbInquerystring[]No
SummaryquerystringNo
SummaryStartsWithquerystringNo
SummaryEndsWithquerystringNo
SummaryContainsquerystringNo
SummaryLikequerystringNo
SummaryBetweenquerystring[]No
SummaryInquerystring[]No
AccessLevelquerybyte?No
AccessLevelGreaterThanOrEqualToquerybyte?No
AccessLevelGreaterThanquerybyte?No
AccessLevelLessThanquerybyte?No
AccessLevelLessThanOrEqualToquerybyte?No
AccessLevelNotEqualToquerybyte?No
AccessLevelBetweenquerybyte[]No
AccessLevelInquerybyte[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
RowHashquerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_UserGroupRESTAPIPermissions Parameters:
NameParameterData TypeRequiredDescription
RecIDformGuidNo
SY_UserGroups_RecIDformGuidNo
RESTPathformstringNo
VerbformstringNo
SummaryformstringNo
AccessLevelformbyteNo
ItemNoformintNo
RowHashformbyte[]No
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + 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"}}}