Jump to

• Request
• Response

Update all properties of a supervisee

put

/learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/{supervisorAccountId}/supervisees/{superviseeId}

Request

Supported Media Types

• application/json

Path Parameters

• learnCenterId: number
  Unique identifier of a LearnCenter.
• superviseeId: number
  Unique identifier of a supervisee.
• supervisorAccountId: string
  Unique identifier of a supervisor account.

Body ()

Supervisee object that needs to be updated.

Root Schema : SuperviseeRequest

Type: object

Request object comprising supervisee parameters.

Show Source

• integratedFlag(optional): boolean
  Default Value: false

  When an Admin changes the supervisor in TEE, it will then synchronize with the LearnCenter. If an Admin maps a user to a supervisor in the LearnCenter, it will be set to 0 for Integrated and so if the Admin makes a change in TEE, it will not affect the LearnCenter supervisor mapping.If the value is set to 1 then any changes made in TEE will reflect in LearnCenter.

  Example: false
• supervisorAccountId(optional): string
  Unique identifier for the supervisor account.

  Example: 11445C48-D0BB-4581-AC5A-793DC6405FB8
• userId(optional): number(int32)
  Unique identifier for a user.

  Example: 123123

{
    "type":"object",
    "description":"Request object comprising supervisee parameters.",
    "properties":{
        "supervisorAccountId":{
            "type":"string",
            "description":"Unique identifier for the supervisor account.",
            "example":"11445C48-D0BB-4581-AC5A-793DC6405FB8"
        },
        "userId":{
            "type":"number",
            "format":"int32",
            "example":123123,
            "description":"Unique identifier for a user."
        },
        "integratedFlag":{
            "type":"boolean",
            "default":false,
            "description":"When an Admin changes the supervisor in TEE, it will then synchronize with the LearnCenter. If an Admin maps a user to a supervisor in the LearnCenter, it will be set to 0 for Integrated and so if the Admin makes a change in TEE, it will not affect the LearnCenter supervisor mapping.If the value is set to 1 then any changes made in TEE will reflect in LearnCenter.",
            "example":false
        }
    }
}

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