Jump to

• Request
• Response

Get a list of supervisor roles mapped to a 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 successfully.

Body ()

Root Schema : SupervisorAccountSupervisorRolesResponse

Type: object

Response object comprising supervisor role id and links to the supervisor role.

Show Source

• createDateUtc(optional): string(datetime)
  The date the supervisor account is created in UTC.

  Example: 2018-03-07T09:34:00
• links(optional): array links
  Links to the Supervisor Roles.
• statusFlag(optional): boolean
  Default Value: true

  Status of the supervisor account.

  Example: true
• supervisorAccount(optional): object supervisorAccount
  Supervisor Account object comprising Supervisor Account links.
• supervisorAccountId(optional): string
  Unique identifier for the supervisor account.

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

  Example: 123

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

Nested Schema : links

Type: array

Links to the Supervisor Roles.

Show Source

• Array of: object SupervisorAccountSupervisorRolesLink

{
    "type":"array",
    "description":"Links to the Supervisor Roles.",
    "items":{
        "$ref":"#/definitions/SupervisorAccountSupervisorRolesLink"
    }
}

Nested Schema : supervisorAccount

Type: object

Supervisor Account object comprising Supervisor Account links.

Show Source

• links(optional): array links

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

Nested Schema : supervisorRole

Type: object

Object comprising links to the supervisor role.

Show Source

• links(optional): array links

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

Nested Schema : SupervisorAccountSupervisorRolesLink

Type: object

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":"",
    "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"
        }
    }
}

Example Response (application/json)

{
    "items":[
        {
            "supervisorRoleId":1,
            "supervisorRole":{
                "links":[
                    {
                        "rel":"canonical",
                        "href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorRoles/1"
                    }
                ]
            },
            "supervisorAccountId":"2F6AF602-965B-415A-B00C-EEDA1F37510B",
            "supervisorAccount":{
                "links":[
                    {
                        "rel":"canonical",
                        "href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/2F6AF602-965B-415A-B00C-EEDA1F37510B"
                    }
                ]
            },
            "createDateUtc":"2018-03-07T09:34:00",
            "statusFlag":true,
            "links":[
                {
                    "rel":"canonical",
                    "href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/2F6AF602-965B-415A-B00C-EEDA1F37510B/supervisorRoles"
                }
            ]
        },
        {
            "...":null
        }
    ],
    "limit":100,
    "count":1,
    "hasMore":false,
    "links":[
        {
            "rel":"canonical",
            "href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/2F6AF602-965B-415A-B00C-EEDA1F37510B/supervisorRoles"
        }
    ]
}

Back to Top