Get a list of supervisor accounts in a LearnCenter.
get
/learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts
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 the 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 : SupervisorAccountsResponse
Type:
object
Object comprising the parameters that are returned in the Supervisor Account response object.
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):
object SupervisorAccountResponse
Supervisor Account Response object comprising parameters for the Supervisor accounts.
-
limit(optional):
number
Limit implies the maximum number of records which can be displayed in the page.Example:
100
-
links(optional):
array links
Array of supervisor account links.
Nested Schema : SupervisorAccountResponse
Type:
object
Supervisor Account Response object comprising parameters for the Supervisor accounts.
Show Source
-
createdInLearnCenter(optional):
object createdInLearnCenter
Specifies the link of the LearnCenter where the supervisor account was created.
-
createdInLearnCenterId(optional):
number
Specifies the LearnCenterid in which the supervisor has been created.Example:
178409
-
id(optional):
string(guid)
Supervisor Account unique identifier.Example:
31D132DB-33E2-4EE3-870C-06ED25F6CE00
-
links(optional):
array links
Links to supervisor accounts.
-
membership(optional):
object membership
Membership object comprising the membership links.
-
membershipId(optional):
number
Unique identifier of the membership.Example:
1914
-
supervisees(optional):
object supervisees
Object comprising the links to the supervisees.
-
supervisorRoles(optional):
object supervisorRoles
Supervisor roles object comprising links to supervisor roles.
Nested Schema : links
Type:
array
Array of supervisor account links.
Show Source
Example:
[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts"
}
]
Nested Schema : createdInLearnCenter
Type:
object
Specifies the link of the LearnCenter where the supervisor account was created.
Show Source
Nested Schema : membership
Type:
object
Membership object comprising the membership links.
Show Source
Nested Schema : supervisees
Type:
object
Object comprising the links to the supervisees.
Show Source
Nested Schema : supervisorRoles
Type:
object
Supervisor roles object comprising links to supervisor roles.
Show Source
Nested Schema : links
Type:
Show Source
array
-
Array of:
object LearnCenterLink
Object containing Learn Center Links.
Nested Schema : LearnCenterLink
Type:
object
Object containing Learn Center Links.
Show Source
-
href(optional):
string
Example:
{url}/learn.rest/v1/learnCenters/178409
-
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 : links
Type:
Show Source
array
-
Array of:
object MembershipLink
Object comprising links to the memberships.
Nested Schema : MembershipLink
Type:
object
Object comprising links to the memberships.
Show Source
-
href(optional):
string
Example:
{url}/learn.rest/v1/memberships/456
-
rel(optional):
string
Example:
canonical
Nested Schema : SuperviseesLink
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/31D132DB-33E2-4EE3-870C-06ED25F6CE00/supervisees
-
rel(optional):
string
Example:
canonical
Nested Schema : SupervisorAccountSupervisorRolesLink
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/00B6ECA6-CAEC-4C7E-A4D8-DFF98AB42D21/supervisorRoles
-
rel(optional):
string
Example:
canonical
401 Response
500 Response
Internal server error.