...
- A Facility with 'facility' id must exist
- A Role with 'role' id must exist
- A UserStatus with 'status' value must exist
- 'password' must be longer than 5 characters and shorter than 20
- If 'tagId(aka 'pin') is not null, it must be longer than 5 characters and shorter than 20
- 'email' must be a well formed email
- 'email' must be unique among existing users
- 'username' must be unique among existing users
...
| Name | Type | Mandatory | Description |
|---|---|---|---|
| token | String | Yes | Security Token obtained before. |
| temporalSession | Boolean | No | DEFAULT: 'false'. Indicates whether the provided token is temporal or not. |
| firstName | String | Yes | The name for the new user. |
| lastName | String | Yes | The last name for the new user. |
| username | String | Yes | The username for the new user. The username must be unique among all the users in the system. |
| String | Yes | The email address for the new user. The email must be unique among all the users in the system. | |
| password | String | Yes | The password for the new user. At the moment, this is plain text. |
| organization | String | Yes | The id of the organization for the new user. |
| facility | String | Yes | The id of the facility for the new user. |
| role | String | Yes | The id of the role for the new user. |
| tagId | String | No | The NFC tag id (aka 'pin') for the new user. |
API Sample
...
- A Facility with 'facility' id must exist
- A Role with 'role' id must exist
- A UserStatus with 'status' value must exist
- 'password' must be longer than 5 characters and shorter than 20
- If 'tagId' (aka 'pin') is not null, it must be longer than 5 characters and shorter than 20
- 'email' must be a well formed email
- 'email' must be unique among existing users.
...
| Name | Type | Mandatory | Description |
|---|---|---|---|
| {requestedUserId} | String | Yes | The id of the requested user. |
| token | String | Yes | Security Token obtained before. |
| userId | String | Yes | The id of the logged in user. |
| firstName | String | Yes | The new name for the user. |
| lastName | String | Yes | The new last name for the user. |
| String | Yes | The new email address for the user. | |
| password | String | No | The new password for the user. |
| organization | String | Yes | The new id of the organization for the user. |
| facility | String | Yes | The new id of the facility for the user. |
| role | String | Yes | The new id of the role for the user. |
| tagId | String | No | The new NFC tag id (aka 'pin') for the new user. If this value is not provided, the original pin tagId of the user will not be modified. |
...