Jump to

• Request
• Response

Updates subset of properties for a supervisor role.

patch

/learn.rest/v1/learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}

Request

Supported Media Types

• application/json

Path Parameters

• learnCenterId: number
  Unique identifier of a LearnCenter.
• supervisorRoleId: number
  Unique identifier of a supervisor role.

Body ()

Supervisor role object that needs to be created.

Root Schema : SupervisorRoleRequest

Type: object

Object comprising parameters to be passed to create a new supervisor role.

Show Source

• description(optional): string
  Description of the role you want to create.

  Example: new test role desc
• globalFlag(optional): boolean
  Default Value: false

  Whether the created role is searchable globally.

  Example: false
• name(optional): string
  Name of the supervisor role.

  Example: new test role
• permissions(optional): array permissions
  The permissions applicable to the supervisor role you create.
• statusFlag(optional): boolean
  Default Value: true

  Status of Supervisor role created

  Example: true

{
    "type":"object",
    "description":"Object comprising parameters to be passed to create a new supervisor role.",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the supervisor role.",
            "example":"new test role"
        },
        "description":{
            "type":"string",
            "description":"Description of the role you want to create.",
            "example":"new test role desc"
        },
        "permissions":{
            "description":"The permissions applicable to the supervisor role you create.",
            "type":"array",
            "items":{
                "properties":{
                    "id":{
                        "type":"string",
                        "description":"Id of the supervisor role you want to assign permissions to."
                    }
                }
            },
            "example":[
                "receiveComSystemMessages",
                "attachFilesToMessages"
            ]
        },
        "statusFlag":{
            "type":"boolean",
            "description":"Status of Supervisor role created",
            "default":true,
            "example":true
        },
        "globalFlag":{
            "type":"boolean",
            "default":false,
            "example":false,
            "description":"Whether the created role is searchable globally."
        }
    }
}

Nested Schema : permissions

Type: array

The permissions applicable to the supervisor role you create.

Show Source

• Array of: object items

{
    "description":"The permissions applicable to the supervisor role you create.",
    "type":"array",
    "items":{
        "properties":{
            "id":{
                "type":"string",
                "description":"Id of the supervisor role you want to assign permissions to."
            }
        }
    },
    "example":[
        "receiveComSystemMessages",
        "attachFilesToMessages"
    ]
}

Example:

[
    "receiveComSystemMessages",
    "attachFilesToMessages"
]

Nested Schema : items

Type: object

Show Source

• id(optional): string
  Id of the supervisor role you want to assign permissions to.

{
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of the supervisor role you want to assign permissions to."
        }
    }
}

Security

• auth: basic
  Type: basic

  Description: Basic Authentication

Back to Top

Response

Supported Media Types

• application/json

200 Response

Resource updated.

400 Response

Request has incorrect syntax or does not contain a field that is required.

401 Response

Authentication refused for provided credentials or the token is invalid.

Headers

• WWW_Authenticate: string

404 Response

Resource not found.

422 Response

Request may contain validation errors.

500 Response

Internal server error.

Back to Top