Jump to

• Request
• Response

Updates subset of properties for a supervisor role.

patch

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

Updates subset of properties for a supervisor role.

Request

Supported Media Types

• application/json

Path Parameters

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

Body ()

Supervisor role object that needs to be created.

Root Schema : SupervisorRoleRequest

Type: object

Show Source

• description: string
  Example: new test role desc
• globalFlag: boolean
  Default Value: false

  Example: false
• name: string
  Example: new test role
• permissions: array permissions
• statusFlag: boolean
  Default Value: true

  Example: true

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "example":"new test role"
        },
        "description":{
            "type":"string",
            "example":"new test role desc"
        },
        "permissions":{
            "type":"array",
            "items":{
                "properties":{
                    "id":{
                        "type":"string"
                    }
                }
            },
            "example":[
                "receiveComSystemMessages",
                "attachFilesToMessages"
            ]
        },
        "statusFlag":{
            "type":"boolean",
            "default":true,
            "example":true
        },
        "globalFlag":{
            "type":"boolean",
            "default":false,
            "example":false
        }
    }
}

Nested Schema : permissions

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "properties":{
            "id":{
                "type":"string"
            }
        }
    },
    "example":[
        "receiveComSystemMessages",
        "attachFilesToMessages"
    ]
}

Example:

[
    "receiveComSystemMessages",
    "attachFilesToMessages"
]

Nested Schema : items

Type: object

Show Source

• id: string

{
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

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 token 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