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(required): number
  Unique identifier of a LearnCenter.
• superviseeId(required): number
  Unique identifier of a supervisee.
• supervisorAccountId(required): string
  Unique identifier of a supervisor account.

Body ()

Supervisee object that needs to be updated.

Root Schema : SuperviseeRequest

Type: object

Show Source

• integratedFlag: boolean
  Default Value: false
• supervisorAccountId: string
• userId: number(int32)

{
    "type":"object",
    "properties":{
        "supervisorAccountId":{
            "type":"string"
        },
        "userId":{
            "type":"number",
            "format":"int32"
        },
        "integratedFlag":{
            "type":"boolean",
            "default":false
        }
    },
    "example":{
        "supervisorAccountId":"supervisor account id",
        "userId":"789",
        "integratedFlag":false
    }
}

Example:

{
    "supervisorAccountId":"supervisor account id",
    "userId":"789",
    "integratedFlag":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