...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"validateAccountFact": {
"statusFact": {
"success": true
}
,"accountFact": {
"pin": null
,"token": "6d033802-9e9d-4fc6-a8fd-2a0c677a43a6"
,"role": null
,"userId": null
,"activeDevices": []
}
}
} |
...
- 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' is not null, it must be unique among existing users
- If 'tagId' is not null, it must be longer than 5 characters and shorter than 20
- If 'pin' is not null, it must be unique among existing users
- If '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. |
| pin | String | No | The security pin of this user. (This pin is not still being used by the application) |
| tagId | String | No | The NFC tag id for the new user. |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{ "data" : [ { "email" : "e@e.com",
"facilityId" : "UNC",
"facilityName" : "UNC",
"firstName" : "e",
"id" : "354a7aae-ac06-4892-ac61-ce302351eb35",
"lastName" : "e",
"organizationId" : "UNC",
"organizationName" : "UNC",
"pinroleId" : "esteban",
"roleId" : 2,
"roleName" : "pod",
"status" : "ACTIVE",
"username" : "username-e",
"updateDate" : "2014-01-06 19:07:40.0"
},
{ "facilityId" : "UNC",
"facilityName" : "UNC",
"id" : "chargenurse",
"organizationId" : "UNC",
"organizationName" : "UNC",
"pin" : "charge",
"roleId" : 1,
"roleName" : "admin",
"status" : "ACTIVE",
"username" : "username-charge",
"updateDate" : "2013-03-08 01:20:37.0"
},
...
],
"statusFact" : { "success" : true }
} |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
data: {
id: "354a7aae-ac06-4892-ac61-ce302351eb35",
lastName: "e",
facilityName: "UNC",
organizationName: "UNC",
status: "ACTIVE",
pin: "esteban",
username: "eaa",
email: "e@e.com",
roleName: "pod",
organizationId: "UNC",
firstName: "e",
facilityId: "UNC",
updateDate: "2014-01-06 19:07:40.0",
roleId: 2
},
statusFact: {
success: true
}
} |
...
- 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 'pin' is not null, it must unique among existing users.
- If 'pin' is not null, it must be longer than 5 characters and shorter than 20
- If 'tagId' is not null, it must unique among existing users.
- If 'tagId' is not null, it must be longer than 5 characters and shorter than 20
- If 'emai' is not null, 'email' must be a well formed email
- If 'emai' is not null, 'email' must be unique among existing users.
...
Important notice: If a user is trying to modify his/her email, password, pin and/or tagId, the argument 'passwordValidation' of this operation is mandatory and it must be the original (old) password of the current user.
...
| 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 | No | The new email address for the user. If this parameter is not provided, the email of the user will not be modified. | |
| 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. |
| pin | String | No | The security pin of this user. (This pin is not still being used by the application) |
| tagId | String | No | The new NFC tag id for the new user. If this value is not provided, the original tagId of the user will not be modified. |
| passwordValidation | String | If a user is trying to modify his/her email, password and/or tagId, the argument 'passwordValidation' -> Yes | The original (old) password of the user. This argument is used for when a user tries to modify his/her OWN email, password and/or tag id. |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{ "data" : { "email" : "e@e.com",
"facilityId" : "UNC",
"facilityName" : "UNC",
"firstName" : "e",
"id" : "354a7aae-ac06-4892-ac61-ce302351eb35",
"username" : "e",
"lastName" : "e",
"organizationId" : "UNC",
"organizationName" : "UNC",
"roleId" : 2,
"roleName" : "pod",
"status" : "SUSPENDED",
"updateDate" : "Wed May 14 13:24:38 CEST 2014"
},
"statusFact" : { "success" : true }
}
|
...