General Information
...
| Name | Source | Mandatory | Type | Special Format | Description | |
|---|---|---|---|---|---|---|
| uId | Query | YES | String | N/A | the user id | |
| status | Query | YES | String | N/AEnum | 'active', 'inactive' | restricted to either 'active' OR 'inactive' |
...
Output
...
Valid Response
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"result": true,
"data": true
} |
...
Invalid Response
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"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)
...