Creates a new supervisee
post
/learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/{supervisorAccountId}/supervisees
Request
Supported Media Types
- application/json
Path Parameters
-
learnCenterId: number
Unique identifier of a LearnCenter.
-
supervisorAccountId: string
Unique identifier of a Supervisor Account.
Supervisor role object that needs to be created.
Root Schema : SuperviseeRequest
Type:
Show Source
object
-
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
Example:
11445C48-D0BB-4581-AC5A-793DC6405FB8
-
userId(optional):
number(int32)
Example:
123123
Security
-
auth: basic
Type:
basic
Description:Basic Authentication
Response
Supported Media Types
- application/json
201 Response
New supervisee created.
Root Schema : SuperviseeResponse
Type:
Show Source
object
-
integratedFlag(optional):
boolean
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
-
links(optional):
array links
-
supervisorAccount(optional):
object supervisorAccount
-
supervisorAccountId(optional):
string
Example:
11445C48-D0BB-4581-AC5A-793DC6405FB8
-
user(optional):
object user
-
userId(optional):
number(int32)
Example:
123123
Nested Schema : SuperviseeLink
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/31D132DB-33E2-4EE3-870C-06ED25F6CE00/supervisees/123445
-
rel(optional):
string
Example:
canonical
Nested Schema : SupervisorAccountLink
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/31D132DB-33E2-4EE3-870C-06ED25F6CE00
-
rel(optional):
string
Example:
canonical
Nested Schema : UserLink
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/users/456
-
rel(optional):
string
Example:
canonical
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
404 Response
Resource not found.
422 Response
Request may contain validation errors.
500 Response
Internal server error.