Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

General Information

...

ServiceAPIMethod
urac/owner/admin/group/addPOST


Data Model: Groups

Workflow: Add Group Flow

Input

...

Body or Query
NameSourceMandatoryTypeSpecial FormatDescriptiontId
YESStringN/Athe Id of the tenant where this group is addedtCodeBody or QueryYESStringN/Athe code of the tenant
codeBodyYESStringN/A
nameBodyYESStringN/A
descriptionBodyYESStringN/A


Output

...

Valid Response

Code Block
languagejs
titleValid Response Sample
{
	"result": true,
	"data": true
}


Invalid Response

Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[421],
        "details":[
            {
                "code":421,
                "message":"Group code already exists. Choose another"
            }
        ]
    }
}



Error Codes



Code
Description
400Database connection error
421Group code already exists. Choose another
611invalid tenant id provided


Example (CURL)

...

Request

Code Block
languagebash
titleCalling Add Group API
 > CURL -X POST http://127.0.0.1:4000/urac/owner/admin/group/add?tId=5551aca9e179c39b760f7a1a&tCode=DBTN -d 'code=gold&name=Gold&description=Group Description' 

Response

Code Block
languagejs
titleAdd Group API response
{
	"result": true,
	"data": true
}