Jump to

• Request
• Response

Get a list of supervisor accounts mapped to a supervisor role in a LearnCenter.

get

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

Request

Path Parameters

• learnCenterId: number
  Unique identifier of a LearnCenter.
• supervisorRoleId: number
  Unique identifier of a supervisor role.

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, payload includes total number of rows that satisfies the request. Use of parameter determines if the 'last' link is displayed for a pageable collection.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Supervisor accounts collection fetched.

Body ()

Root Schema : SupervisorRoleSupervisorAccountsResponse

Type: object

Response object comprising the parameters of the Suppervisor account and role.

Show Source

• count(optional): number
  Count is the current number of records displayed in the response.

  Example: 1
• hasMore(optional): boolean
  True indicates that we have more records to be displayed.

  Example: false
• items(optional): object SupervisorRoleSupervisorAccountResponse
  Response object comprising the parameters for the supervisor role and account.
• limit(optional): number
  Limit implies the maximum number of records which can be displayed in the page.

  Example: 100
• links(optional): array links
  Links to the supervisor accounts.

{
    "type":"object",
    "description":"Response object comprising the parameters of the Suppervisor account and role.",
    "properties":{
        "items":{
            "$ref":"#/definitions/SupervisorRoleSupervisorAccountResponse"
        },
        "limit":{
            "type":"number",
            "example":100,
            "description":"Limit implies the maximum number of records which can be displayed in the page."
        },
        "count":{
            "type":"number",
            "example":1,
            "description":"Count is the current number of records displayed in the response."
        },
        "hasMore":{
            "type":"boolean",
            "example":false,
            "description":" True indicates that we have more records to be displayed."
        },
        "links":{
            "description":"Links to the supervisor accounts.",
            "type":"array",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                }
            },
            "example":[
                {
                    "rel":"canonical",
                    "href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorRoles/69/supervisorAccounts"
                }
            ]
        }
    }
}

Nested Schema : SupervisorRoleSupervisorAccountResponse

Type: object

Response object comprising the parameters for the supervisor role and account.

Show Source

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

  Example: 2018-12-18T22:10:00
• lastUpdateUserId(optional): number
  User Id of the user who updated the supervisor role last.

  Example: 2000
• lastUpdateUtc(optional): string(datetime)
  The date the role was last updated on.

  Example: 2018-12-18T22:10:00
• links(optional): array links
  Links to the supervisor account.
• statusFlag(optional): boolean
  Status of the supervisor role.

  Example: true
• supervisorAccount(optional): object supervisorAccount
  Object comprising supervisor account links.
• supervisorAccountId(optional): string(guid)
  Unique identifier for a supervisor account.

  Example: 31D132DB-33E2-4EE3-870C-06ED25F6CE00
• supervisorRole(optional): object supervisorRole
  Object comprising links to the Supervisor Roles.
• supervisorRoleId(optional): number
  Unique identifier for a supervisor role.

  Example: 1914

{
    "type":"object",
    "description":"Response object comprising the parameters for the supervisor role and account.",
    "properties":{
        "supervisorAccountId":{
            "type":"string",
            "format":"guid",
            "example":"31D132DB-33E2-4EE3-870C-06ED25F6CE00",
            "description":"Unique identifier for a supervisor account."
        },
        "supervisorRoleId":{
            "type":"number",
            "example":1914,
            "description":"Unique identifier for a supervisor role."
        },
        "supervisorAccount":{
            "type":"object",
            "description":"Object comprising supervisor account links.",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/SupervisorAccountLink"
                    }
                }
            }
        },
        "supervisorRole":{
            "type":"object",
            "description":"Object comprising links to the Supervisor Roles.",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/SupervisorRoleLink"
                    }
                }
            }
        },
        "createDateUtc":{
            "type":"string",
            "format":"datetime",
            "example":"2018-12-18T22:10:00",
            "description":"Date the supervisor role is created."
        },
        "lastUpdateUtc":{
            "type":"string",
            "format":"datetime",
            "example":"2018-12-18T22:10:00",
            "description":"The date the role was last updated on."
        },
        "lastUpdateUserId":{
            "type":"number",
            "example":2000,
            "description":"User Id of the user who updated the supervisor role last."
        },
        "statusFlag":{
            "type":"boolean",
            "example":true,
            "description":"Status of the supervisor role."
        },
        "links":{
            "type":"array",
            "description":"Links to the supervisor account.",
            "items":{
                "$ref":"#/definitions/SupervisorAccountLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Links to the supervisor accounts.

Show Source

• Array of: object items

{
    "description":"Links to the supervisor accounts.",
    "type":"array",
    "items":{
        "properties":{
            "rel":{
                "type":"string"
            },
            "href":{
                "type":"string"
            }
        }
    },
    "example":[
        {
            "rel":"canonical",
            "href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorRoles/69/supervisorAccounts"
        }
    ]
}

Example:

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

Nested Schema : links

Type: array

Links to the supervisor account.

Show Source

• Array of: object SupervisorAccountLink

{
    "type":"array",
    "description":"Links to the supervisor account.",
    "items":{
        "$ref":"#/definitions/SupervisorAccountLink"
    }
}

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 : 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 SupervisorAccountLink

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

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

Nested Schema : items

Type: object

Show Source

• href(optional): string
• rel(optional): string

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

401 Response

Authentication refused for provided credentials or the token is invalid.

Headers

• WWW_Authenticate: string

500 Response

Internal server error.

Back to Top