Get a list of supervisor accounts mapped to a supervisor role in a LearnCenter.
get
/learn.rest/v1/learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}/supervisorAccounts
Get a list of supervisor accounts mapped to a supervisor role in a LearnCenter.
Request
Path Parameters
-
learnCenterId(required): number
Unique identifier of a LearnCenter.
-
supervisorRoleId(required): number
Unique identifier of a supervisor role.
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 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:
Show Source
object
-
count:
number
Example:
1
-
hasMore:
boolean
Example:
false
-
items:
object SupervisorRoleSupervisorAccountResponse
-
limit:
number
Example:
100
-
links:
array links
Nested Schema : SupervisorRoleSupervisorAccountResponse
Type:
Show Source
object
-
createDateUtc:
string(datetime)
Example:
2018-12-18T22:10:00
-
lastUpdateUserId:
number
Example:
2000
-
lastUpdateUtc:
string(datetime)
Example:
2018-12-18T22:10:00
-
links:
array links
-
statusFlag:
boolean
Example:
true
-
supervisorAccount:
object supervisorAccount
-
supervisorAccountId:
string(guid)
Example:
31D132DB-33E2-4EE3-870C-06ED25F6CE00
-
supervisorRole:
object supervisorRole
-
supervisorRoleId:
number
Example:
1914
Nested Schema : links
Type:
Show Source
array
Example:
[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorRoles/69/supervisorAccounts"
}
]
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 : SupervisorRoleLink
Type:
Show Source
object
-
href:
string
Example:
{url}/learn.rest/v1/learnCenters/178409/supervisorRoles/123
-
rel:
string
Example:
canonical
401 Response
500 Response
Internal server error.