Jump to

• Request
• Response

Get a list of supervisor roles in a LearnCenter.

get

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

Request

Path Parameters

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

Query Parameters

• limit: integer
  Specify how many items should be returned in a payload. Must be lower than server default limit size.
• offset: integer
  Specify starting point of the response.

  Default Value: 0
• totalResults: 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 : SupervisorRolesResponse

Type: object

Show Source

• count: number
  Example: 1
• hasMore: boolean
  Example: false
• items: array items
• limit: number
  Example: 100
• links: array links

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SupervisorRoleResponse"
            }
        },
        "limit":{
            "type":"number",
            "example":"100"
        },
        "count":{
            "type":"number",
            "example":"1"
        },
        "hasMore":{
            "type":"boolean",
            "example":false
        },
        "links":{
            "type":"array",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                }
            },
            "example":[
                {
                    "rel":"canonical",
                    "href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorRoles"
                }
            ]
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object SupervisorRoleResponse

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

Nested Schema : links

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "properties":{
            "rel":{
                "type":"string"
            },
            "href":{
                "type":"string"
            }
        }
    },
    "example":[
        {
            "rel":"canonical",
            "href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorRoles"
        }
    ]
}

Example:

[
    {
        "rel":"canonical",
        "href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorRoles"
    }
]

Nested Schema : SupervisorRoleResponse

Type: object

Show Source

• createDateUtc: string(datetime)
  Example: 2018-03-07T09:34:00
• links: array links
• statusFlag: boolean
  Default Value: true

  Example: true
• supervisorAccount: object supervisorAccount
• supervisorAccountId: string
  Example: 2F6AF602-965B-415A-B00C-EEDA1F37510B
• supervisorRole: object supervisorRole
• supervisorRoleId: number
  Example: 123

{
    "type":"object",
    "properties":{
        "supervisorRoleId":{
            "type":"number",
            "example":"123"
        },
        "supervisorRole":{
            "type":"object",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/SupervisorRoleLink"
                    }
                }
            }
        },
        "supervisorAccountId":{
            "type":"string",
            "example":"2F6AF602-965B-415A-B00C-EEDA1F37510B"
        },
        "supervisorAccount":{
            "type":"object",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/SupervisorAccountLink"
                    }
                }
            }
        },
        "createDateUtc":{
            "type":"string",
            "format":"datetime",
            "example":"2018-03-07T09:34:00"
        },
        "statusFlag":{
            "type":"boolean",
            "default":true,
            "example":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SupervisorAccountSupervisorRolesLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SupervisorAccountSupervisorRolesLink

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

Nested Schema : supervisorAccount

Type: object

Show Source

• links: array links

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

Nested Schema : supervisorRole

Type: object

Show Source

• links: array links

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

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",
    "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
  Object comprising links to the supervisor account.

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

Nested Schema : SupervisorAccountLink

Type: object

Object comprising links to the supervisor account.

Show Source

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

{
    "description":"Object comprising links to the supervisor account.",
    "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: string
  Example: {url}/learn.rest/v1/learnCenters/178409/supervisorRoles/123
• rel: string
  Example: canonical

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

Nested Schema : items

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Back to Top