General Information
| Service | API | Method |
|---|---|---|
| urac | admin/group/add | POST |
Data Model: Groups
Workflow: Add Group Flow
Input
| Name | Source | Mandatory | Type | Special Format | Description |
|---|---|---|---|---|---|
| tId | Body or Query | YES | String | N/A | the Id of the tenant where this group is added |
| tCode | Body or Query | YES | String | N/A | the code of the tenant |
| code | Body | YES | String | N/A | |
| name | Body | YES | String | N/A | |
| description | Body | YES | String | N/A |
Output
Valid Response
Valid Response Sample
{
"result": true,
"data": true
}
Invalid Response
Error Response Sample
{
"result":false,
"errors":{
"codes":[421],
"details":[
{
"code":421,
"message":"Group code already exists. Choose another"
}
]
}
}
Error Codes
Code | Description |
|---|---|
| 400 | Database connection error |
| 421 | Group code already exists. Choose another |
| 611 | invalid tenant id provided |
Example (CURL)
Request
Calling Add Group API
> CURL -X POST http://127.0.0.1:4000/urac/admin/group/add?tId=5551aca9e179c39b760f7a1a&tCode=DBTN -d 'code=gold&name=Gold&description=Group Description'
Response
Add Group API response
{
"result": true,
"data": true
}
0 Comments