Versions Compared

Version Old Version 1 New Version 2
Changes made by

peter eid

peter eid

Saved on

Key

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

General Information

...

ServiceAPIMethod
urac/admin/group/editGETPOST


Data Model: %Link to Data Model% Groups

Workflow: %Link to Architecture Page%

...

NameSourceMandatoryTypeSpecial FormatDescription
gIdQueryYESStringN/AThe Group ID
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":[400417],
        "details":[
            {
                "code":400417,
                "message":"ProblemInvalid withgroup theid provided password"
            }
        ]
    }
}



Error Codes

 

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


Example (CURL)

...

Request

Code Block
languagebash
titleCalling YOUR 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'

Response

Code Block
languagejs
titleYOUR Edit Group API response
{
	"result": true,
	"data": {
		"_id": "57063608622c47b5c097d19b",
		"..."
	}true
}