Creates a new supervisor account
post
/learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts
Request
Supported Media Types
- application/json
Path Parameters
-
learnCenterId: number
Unique identifier of a LearnCenter.
Supervisor account object that has to be created.
Root Schema : SupervisorAccountRequest
Type:
Show Source
object
-
membershipid(optional):
number
Minimum Value:
1
Maximum Value:1.0E15
Example:
{
"id":"11445C48-D0BB-4581-AC5A-793DC6405FB8",
"membershipId":1235891
}
Security
-
auth: basic
Type:
basic
Description:Basic Authentication
Response
Supported Media Types
- application/json
201 Response
New supervisor account resource created.
Root 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 : 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
400 Response
Request has incorrect syntax or does not contain a field that is required.
409 Response
Another resource with the same identifier already exists.
500 Response
Internal server error.