Versions Compared

Key

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

...

...

General Information

...

ServiceAPIMethodData ModelWorkflow
urac/admin/group/deleteDEL

...

...

Description

This API deletes a group record that has an id that matches the one sent in the query from the tenant that has the external key sent in the request headers.

Input

...

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response 


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


Output

...

Valid Response

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

Invalid Response

Code Block
languagejs
titleError Response Sample
linenumberstrue
collapsetrue
{
    "result":false,
    "errors":{
        "codes":[415602],
        "details":[
            {
                "code":415602,
                "message":"UnableModel toerror: find group.+ %model_error%"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes


...

languagejs
titleDelete Group API response

...


Code
Description
415Unable to find group.417Invalid group id provided419Unable to delete Group.500This record is locked. You cannot modify or delete it400Database connection error
Example (CURL)

Request

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

Response

400

Business logic required data are missing

602Model error: + %model_error%