Versions Compared

Version Old Version 4 New Version 5
Changes made by

peter eid

Ragheb Bou Dargham (Unlicensed)

Saved on

Key

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

General Information

...

Name
SourceMandatoryTypeSpecial FormatDescription
gId
QueryYESStringN/AThe Group ID
name
BodyYESStringN/A 
description
BodyYESStringN/A









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

allowedPackages
YESObjectN/A


^([A-Za-z0-9]+)$
YESArray of strings

Then keys should follow the pattern : 

...


^([A-Za-z0-9]+)$

The key is the product code.
The strings inside the array are the package codes.


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":[417],
        "details":[
            {
                "code":417,
                "message":"Invalid group id provided"
            }
        ]
    }
}


Error Codes
 

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

Example (CURL)
...
 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{
	"name": "Silver Group",
	"description": "grp description",
	"config": {
		"allowedPackages": {
			"prod": "pack"
		}
	}
}'
Response
 Code Block
languagejs
titleEdit Group API response
{
	"result": true,
	"data": true
}
...