Jump to

• Request
• Response

Get a list of supervisees mapped to a supervisor account in a LearnCenter

get

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

Request

Path Parameters

• learnCenterId: number
  Unique identifier of a LearnCenter.
• supervisorAccountId: string
  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 the 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

Supervisees collection fetched.

Body ()

Root Schema : SuperviseesResponse

Type: object

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 SuperviseeResponse
  Object comprising Supervisee parameters.
• 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 supervisees.

{
    "type":"object",
    "properties":{
        "items":{
            "$ref":"#/definitions/SuperviseeResponse"
        },
        "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":{
            "type":"array",
            "description":"Links to the supervisees.",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                }
            },
            "example":[
                {
                    "rel":"canonical",
                    "href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/00B6ECA6-CAEC-4C7E-A4D8-DFF98AB42D21/supervisees"
                }
            ]
        }
    }
}

Nested Schema : SuperviseeResponse

Type: object

Object comprising Supervisee parameters.

Show Source

• integratedFlag(optional): boolean
  When an Admin changes the supervisor in TEE, it will then synchronize with the LearnCenter. If an Admin maps a user to a supervisor in the LearnCenter, it will be set to 0 for Integrated and so if the Admin makes a change in TEE, it will not affect the LearnCenter supervisor mapping.If the value is set to 1 then any changes made in TEE will reflect in LearnCenter.

  Example: false
• links(optional): array links
  Links to the supervisee.
• supervisorAccount(optional): object supervisorAccount
  Object comprising Supervisor Account link.
• supervisorAccountId(optional): string
  Unique identifier for supervisor account.

  Example: 11445C48-D0BB-4581-AC5A-793DC6405FB8
• user(optional): object user
  Object comprising Link to the user.
• userId(optional): number(int32)
  Identifier for the user creating the supervisee.

  Example: 123123

{
    "type":"object",
    "description":"Object comprising Supervisee parameters.",
    "properties":{
        "supervisorAccountId":{
            "type":"string",
            "description":"Unique identifier for supervisor account.",
            "example":"11445C48-D0BB-4581-AC5A-793DC6405FB8"
        },
        "supervisorAccount":{
            "type":"object",
            "description":"Object comprising Supervisor Account link.",
            "properties":{
                "link":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/SupervisorAccountLink"
                    }
                }
            }
        },
        "userId":{
            "type":"number",
            "format":"int32",
            "description":"Identifier for the user creating the supervisee.",
            "example":123123
        },
        "user":{
            "type":"object",
            "description":"Object comprising Link to the user.",
            "properties":{
                "link":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/UserLink"
                    }
                }
            }
        },
        "integratedFlag":{
            "type":"boolean",
            "example":false,
            "description":"When an Admin changes the supervisor in TEE, it will then synchronize with the LearnCenter. If an Admin maps a user to a supervisor in the LearnCenter, it will be set to 0 for Integrated and so if the Admin makes a change in TEE, it will not affect the LearnCenter supervisor mapping.If the value is set to 1 then any changes made in TEE will reflect in LearnCenter."
        },
        "links":{
            "type":"array",
            "description":"Links to the supervisee.",
            "items":{
                "$ref":"#/definitions/SuperviseeLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Links to the supervisees.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"Links to the supervisees.",
    "items":{
        "properties":{
            "rel":{
                "type":"string"
            },
            "href":{
                "type":"string"
            }
        }
    },
    "example":[
        {
            "rel":"canonical",
            "href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/00B6ECA6-CAEC-4C7E-A4D8-DFF98AB42D21/supervisees"
        }
    ]
}

Example:

[
    {
        "rel":"canonical",
        "href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/00B6ECA6-CAEC-4C7E-A4D8-DFF98AB42D21/supervisees"
    }
]

Nested Schema : links

Type: array

Links to the supervisee.

Show Source

• Array of: object SuperviseeLink

{
    "type":"array",
    "description":"Links to the supervisee.",
    "items":{
        "$ref":"#/definitions/SuperviseeLink"
    }
}

Nested Schema : supervisorAccount

Type: object

Object comprising Supervisor Account link.

Show Source

• link(optional): array link

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

Nested Schema : user

Type: object

Object comprising Link to the user.

Show Source

• link(optional): array link

{
    "type":"object",
    "description":"Object comprising Link to the user.",
    "properties":{
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserLink"
            }
        }
    }
}

Nested Schema : SuperviseeLink

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/31D132DB-33E2-4EE3-870C-06ED25F6CE00/supervisees/123445
• rel(optional): 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/123445"
        }
    }
}

Nested Schema : link

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

Type: array

Show Source

• Array of: object UserLink

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

Nested Schema : UserLink

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/users/456
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/users/456"
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

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

Back to Top