General Information
...
| Service | API | Method |
|---|
| urac | /admin/changeUserStatus | GET |
Data Model: %Link to Data Model% Users
Workflow: %Link to Architecture Page% Change User Status Flow
Input
...
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description |
|---|
Body | ...
| the user id |
| status | Query | YES | String - Enum | 'active', 'inactive' | restricted to either 'active' OR 'inactive' |
Output
...
Valid Response
| Code Block |
|---|
| language | js |
|---|
| title | Valid Response Sample |
|---|
|
{
"result": true,
"data": {
"..."
}
true
} |
Invalid Response
| Code Block |
|---|
| language | js |
|---|
| title | Error Response Sample |
|---|
|
{
"result":false,
"errors":{
"codes":[400405],
"details":[
{
"code":400405,
"message":"Problem with the provided passwordUnable to find User. Please try again."
}
]
}
} |
Error Codes
| 400 | Database Error |
|---|
| 405 | Unable to find User. Please try again. |
| 407 | Problem validating Request. Please try again. |
| 411 | invalid user id provided |
Example (CURL)
...
Request
| Code Block |
|---|
| language | bash |
|---|
| title | Calling YOUR Change User Status API |
|---|
|
> CURL -X POSTGET http://127.0.0.1:4000/.../urac/admin/changeUserStatus?uId=123&status=active |
Response
| Code Block |
|---|
| language | js |
|---|
| title | YOUR Change User Status API response |
|---|
|
{
"result": true,
"data": {
"_id": "57063608622c47b5c097d19b",
"..."
}true
} |