| GET | /users | Find one or more users. | |
|---|---|---|---|
| GET | /users/{UserUuid} | Find a specified user. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserUuid | path | Guid | No | The internal Id of the user making the request |
| ServicePrincipalApiKey | query | Guid | Yes | The Api key that authorizes the caller to complete the request. Contact your eQuip admin. |
| PageSize | query | int | No | Number of users to return. 0 returns all entries. |
| PageNumber | query | int | No | The page number to start retrieving data. 0 returns first page entries. |
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/FindUsers HTTP/1.1
Host: equipstage3.e-isg.com
Content-Type: application/xml
Content-Length: length
<FindUsers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
<PageNumber>0</PageNumber>
<PageSize>0</PageSize>
<ServicePrincipalApiKey>00000000-0000-0000-0000-000000000000</ServicePrincipalApiKey>
<UserUuid>00000000-0000-0000-0000-000000000000</UserUuid>
</FindUsers>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <UserDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel"> <Active>false</Active> <EmailAddress>String</EmailAddress> <LastLoginDate>0001-01-01T00:00:00</LastLoginDate> <PhoneNumber>String</PhoneNumber> <Role>String</Role> <UserFullName>String</UserFullName> <UserID>0</UserID> <UserName>String</UserName> <UserUuid>00000000-0000-0000-0000-000000000000</UserUuid> </UserDto>