GET restapi/personal/supervisor/supervised/v1?supervisorType={supervisorType}&PageIndex={PageIndex}&PageSize={PageSize}

Gets a list of all persons current user is a supervisor for - mentorees.

Request Information

URI Parameters

Name	Description	Type	Additional information
supervisorType	[Optional] Required type of a supervisor. If not set or set to NotDefined, method returns only headteacher learners if any, otherwise mentor learners only.	Itslearning.RestApi.Entities.SupervisorType	Default value is NotDefined
PageIndex		integer	None.
PageSize		integer	None.

Body Parameters

None.

Response Information

Resource Description

This method returns a collection of entity . Each entity is a person for which the current user is a supervisor.

EntityListOfItslearning.RestApi.Entities.PersonSimple

Name	Type	Additional information
EntityArray	Collection of Itslearning.RestApi.Entities.PersonSimple	None.
Total	integer	None.
CurrentPageIndex	integer	None.
PageSize	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "EntityArray": [
    {
      "PersonId": 1,
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "FullName": "sample string 4",
      "ProfileUrl": "sample string 5",
      "AdditionalInfo": "sample string 6",
      "ProfileImageUrl": "sample string 7",
      "ProfileImageUrlSmall": "sample string 8"
    },
    {
      "PersonId": 1,
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "FullName": "sample string 4",
      "ProfileUrl": "sample string 5",
      "AdditionalInfo": "sample string 6",
      "ProfileImageUrl": "sample string 7",
      "ProfileImageUrlSmall": "sample string 8"
    }
  ],
  "Total": 1,
  "CurrentPageIndex": 2,
  "PageSize": 3
}

application/xml, text/xml

Sample:

<EntityList xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CurrentPageIndex>2</CurrentPageIndex>
  <EntityArray>
    <PersonSimple>
      <AdditionalInfo>sample string 6</AdditionalInfo>
      <FirstName>sample string 2</FirstName>
      <FullName>sample string 4</FullName>
      <LastName>sample string 3</LastName>
      <PersonId>1</PersonId>
      <ProfileImageUrl>sample string 7</ProfileImageUrl>
      <ProfileImageUrlSmall>sample string 8</ProfileImageUrlSmall>
      <ProfileUrl>sample string 5</ProfileUrl>
    </PersonSimple>
    <PersonSimple>
      <AdditionalInfo>sample string 6</AdditionalInfo>
      <FirstName>sample string 2</FirstName>
      <FullName>sample string 4</FullName>
      <LastName>sample string 3</LastName>
      <PersonId>1</PersonId>
      <ProfileImageUrl>sample string 7</ProfileImageUrl>
      <ProfileImageUrlSmall>sample string 8</ProfileImageUrlSmall>
      <ProfileUrl>sample string 5</ProfileUrl>
    </PersonSimple>
  </EntityArray>
  <PageSize>3</PageSize>
  <Total>1</Total>
</EntityList>