...
...
General Information
...
| Service | API | Method | Data Models | Workflow |
|---|---|---|---|---|
| urac | /admin/group | GET | Groups | N/A |
Description
This API gets the group record that has the id or code that matches the one in the query. The group should be in the tenant that has the external key sent in the request headers.
Input
...
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description |
|---|---|---|---|---|---|
| id | Query | NO | String | N/A | Group ID |
| code | Query | NO | String | N/A | Group Code |
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: {
_id: "5d95da834dcd8a4d1d822ef5",
code: "AAAA",
name: "Unit test",
description: "Added by unit test importer.",
config: {
allowedPackages: {
DSBRD: [
"DSBRD_DEVOP"
]
},
allowedEnvironments: {
DEV: {
}
}
},
tenant: {
id: "5d9321f8b40e09438afbd0c9",
code: "test",
pin: {
code: "1235",
allowed: true
}
}
}
} |
Invalid Response
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"result":false,
"errors":{
"codes":[602],
"details":[
{
"code":602,
"message":"Model error: + %model_error%"
}
]
}
} |
Code | Description |
|---|---|
| 400 | Business logic required data are missing |
| 420 | Unable to find group |
| 602 | Model error: + %model_error% |