Get a list of supervisor roles in a LearnCenter.
get
/learn.rest/v1/learnCenters/{learnCenterId}/supervisorRoles
Request
Path Parameters
-
learnCenterId: number
Unique identifier of a LearnCenter.
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 roles collection fetched
Root Schema : SupervisorRolesResponse
Type:
object
Response object comprising parameters for supervisor roles.
Show Source
-
count(optional):
number
Count is the current number of records displayed in the response.Example:
1
-
hasMore(optional):
boolean
True indicates that we have more records to be displayed.Example:
false
-
items(optional):
array items
-
limit(optional):
number
Limit implies the maximum number of records which can be displayed in the page.Example:
100
-
links(optional):
array links
Links to the supervisor roles.
Nested Schema : items
Type:
Show Source
array
-
Array of:
object SupervisorRoleResponse
Object comprising supervisor role and account parameters.
Nested Schema : links
Type:
array
Links to the supervisor roles.
Show Source
Example:
[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorRoles"
}
]
Nested Schema : SupervisorRoleResponse
Type:
object
Object comprising supervisor role and account parameters.
Show Source
-
createDateUtc(optional):
string(datetime)
Date the supervisor role is created.Example:
2018-03-07T09:34:00
-
links(optional):
array links
Link to the supervisor roles.
-
statusFlag(optional):
boolean
Default Value:
true
Status of the supervisor role.Example:true
-
supervisorAccount(optional):
object supervisorAccount
Object comprising supervisor account links.
-
supervisorAccountId(optional):
string
Unique identifier for a supervisor account.Example:
2F6AF602-965B-415A-B00C-EEDA1F37510B
-
supervisorRole(optional):
object supervisorRole
Object comprising links to the Supervisor Roles.
-
supervisorRoleId(optional):
number
Example:
123
Nested Schema : links
Type:
array
Link to the supervisor roles.
Show Source
-
Array of:
object SupervisorAccountSupervisorRolesLink
Object comprising links to the supervisor roles.
Nested Schema : supervisorAccount
Type:
object
Object comprising supervisor account links.
Show Source
Nested Schema : supervisorRole
Type:
object
Object comprising links to the Supervisor Roles.
Show Source
Nested Schema : SupervisorAccountSupervisorRolesLink
Type:
object
Object comprising links to the supervisor roles.
Show Source
-
href(optional):
string
Example:
{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/00B6ECA6-CAEC-4C7E-A4D8-DFF98AB42D21/supervisorRoles
-
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 : SupervisorRoleLink
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/learnCenters/178409/supervisorRoles/123
-
rel(optional):
string
Example:
canonical