General Information
| Service | API | Method |
|---|---|---|
| urac | /admin/changeUserStatus | GET |
Data Model: Users
Input
| Name | Source | Mandatory | Type | Special Format | Description |
|---|---|---|---|---|---|
| uId | Query | YES | String | N/A | the user id |
| status | Query | YES | String | N/A | restricted to either 'active' OR 'inactive' |
Output
Valid Response
Valid Response Sample
{
"result": true,
"data": true
}
Invalid Response
Error Response Sample
{
"result":false,
"errors":{
"codes":[405],
"details":[
{
"code":405,
"message":"Unable to find User. Please try again."
}
]
}
}
Error Codes
Code | Description |
|---|---|
| 405 | Unable to find User. Please try again. |
| 407 | Problem validating Request. Please try again. |
| 411 | invalid user id provided |
Example (CURL)
Request
Calling Change User Status API
> CURL -X GET http://127.0.0.1:4000/urac/admin/changeUserStatus?uId=123&status=active
Response
Change User Status API response
{
"result": true,
"data": true
}
0 Comments