...
...
General Information
...
| Service | API | Method | Data Models | Workflow |
|---|---|---|---|---|
| urac | /password/forgotaccount | GETPUT | Users | N/A |
Description
This API allows a user to update the information of the account that has an id that matches the one sent in the request body.
Input
...
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description |
|---|---|---|---|---|---|
| id | Body | YES | String | N/A | User ID |
| username | Body | NO | String | N/A | Username |
| firstName | Body | NO | String | N/A | First Name |
| lastName | Body | NO | String | N/A | Last Name |
| profile | Body | NO | Object | N/A | Profile |
| ln | Body | NO | String | N/A | language |
| phone | Body | NO | String | N/A | Phone number |
Output
...
Response
SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response
Valid Response
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
result: true,
data: 1true
} |
Invalid Response
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"result":false,
"errors":{
"codes":[602],
"details":[
{
"code":602,
"message":"Model error: + %model_error%"
}
]
}
} |
Response schema
Follow this link to check out the response JSON response JSON Schema
SOAJS Error Codes
Code | Description |
|---|---|
| 400 | Business logic required data are missing |
| 602 | Model error: + %model_error% |