Get a list of supervisees mapped to a supervisor account in a LearnCenter
get
/learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/{supervisorAccountId}/supervisees
Request
Path Parameters
-
learnCenterId(required): number
Unique identifier of a LearnCenter.
-
supervisorAccountId(required): string
Unique identifier of a supervisor account.
Query Parameters
-
limit: integer
Specify how many items should be returned in a payload. Must be lower than server default limit size.
-
offset: integer
Specify starting point of the response.Default Value:
0
-
totalResults: boolean
If set to true, the payload includes the total number of rows that satisfies the request. Use of this parameter determines if the 'last' link is displayed for a pageable collection.
Response
Supported Media Types
- application/json
200 Response
Supervisees collection fetched.
Root Schema : SuperviseesResponse
Type:
Show Source
object
-
count:
number
Count is the current number of records displayed in the response.Example:
1
-
hasMore:
boolean
True indicates that we have more records to be displayed.Example:
false
-
items:
object SuperviseeResponse
Object comprising Supervisee parameters.
-
limit:
number
Limit implies the maximum number of records which can be displayed in the page.Example:
100
-
links:
array links
Links to the supervisees.
Nested Schema : SuperviseeResponse
Type:
object
Object comprising Supervisee parameters.
Show Source
-
integratedFlag:
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:
array links
Links to the supervisee.
-
supervisorAccount:
object supervisorAccount
Object comprising Supervisor Account link.
-
supervisorAccountId:
string
Unique identifier for supervisor account.Example:
11445C48-D0BB-4581-AC5A-793DC6405FB8
-
user:
object user
Object comprising Link to the user.
-
userId:
number(int32)
Identifier for the user creating the supervisee.Example:
123123
Nested Schema : links
Type:
array
Links to the supervisees.
Show Source
Example:
[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/00B6ECA6-CAEC-4C7E-A4D8-DFF98AB42D21/supervisees"
}
]
Nested Schema : supervisorAccount
Type:
object
Object comprising Supervisor Account link.
Show Source
Nested Schema : SuperviseeLink
Type:
Show Source
object
-
href:
string
Example:
{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/31D132DB-33E2-4EE3-870C-06ED25F6CE00/supervisees/123445
-
rel:
string
Example:
canonical
Nested Schema : SupervisorAccountLink
Type:
Show Source
object
-
href:
string
Example:
{url}/learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/31D132DB-33E2-4EE3-870C-06ED25F6CE00
-
rel:
string
Example:
canonical
Nested Schema : UserLink
Type:
Show Source
object
-
href:
string
Example:
{url}/learn.rest/v1/users/456
-
rel:
string
Example:
canonical