Jump to

• Request
• Response

Get a list of supervisor roles mapped to supervisor account in a LearnCenter.

get

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

Request

Path Parameters

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

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 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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Supervisor roles collection fetched

Body ()

Root Schema : SupervisorAccountSupervisorRolesResponse

Type: object

Object comprising supervisor role and account parameters.

Show Source

• createDateUtc(optional): string(datetime)
  Date the supervisor role is created.

  Example: 2018-03-07T09:34:00
• links(optional): array links
  Link to the supervisor roles.
• statusFlag(optional): boolean
  Default Value: true

  Example: true "description":"Status of the supervisor role."
• supervisorAccount(optional): object supervisorAccount
  Object comprising supervisor account links.
• supervisorAccountId(optional): string
  Unique identifier for a supervisor account.

  Example: 2F6AF602-965B-415A-B00C-EEDA1F37510B
• supervisorRole(optional): object supervisorRole
  Object comprising links to the Supervisor Roles.
• supervisorRoleId(optional): number
  Unique identifier for a supervisor role.

  Example: 123

{
    "type":"object",
    "description":"Object comprising supervisor role and account parameters.",
    "properties":{
        "supervisorRoleId":{
            "type":"number",
            "description":"Unique identifier for a supervisor role.",
            "example":123
        },
        "supervisorRole":{
            "type":"object",
            "description":"Object comprising links to the Supervisor Roles.",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/SupervisorRoleLink"
                    }
                }
            }
        },
        "supervisorAccountId":{
            "type":"string",
            "description":"Unique identifier for a supervisor account.",
            "example":"2F6AF602-965B-415A-B00C-EEDA1F37510B"
        },
        "supervisorAccount":{
            "type":"object",
            "description":"Object comprising supervisor account links.",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/SupervisorAccountLink"
                    }
                }
            }
        },
        "createDateUtc":{
            "type":"string",
            "format":"datetime",
            "description":"Date the supervisor role is created.",
            "example":"2018-03-07T09:34:00"
        },
        "statusFlag":{
            "type":"boolean",
            "default":true,
            "example":"true \"description\":\"Status of the supervisor role.\""
        },
        "links":{
            "type":"array",
            "description":"Link to the supervisor roles.",
            "items":{
                "$ref":"#/definitions/SupervisorAccountSupervisorRolesLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Link to the supervisor roles.

Show Source

• Array of: object SupervisorAccountSupervisorRolesLink
  Object comprising links to the supervisor roles.

{
    "type":"array",
    "description":"Link to the supervisor roles.",
    "items":{
        "$ref":"#/definitions/SupervisorAccountSupervisorRolesLink"
    }
}

Nested Schema : supervisorAccount

Type: object

Object comprising supervisor account links.

Show Source

• links(optional): array links

{
    "type":"object",
    "description":"Object comprising supervisor account links.",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SupervisorAccountLink"
            }
        }
    }
}

Nested Schema : supervisorRole

Type: object

Object comprising links to the Supervisor Roles.

Show Source

• links(optional): array links

{
    "type":"object",
    "description":"Object comprising links to the Supervisor Roles.",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SupervisorRoleLink"
            }
        }
    }
}

Nested Schema : SupervisorAccountSupervisorRolesLink

Type: object

Object comprising links to the supervisor roles.

Show Source

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

{
    "type":"object",
    "description":"Object comprising links to the supervisor roles.",
    "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 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 : links

Type: array

Show Source

• Array of: object SupervisorRoleLink

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

Nested Schema : SupervisorRoleLink

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/learnCenters/178409/supervisorRoles/123
• rel(optional): string
  Example: canonical

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

Back to Top