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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /xml/reply/GetUsers HTTP/1.1
Host: platform.gaelenlighten.com
Content-Type: application/xml
Content-Length: length
<GetUsers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Version>0</Version>
<Skip>0</Skip>
<Take>0</Take>
<OrderBy>Default</OrderBy>
<OrderByDesc>Default</OrderByDesc>
<ThenBy>Default</ThenBy>
<ThenByDesc>Default</ThenByDesc>
<PersonId>00000000-0000-0000-0000-000000000000</PersonId>
<Forename>String</Forename>
<Surname>String</Surname>
<FullName>String</FullName>
<Username>String</Username>
<EmailAddress>String</EmailAddress>
<OrganisationalUnit>String</OrganisationalUnit>
<OrganisationalUnitId>00000000-0000-0000-0000-000000000000</OrganisationalUnitId>
<Group>String</Group>
<PersonType>All</PersonType>
<IsActive>All</IsActive>
</GetUsers>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <GetUsersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <StatusDescription>String</StatusDescription> <ResponseStatus> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </Meta> </ResponseError> </Errors> <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </Meta> </ResponseStatus> <TotalResults>0</TotalResults> <Skip>0</Skip> <Take>0</Take> <Links> <Link> <Name>String</Name> <RequestUrl>String</RequestUrl> <Method>String</Method> </Link> </Links> <Users> <User> <PersonId>00000000-0000-0000-0000-000000000000</PersonId> <Forename>String</Forename> <Surname>String</Surname> <Fullname>String</Fullname> <Username>String</Username> <EmailAddress>String</EmailAddress> <OrganisationalUnit>String</OrganisationalUnit> <OrganisationalUnitId>00000000-0000-0000-0000-000000000000</OrganisationalUnitId> <PersonType>All</PersonType> <IsActive>false</IsActive> <UserGroups xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>String</d4p1:string> </UserGroups> </User> </Users> </GetUsersResponse>