Edit

[POST] .../v1/role/edit

Edits role. Rename a role or update its description after verifying that assignments can keep using the same role id. The method validates id and name, checks role edit permission 11, updates the role and returns row_affected. The request body is required, id must be positive, name must be provided and must not exceed 50 characters and description is optional with a maximum length of 300 characters. Missing body, invalid id, missing or too long name, denied permission, missing role and storage errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
description String Optional Note.
id Int64 Required Role ID.
name String Required Role name.

Request Example

{
  "id": 4,
  "name": "Senior cashier",
  "description": "POS operator with return permissions"
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "row_affected": 1,
    "ids": []
  }
}