Versions Compared

Key

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

General Information

...

ServiceAPIMethod
urac/admin/group/editPOST


Data Model: Groups

Workflow: Edit Group Flow

Input

...

NameSourceMandatoryTypeSpecial FormatDescription
gIdQueryYESStringN/AThe Group ID
nameBodyYESStringN/A 
descriptionBodyYESStringN/A 

 

Output

...

Valid Response

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

...

Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[417],
        "details":[
            {
                "code":417,
                "message":"Invalid group id provided"
            }
        ]
    }
}



Error Codes


 

Code
Description
417Invalid group id provided
418Unable to edit Group.


Example (CURL)

...

Request

Code Block
languagebash
titleCalling Edit Group API
 > CURL -X POST http://127.0.0.1:4000/urac/admin/group/edit?gId=5 -d 'name=Gold Group&description=Group Description'

...