go back Home

UserService

This service provides operations for retrieving and managing users. This service also contains methods for logging users in and out.

Operations

name description
GET /users Retrieves a List of RowUsers with an ID, name, or email address matching that of given parameter.
GET /users/current Retrieves the currently logged in user.
GET /users/new Creates a user object with all configured defaults set. This doesn't create a record in the database. Instead, callers of this method can edit the returned object and then pass it back to the create method to actually insert the record in the database.
GET /users/search Searches the database for users matching the given request parameters.
GET /users/userSavedSearch Retrieves a List of RowUsers objects based on an existing saved search.
GET /users/{id} Retrieves a user based on the specified ID.
POST /users/changePassword Changes the current user's password.
POST /users/clearPushToken Removes the push token in the database so that push notifications may not be sent.
POST /users/login Logs the user in and returns a token that may be used on subsequent requests for access.
POST /users/loginFromVendor
POST /users/loginWithPIN
POST /users/logout Logs the user out.
POST /users/updatePushToken Updates the push token in the database so that push notifications may be sent at a later time.
PUT /users/create Creates a new RowUsers record for the given data.
PUT /users/update Updates a RowUsers record for the given data.