Jump to

• Request
• Response

Creates a new supervisee

post

/learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/{supervisorAccountId}/supervisees

Request

Supported Media Types

• application/json

Path Parameters

• learnCenterId: number
  Unique identifier of a LearnCenter.
• supervisorAccountId: string
  Unique identifier of a Supervisor Account.

Body ()

Supervisor role object that needs to be created.

Root Schema : SuperviseeRequest

Type: object

Show Source

• integratedFlag(optional): boolean
  Default Value: false
• supervisorAccountId(optional): string
• userId(optional): number(int32)

{
    "type":"object",
    "properties":{
        "supervisorAccountId":{
            "type":"string"
        },
        "userId":{
            "type":"number",
            "format":"int32"
        },
        "integratedFlag":{
            "type":"boolean",
            "default":false
        }
    },
    "example":{
        "supervisorAccountId":"supervisor account id",
        "userId":789,
        "integratedFlag":false
    }
}

Example:

{
    "supervisorAccountId":"supervisor account id",
    "userId":789,
    "integratedFlag":false
}

Security

• auth: basic
  Type: basic

  Description: Basic Authentication

Back to Top

Response

Supported Media Types

• application/json

201 Response

New supervisee created.

Body ()

Root Schema : SuperviseeResponse

Type: object

Show Source

• integratedFlag(optional): boolean
  Example: false
• links(optional): array links
• supervisorAccount(optional): object supervisorAccount
• supervisorAccountId(optional): string
  Example: 11445C48-D0BB-4581-AC5A-793DC6405FB8
• user(optional): object user
• userId(optional): number(int32)
  Example: 123123

{
    "type":"object",
    "properties":{
        "supervisorAccountId":{
            "type":"string",
            "example":"11445C48-D0BB-4581-AC5A-793DC6405FB8"
        },
        "supervisorAccount":{
            "type":"object",
            "properties":{
                "link":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/SupervisorAccountLink"
                    }
                }
            }
        },
        "userId":{
            "type":"number",
            "format":"int32",
            "example":123123
        },
        "user":{
            "type":"object",
            "properties":{
                "link":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/UserLink"
                    }
                }
            }
        },
        "integratedFlag":{
            "type":"boolean",
            "example":false
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuperviseeLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuperviseeLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SuperviseeLink"
    }
}

Nested Schema : supervisorAccount

Type: object

Show Source

• link(optional): array link

{
    "type":"object",
    "properties":{
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SupervisorAccountLink"
            }
        }
    }
}

Nested Schema : user

Type: object

Show Source

• link(optional): array link

{
    "type":"object",
    "properties":{
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserLink"
            }
        }
    }
}

Nested Schema : SuperviseeLink

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/31D132DB-33E2-4EE3-870C-06ED25F6CE00/supervisees/123445
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/31D132DB-33E2-4EE3-870C-06ED25F6CE00/supervisees/123445"
        }
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object SupervisorAccountLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SupervisorAccountLink"
    }
}

Nested Schema : SupervisorAccountLink

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/31D132DB-33E2-4EE3-870C-06ED25F6CE00
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/31D132DB-33E2-4EE3-870C-06ED25F6CE00"
        }
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object UserLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserLink"
    }
}

Nested Schema : UserLink

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/users/456
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/users/456"
        }
    }
}

400 Response

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

401 Response

Authentication refused for provided credentials or the token is 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