Retrieve the details of a specific User

GET /seiapi/v3/trans/User/${UserID}

Insert or Update the details of a specific User

PUT /seiapi/v3/trans/User/${UserID}?emailNotification=true

Delete a specific User

DELETE /seiapi/v3/trans/User/${UserID}

Send Password Reset Email to a specific User's Password

    PUT /seiapi/v3/trans/User/${UserID}/

SendResetPasswordEmail

Change Reset a User's Password

PUT /seiapi/v3/trans/User/${UserID}/ChangePassword

Retrieve the Roles associated with a specific User

GET ResetPassword  

Change a User's Password

PUT /seiapi/v3/trans/User/${UserID}/roles

Update the Roles associated with a specific User

POST ChangePassword

Change a User's Storage Location

    PUT /seiapi/v3/trans/User/${UserID}/

Assign Service Teams to a User

ChangeStorageLocation

Retrieve the Roles associated with a specific User

GET /seiapi/v3/trans/User/${UserID}/ServiceTeamsroles

Retrieve the details of Update the Roles associated with a specific User's Entity

GET POST /seiapi/v3/trans/User/${UserID}/Entity

roles

Assign Service Teams to a User

PUT /seiapi/v3/trans/User/${UserID}/Entity

ServiceTeams

Retrieve the details of a specific User's Entity

GET  /seiapi/v3/trans/User/${UserID}/Entity

Change the details of a specific User's Entity

PUT /seiapi/v3/trans/User/${UserID}/Entity

Delegate a specific Entity and Role

POST /saas/v3/Entity/${EntityID}/Roles/${RoleID}/delegate

Impersonate a specific User

POST /seiapi/v3/trans/User/${UserID}/impersonate

Retrieve the details of a specific User

This REST API will return a User with the specified ID. The User with the specified ID must already exist in the system.

URL

HTTP Request Body

This request does not require a request body. 

HTTP Response Body

On success, an HTTP response code of 200 will be returned, and the response body will contain aREST Object Definitions User Related Objects User Object . Otherwise, on error, the response body will contain a descriptive reason for the error. 

Insert or Update the details of a specific User

This REST API will insert a new User with the specified ID into the system, if a User with the specified ID does not already exist in the system.

If, however, the User with the specified ID does already exist in the system, then this REST API will update (i.e. replace) the already existing User with the specified ID with the details of the User supplied in the HTTP Request Body.

URL

HTTP Request Body

The HTTP request body must contain a valid REST Object Definitions User Related Objects User Object.

HTTP Response

On success the API will return a response code of 200.

Delete a specific User

URL

HTTP Request Body

This request does not require a request body. 

HTTP Response

On success an HTTP response code of 200 will be returned. The system will return HTTP response code 410 in case of non-existent REST Object Definitions User Related Objects User Object .

Reset a User's Password

This REST API will automatically generate a new password and email it to the user. 

URL

HTTP Request Body

HTTP Request Body

This request does not require a request body. 

HTTP Response

On success an HTTP response code of 200 will be returned.

Change a User's

Storage Location

This REST API will change a user's password Storage Location to the supplied value.

A System Alert will be generated and sent to the mobile application to display to the logged on mobile worker when a new StorageLocationID has been assigned.

URL

HTTP Request Body

The HTTP request body must contain the following JSON, where the supplied value is the password that is to be set.

Retrieve the Roles associated with a specific User

This REST API will return all of the Roles associated with the User with the specified ID. The User with the specified ID must already exist in the system.

See also the REST Standard REST APIs Role REST API.

URL

HTTP Request Body

This request does not require a request body. 

HTTP Response Body

On success, an HTTP response code of 200 will be returned, and the response body will contain an array of Role ID values associated with the User. (The array may be empty, if no Roles as associated with the User.)

Otherwise, on error, the response body will contain a descriptive reason for the error.

Update the Roles associated with a specific User

This REST API will return update the Roles associated with the User with the specified ID. The User with the specified ID must already exist in the system.

See also the REST Standard REST APIs Role REST API.

URL

HTTP Request Body

The HTTP request body must contain an array of valid Role ID values.

{
	[
		"RoleID1",
		"RoleID2",
		...
	]
}

The User will be updated to be associated with the list of Role IDs supplied.

HTTP Response Body

On success, an HTTP response code of 200 will be returned. 

Assign Service Teams to a User

This REST API will assign supplied Service Teams to a user.

URL

HTTP Request Body

The HTTP request body must contain a collection of valid Service Teams.

{
	"ServiceTeams": [
		// Service Teams ID
	]
}

HTTP Response

On success an HTTP response code of 200 will be returned.

Retrieve the details of a specific User's Entity

This REST API will return the details of User's Entity from the system. The User with the specified ID must already exist in the system.

URL

HTTP Request Body

This request does not require a request body. 

HTTP Response Body

On success, an HTTP response code of 200 will be returned, and the response body will contain a User Entity Object. Otherwise, on error, the response body will contain a descriptive reason for the error. 

Change the details of a specific User's Entity

This REST API will change the details of User's Entity supplied in the HTTP Request Body. The User with the specified ID must already exist in the system.

URL

HTTP Request Body

The HTTP request body must contain a valid User Entity Object.

HTTP Response Body

On success an HTTP response code of 200 will be returned.

Delegate a specific Entity and Role

This REST API will allow a ServiceMobility Super Admin to act on behalf of another ServiceMobility Entity/Role. The Entity and Role with the specified IDs must already exist in the system.

URL

HTTP Request Body

The HTTP request body must contain a JSON object containing the details of the ServiceMobility Super User that will be delegating as the Entity/Role:

{
	"UserID": "<ServiceMobility Super Admin user ID>",
	"Password": "<ServiceMobility Super Admin user password>"
}

HTTP Response Body

On success, an HTTP response code of 200 will be returned, and the response body will be a JSON object containing a JWT which can then be used to authenticate API calls via the x-access-token header to delegate as the specified Entity/Role:

{
	"Token": ""
}

Otherwise, on error, the response body will contain a descriptive reason for the error. 

Impersonate a specific User

This REST API will allow the ServicePower Hub admin user or a ServiceMobility Super Admin to impersonate another User for testing/debugging purposes. The User with the specified ID must already exist in the system.

URL

HTTP Request Body

The HTTP request body must contain a JSON object containing the details of the ServicePower Hub admin user or ServiceMobility Super User that will be impersonating the specified user:

{
	"UserID": "<ServicePower Hub admin user or ServiceMobility Super Admin user ID>",
	"Password": "<ServicePower Hub admin user or ServiceMobility Super Admin user password>"
}

HTTP Response Body

On success, an HTTP response code of 200 will be returned, and the response body will be a JSON object containing a JWT which can then be used to authenticate API calls via the x-access-token header to impersonate the specified user:

{
	"Token": ""
}

Otherwise, on error, the response body will contain a descriptive reason for the error.