| GET | /api/users/groups | Query for Coruson User Groups |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserGroupId | query | Guid | No | Filter by the Id of the User Group. |
| Name | query | string | No | Filter by the name of the User Group. |
| Description | query | string | No | Filter by the description of the User Group. |
| IsSystem | query | BooleanFilter | Yes | Filter by User Groups that were either creted by Coruson or by a user.Allowable Values
|
| IsActive | query | BooleanFilter | Yes | Filter by the active status of the User Group. By default, active and archived user groups will be included.Allowable Values
|
| OrderBy | query | UserGroupOrder | Yes | Property to order by in Ascending order. Default is 'Name'.Allowable Values
|
| OrderByDesc | query | UserGroupOrder | Yes | Property to order by in Descending order.Allowable Values
|
| ThenBy | query | UserGroupOrder | Yes | Second Property to order by in Ascending order. NOTE: If this value is the same as either the OrderBy or OrderByDesc values, then it will be ignored.Allowable Values
|
| ThenByDesc | query | UserGroupOrder | Yes | Second Property to order by in Descending order. NOTE: If this value is the same as either the OrderBy or OrderByDesc values, then it will be ignored.Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | Integer | No | Number of items to skip before returning results. Minimum suitable value is 0 and is also the default value. |
| Take | form | Integer | No | Number of items to return per page. Must be a number in the range 1-100. Default value is 100. |
| OrderBy | form | Enum | No | Order By |
| OrderByDesc | form | Enum | No | Order By Descending |
| ThenBy | form | Enum | No | Then By |
| ThenByDesc | form | Enum | No | Then By Descending |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserGroups | form | List<UserGroup> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TotalResults | form | int | No | |
| Skip | form | int | No | |
| Take | form | int | No | |
| Links | form | List<Link> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusDescription | form | string | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| RequestUrl | form | string | No | |
| Method | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserGroupId | form | Guid | No | |
| Name | form | string | No | |
| Description | form | string | No | |
| IsSystem | form | bool | No | |
| IsActive | form | bool | No | |
| Members | form | List<string> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /jsv/reply/GetUserGroups HTTP/1.1
Host: platform.gaelenlighten.com
Content-Type: text/jsv
Content-Length: length
{
UserGroupId: 00000000-0000-0000-0000-000000000000,
Skip: 0,
Version: 0,
Name: String,
Take: 0,
Description: String,
IsSystem: All,
IsActive: All,
OrderBy: Default,
OrderByDesc: Default,
ThenBy: Default,
ThenByDesc: Default
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
UserGroups:
[
{
Name: String,
Description: String,
IsSystem: False,
IsActive: False,
Members:
[
String
]
}
],
TotalResults: 0,
StatusDescription: String,
Skip: 0,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
Take: 0,
Links:
[
{
Name: String,
RequestUrl: String,
Method: String
}
]
}