GET | /api/collections/{CollectionGuid}/usergroups | Retrieve the list of user groups for the selected collection |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CollectionGuid | path | Guid | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
UserGroups | form | List<UserGroup> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Guid | body | Guid | No | |
Name | form | string | No | |
Type | form | string | No | Allowable Values
|
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.
GET /api/collections/{CollectionGuid}/usergroups HTTP/1.1 Host: api.secure-messaging.com Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length { "responseStatus": { "errorCode": "String", "message": "String", "stackTrace": "String", "errors": [ { "errorCode": "String", "fieldName": "String", "message": "String", "meta": { "String": "String" } } ], "meta": { "String": "String" } }, "userGroups": [ { "guid": "00000000000000000000000000000000", "name": "String", "type": "String" } ] }