Jump to

• Request
• Response

Get a list of supervisor accounts in a LearnCenter.

get

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

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 the 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 accounts collection fetched.

Body ()

Root Schema : SupervisorAccountsResponse

Type: object

Object comprising the parameters that are returned in the Supervisor Account response object.

Show Source

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

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

  Example: false
• items: object SupervisorAccountResponse
  Supervisor Account Response object comprising parameters for the Supervisor accounts.
• limit: number
  Limit implies the maximum number of records which can be displayed in the page.

  Example: 100
• links: array links
  Array of supervisor account links.

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

Nested Schema : SupervisorAccountResponse

Type: object

Supervisor Account Response object comprising parameters for the Supervisor accounts.

Show Source

• createdInLearnCenter: object createdInLearnCenter
  Specifies the link of the LearnCenter where the supervisor account was created.
• createdInLearnCenterId: number
  Specifies the LearnCenterid in which the supervisor has been created.

  Example: 178409
• id: string(guid)
  Supervisor Account unique identifier.

  Example: 31D132DB-33E2-4EE3-870C-06ED25F6CE00
• links: array links
  Links to supervisor accounts.
• membership: object membership
  Membership object comprising the membership links.
• membershipId: number
  Unique identifier of the membership.

  Example: 1914
• supervisees: object supervisees
  Object comprising the links to the supervisees.
• supervisorRoles: object supervisorRoles
  Supervisor roles object comprising links to supervisor roles.

{
    "type":"object",
    "description":"Supervisor Account Response object comprising parameters for the Supervisor accounts.",
    "properties":{
        "id":{
            "type":"string",
            "format":"guid",
            "example":"31D132DB-33E2-4EE3-870C-06ED25F6CE00",
            "description":"Supervisor Account unique identifier."
        },
        "membershipId":{
            "type":"number",
            "example":1914,
            "description":"Unique identifier of the membership."
        },
        "membership":{
            "type":"object",
            "description":"Membership object comprising the membership links.",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/MembershipLink"
                    }
                }
            }
        },
        "createdInLearnCenterId":{
            "type":"number",
            "description":"Specifies the LearnCenterid in which the supervisor has been created.",
            "example":178409
        },
        "createdInLearnCenter":{
            "type":"object",
            "description":"Specifies the link of the LearnCenter where the supervisor account was created.",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LearnCenterLink"
                    }
                }
            }
        },
        "supervisees":{
            "type":"object",
            "description":"Object comprising the links to the supervisees.",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/SuperviseesLink"
                    }
                }
            }
        },
        "supervisorRoles":{
            "type":"object",
            "description":"Supervisor roles object comprising links to supervisor roles.",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/SupervisorAccountSupervisorRolesLink"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "description":"Links to supervisor accounts.",
            "items":{
                "$ref":"#/definitions/SupervisorAccountLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Array of supervisor account links.

Show Source

• Array of: object items

{
    "description":"Array of supervisor account links.",
    "type":"array",
    "items":{
        "properties":{
            "rel":{
                "type":"string"
            },
            "href":{
                "type":"string"
            }
        }
    },
    "example":[
        {
            "rel":"canonical",
            "href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts"
        }
    ]
}

Example:

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

Nested Schema : createdInLearnCenter

Type: object

Specifies the link of the LearnCenter where the supervisor account was created.

Show Source

• links: array links

{
    "type":"object",
    "description":"Specifies the link of the LearnCenter where the supervisor account was created.",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LearnCenterLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Links to supervisor accounts.

Show Source

• Array of: object SupervisorAccountLink

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

Nested Schema : membership

Type: object

Membership object comprising the membership links.

Show Source

• links: array links

{
    "type":"object",
    "description":"Membership object comprising the membership links.",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MembershipLink"
            }
        }
    }
}

Nested Schema : supervisees

Type: object

Object comprising the links to the supervisees.

Show Source

• links: array links

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

Nested Schema : supervisorRoles

Type: object

Supervisor roles object comprising links to supervisor roles.

Show Source

• links: array links

{
    "type":"object",
    "description":"Supervisor roles object comprising links to supervisor roles.",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SupervisorAccountSupervisorRolesLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LearnCenterLink
  Object containing Learn Center Links.

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

Nested Schema : LearnCenterLink

Type: object

Object containing Learn Center Links.

Show Source

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

{
    "type":"object",
    "description":"Object containing Learn Center Links.",
    "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
  Object comprising links to the memberships.

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

Nested Schema : MembershipLink

Type: object

Object comprising links to the memberships.

Show Source

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

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

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

Type: object

Show Source

• href: string
• rel: string

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

401 Response

Authentication refused for provided credentials or token invalid.

Headers

• WWW_Authenticate: string

500 Response

Internal server error.

Back to Top