Jump to

• Request
• Response

Creates a new supervisor account

post

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

Creates a new supervisor account.

Request

Supported Media Types

• application/json

Path Parameters

• learnCenterId(required): number
  Unique identifier of a LearnCenter.

Body ()

Supervisor account object that has to be created.

Root Schema : SupervisorAccountRequest

Type: object

Show Source

• membershipid: number
  Minimum Value: 1

  Maximum Value: 1000000000000000

  Example: 1235891

{
    "type":"object",
    "properties":{
        "membershipid":{
            "type":"number",
            "minimum":1,
            "maximum":"1000000000000000",
            "example":1235891
        }
    }
}

Security

• auth: basic
  Type: basic

  Description: Basic Authentication

Back to Top

Response

Supported Media Types

• application/json

201 Response

New supervisor account resource created.

Body ()

Root Schema : SupervisorAccountResponse

Type: object

Show Source

• createdInLearnCenter: object createdInLearnCenter
• createdInLearnCenterId: number
  Example: 178409
• id: string(guid)
  Example: 31D132DB-33E2-4EE3-870C-06ED25F6CE00
• links: array links
• membership: object membership
• membershipId: number
  Example: 1914
• supervisorRoles: object supervisorRoles
• supervisorsees: object supervisorsees

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"guid",
            "example":"31D132DB-33E2-4EE3-870C-06ED25F6CE00"
        },
        "membershipId":{
            "type":"number",
            "example":1914
        },
        "membership":{
            "type":"object",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/MembershipLink"
                    }
                }
            }
        },
        "createdInLearnCenterId":{
            "type":"number",
            "example":178409
        },
        "createdInLearnCenter":{
            "type":"object",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LearnCenterLink"
                    }
                }
            }
        },
        "supervisorsees":{
            "type":"object",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/SuperviseesLink"
                    }
                }
            }
        },
        "supervisorRoles":{
            "type":"object",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/SupervisorAccountSupervisorRolesLink"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SupervisorAccountLink"
            }
        }
    }
}

Nested Schema : createdInLearnCenter

Type: object

Show Source

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LearnCenterLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SupervisorAccountLink

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

Nested Schema : membership

Type: object

Show Source

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MembershipLink"
            }
        }
    }
}

Nested Schema : supervisorRoles

Type: object

Show Source

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SupervisorAccountSupervisorRolesLink"
            }
        }
    }
}

Nested Schema : supervisorsees

Type: object

Show Source

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuperviseesLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LearnCenterLink

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

Nested Schema : LearnCenterLink

Type: object

Show Source

• href: string
  Example: {url}/learn.rest/v1/learnCenters/178409
• rel: string
  Example: canonical

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

Nested Schema : SupervisorAccountLink

Type: object

Show Source

• href: string
  Example: {url}/learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/31D132DB-33E2-4EE3-870C-06ED25F6CE00
• rel: 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 : links

Type: array

Show Source

• Array of: object MembershipLink

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

Nested Schema : MembershipLink

Type: object

Show Source

• href: string
  Example: {url}/learn.rest/v1/memberships/456
• rel: string
  Example: canonical

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

Nested Schema : links

Type: array

Show Source

• Array of: object SupervisorAccountSupervisorRolesLink

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

Nested Schema : SupervisorAccountSupervisorRolesLink

Type: object

Show Source

• href: string
  Example: {url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/00B6ECA6-CAEC-4C7E-A4D8-DFF98AB42D21/supervisorRoles
• rel: string
  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/00B6ECA6-CAEC-4C7E-A4D8-DFF98AB42D21/supervisorRoles"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuperviseesLink

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

Nested Schema : SuperviseesLink

Type: object

Show Source

• href: string
  Example: {url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/31D132DB-33E2-4EE3-870C-06ED25F6CE00/supervisees
• rel: 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"
        }
    }
}

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.

Back to Top