General Information
...
Input
...
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description |
|---|---|---|---|---|---|
| id | Query | NO | String | N/A | Tenant ID |
| code | Query or Body | NO | String | N/A | Tenant Code |
| profile | Body | YES | Object | N/A | Tenant Profile Object |
If id was not included in the query string, the tenant id will automatically be taken from the extKey provided.
Output
...
Response
SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response
...
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
result: true,
data: d{} 1
} |
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 |
Tenant already exists
Main Tenant id is required!
Main Tenant is not found!
| 450 | Unable to find tenant |
| 471 | Unable to update tenant |
| 500 | You cannot modify or delete a locked record |
| 602 | Model error: + %model_error% |