Get a list of supervisor accounts mapped to a supervisor role in a LearnCenter.
get
/learn.rest/v1/learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}/supervisorAccounts
Request
Path Parameters
-
learnCenterId: number
Unique identifier of a LearnCenter.
-
supervisorRoleId: number
Unique identifier of a supervisor role.
Query Parameters
-
limit(optional): integer
Specify how many items should be returned in a payload. Must be lower than server default limit size.
-
offset(optional): integer
Specify starting point of the response.Default Value:
0
-
totalResults(optional): boolean
If set to true, the payload includes 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
Supervisor accounts collection fetched.
Root Schema : SupervisorRoleSupervisorAccountsResponse
Type:
object
Response object comprising the parameters of the Supervisor account.
Show Source
-
count(optional):
number
User count for the group.Example:
1
-
hasMore(optional):
boolean
True indicates that we have more records to be displayed.Example:
false
-
items(optional):
object SupervisorRoleSupervisorAccountResponse
Response object for the supervisor accounts.
-
limit(optional):
number
Number of Items returned in a payload. Is lower than server default limit size.Example:
100
-
links(optional):
array links
Links to the supervisor accounts.
Nested Schema : SupervisorRoleSupervisorAccountResponse
Type:
object
Response object for the supervisor accounts.
Show Source
-
createDateUtc(optional):
string(datetime)
Date the Supervisor account was created in UTC.Example:
2018-12-18T22:10:00
-
lastUpdateUserId(optional):
number
Unique identifier of the user who last updated the supervisor records.Example:
2000
-
lastUpdateUtc(optional):
string(datetime)
Date the supervisor account was last updated in UTC.Example:
2018-12-18T22:10:00
-
links(optional):
array links
Array comprising links to the supervisor account.
-
statusFlag(optional):
boolean
Status whether the account was created.Example:
true
-
supervisorAccount(optional):
object supervisorAccount
-
supervisorAccountId(optional):
string(guid)
Unique identifier for a supervisor account.Example:
31D132DB-33E2-4EE3-870C-06ED25F6CE00
-
supervisorRole(optional):
object supervisorRole
Object comprising links to the supervisor role.
-
supervisorRoleId(optional):
number
Unique Identifier for the supervisor role.Example:
1914
Nested Schema : links
Type:
array
Links to the supervisor accounts.
Show Source
Example:
[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorRoles/69/supervisorAccounts"
}
]
Nested Schema : supervisorRole
Type:
object
Object comprising links to the supervisor role.
Show Source
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 : SupervisorRoleLink
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/learnCenters/178409/supervisorRoles/123
-
rel(optional):
string
Example:
canonical
401 Response
500 Response
Internal server error.