Delete Group

General Information


ServiceAPIMethod
urac/admin/group/deleteDEL


Data Model: Groups

Workflow: Delete Group Flow

Input


Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
gIdQueryYESStringN/AThe Group ID


Output


Valid Response

Valid Response Sample
{
	"result": true,
	"data": true
}


Invalid Response

Error Response Sample
{
    "result":false,
    "errors":{
        "codes":[415],
        "details":[
            {
                "code":415,
                "message":"Unable to find group."
            }
        ]
    }
}



Error Codes



Code
Description
415Unable to find group.
417Invalid group id provided
419Unable to delete Group.
500This record in locked. You cannot modify or delete it
400Database connection error


Example (CURL)


Request

Calling Delete Group API
 > CURL -X DEL http://127.0.0.1:4000/urac/admin/group/delete?gId=5

Response

Delete Group API response
{
	"result": true,
	"data": true
}