eQuipAPI

<back to all web services

FindUsers

Find one or more users.

The following routes are available for this service:
GET/usersFind one or more users.
GET/users/{UserUuid}Find a specified user.
FindUsers Parameters:
NameParameterData TypeRequiredDescription
UserUuidpathGuidNoThe internal Id of the user making the request
ServicePrincipalApiKeyqueryGuidYesThe Api key that authorizes the caller to complete the request. Contact your eQuip admin.
PageSizequeryintNoNumber of users to return. 0 returns all entries.
PageNumberqueryintNoThe 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 .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/FindUsers HTTP/1.1 
Host: equipstage2.e-isg.com 
Content-Type: text/jsv
Content-Length: length

{
	UserUuid: 00000000000000000000000000000000,
	PageSize: 0,
	PageNumber: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	UserID: 0,
	UserName: String,
	UserFullName: String,
	Active: False,
	EmailAddress: String,
	PhoneNumber: String,
	Role: String,
	LastLoginDate: 0001-01-01
}