GET | /api/users | Query for Coruson Users |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PersonId | query | Guid | No | Filter by the PersonId. |
Forename | query | String | No | Filter by the forename of the User. |
Surname | query | String | No | Filter by the surname of the User. |
FullName | query | String | No | Filter by the full name of the User. |
Username | query | String | No | Filter by the username of the User. |
EmailAddress | query | String | No | Filter by the email address of the User. |
OrganisationalUnit | query | String | No | Filter by the name of the organisational unit the User(s) belongs to. |
OrganisationalUnitId | query | Guid | No | Filter by the Id of the organisational unit the User(s) belongs to. |
Group | query | String | No | Filter by the User Group the User(s) belongs to. |
PersonType | query | PersonType | Yes | Filter by the type of the User. By default will return Users of all types.Allowable Values
|
IsActive | query | BooleanFilter | Yes | Filter by the User's status.Allowable Values
|
OrderBy | query | UserOrder | Yes | Property to order by in Ascending order. Default is 'FullName'Allowable Values
|
OrderByDesc | query | UserOrder | Yes | Property to order by in Descending order.Allowable Values
|
ThenBy | query | UserOrder | 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 | UserOrder | 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 |
---|---|---|---|---|
Users | form | List<User> | 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 |
---|---|---|---|---|
PersonId | form | Guid | No | |
Forename | form | string | No | |
Surname | form | string | No | |
FullName | form | string | No | |
Username | form | string | No | |
EmailAddress | form | string | No | |
OrganisationalUnit | form | string | No | |
OrganisationalUnitId | form | Guid | No | |
PersonType | form | PersonType | No | |
IsActive | form | bool | No | |
UserGroups | form | List<string> | 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/GetUsers HTTP/1.1
Host: platform.gaelenlighten.com
Content-Type: text/csv
Content-Length: length
{"PersonId":"00000000-0000-0000-0000-000000000000","Skip":0,"Version":0,"Forename":"String","Take":0,"Surname":"String","FullName":"String","Username":"String","EmailAddress":"String","OrganisationalUnit":"String","OrganisationalUnitId":"00000000-0000-0000-0000-000000000000","Group":"String","PersonType":"All","IsActive":"All","OrderBy":"Default","OrderByDesc":"Default","ThenBy":"Default","ThenByDesc":"Default"}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"Users":[{"Forename":"String","Surname":"String","Fullname":"String","Username":"String","EmailAddress":"String","OrganisationalUnit":"String","PersonType":"All","IsActive":false,"UserGroups":["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"}]}