Management API

Base Resource URL:

     https://[server-name]/api/v01/users

Description:

Provides access to users registered in the system

Available sub-resources:

Resource URL Description
https://[server-name]/api/v01/users/[user-name]    User name of a user, on which action is required.

Supported Actions:

find  
Method:  GET       Implicit:  Yes       Returns:  User[] *      
Consumes:  query  Produces:  json, xml 
 
Returns list of available users based on specified search conditions.

Parameters:
# Name Type Required Default Description
01 offset Integer No 0 Index of the first record returned to the customer from the search result of a web search.
02 limit Integer No 20 Maximum number of records to load per single search web call made by the customer.
03 createDate DateRange No Query parameter to search users by their provider creation date. All merchants created within the date range defined will be included.

Represents a date range with lower and upper limits. Range can include only lower or only upper limit.
04 userName String(255) No Query parameter to search users by full or partial name (soundex on full name is supported as well)
05 name String(255) No Query parameter to search users by full name.
06 code Integer No Query parameter to search users by code.
07 id Integer No Query parameter to search users by id.
08 active Boolean No Query parameter to search users by activity status.

Response Codes: view