Jump to

• Request
• Response

Map a new supervisor account with an existing supervisor role.

post

/learn.rest/v1/learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}/supervisorAccounts

Map a new supervisor account with existing supervisor role.

Request

Supported Media Types

• application/json

Path Parameters

• learnCenterId: number
  Unique identifier of a LearnCenter.
• supervisorRoleId: number
  Unique identifier of a supervisor role.

Body ()

Supervisor role and supervisor account mapping object that needs to be created.

Root Schema : SupervisorRoleAccountMappingRequest

Type: object

Object comprising supervisor Account mapping.

Show Source

• SupervisorAccountId(optional): string
  Unique identifier of the supervisor account.

{
    "type":"object",
    "description":"Object comprising supervisor Account mapping. ",
    "properties":{
        "SupervisorAccountId":{
            "type":"string",
            "description":"Unique identifier of the supervisor account."
        }
    },
    "example":{
        "SupervisorAccountId":"75AB137B-9C3E-40E2-A1D2-E20EA23719F0"
    }
}

Example:

{
    "SupervisorAccountId":"75AB137B-9C3E-40E2-A1D2-E20EA23719F0"
}

Security

• auth: basic
  Type: basic

  Description: Basic Authentication

Back to Top

Response

Supported Media Types

• application/json

201 Response

New supervisor role and supervisor account mapping is created.

Body

Example Response (application/json)

{
    "supervisorAccountId":"086DEDC1-5B10-460F-AACF-1A7D2A71ACB4",
    "supervisorRoleId":1930,
    "supervisorAccount":{
        "links":[
            {
                "rel":"canonical",
                "href":"{url}/learn.rest/v1/learnCenters/189353/supervisorAccounts/086DEDC1-5B10-460F-AACF-1A7D2A71ACB4"
            }
        ]
    },
    "supervisorRole":{
        "links":[
            {
                "rel":"canonical",
                "href":"{url}/learn.rest/v1/learnCenters/189353/supervisorRoles/1930"
            }
        ]
    },
    "createDateUtc":"2019-02-05T10:48:00",
    "statusFlag":true,
    "links":[
        {
            "rel":"canonical",
            "href":"{url}/learn.rest/v1/learnCenters/189353/supervisorRoles/1930/supervisorAccounts/086DEDC1-5B10-460F-AACF-1A7D2A71ACB4"
        }
    ]
}

400 Response

Request has incorrect syntax or does not contain a field that is required.

401 Response

Authentication refused for provided credentials or token invalid.

Headers

• WWW_Authenticate: string

404 Response

Resource not found.

422 Response

Request may contain validation errors.

500 Response

Internal server error.

Back to Top