...
| Code Block |
|---|
| language | js |
|---|
| title | Valid Response Sample |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
result: true,
data: {
succeeded: [ { id: '5da721b6c257840b3fe44377%user_id%' } ],
failed: []
}
} |
| Code Block |
|---|
| language | js |
|---|
| title | Valid Failed Response Sample |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"succeeded": [],
"failed": [
{
"id": "%user_id%",
"reason": "User has already been invited."
}
]
} |
Invalid Response
| Code Block |
|---|
| language | js |
|---|
| title | Error Response Sample |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"result":false,
"errors":{
"codes":[602],
"details":[
{
"code":602,
"message":"Model error: + %model_error%"
}
]
}
} |
Response validation
| Name | Mandatory | Type | Special Format | Description |
|---|
| succeeded | YES | Array | Array of Objects | Succeeded response information |
| One of the following should exist under the succeeded object: | Name | Mandatory | Type | Special Format | Description |
|---|
| id | YES | String | N/A | User ID | | username | YES | String | N/A | Username | | email | YES | String | N/A | User Email |
|
| failed | YES | String | N/A | Failed response information |
|
| Name | Mandatory | Type | Special Format | Description |
|---|
| reason | YES | String | N/A | Failing reason | One of the following should exist also under the succeeded object: | Name | Mandatory | Type | Special Format | Description |
|---|
| id | YES | String | N/A | User ID | | username | YES | String | N/A | Username | | email | YES | String | N/A | User Email |
|
|
Response schema
Follow this link to check out the response JSON Schema
...