GET restapi/personal/hierarchies/{hierarchyId}/members/v2?PageIndex={PageIndex}&PageSize={PageSize}&courseContext={courseContext}

Get all members and their role in the specified hierarchy. Will only return members the calling user is allowed to see.

Request Information

URI Parameters

Name	Description	Type	Additional information
hierarchyId	The identifier of the hierarchy.	integer	Required
PageIndex		integer	None.
PageSize		integer	None.
courseContext	[OPTIONAL] A course context to consider while fetching members	integer	None.

Body Parameters

None.

Response Information

Resource Description

EntityList of members with role

EntityListOfItslearning.RestApi.Entities.PersonSimpleWithHierarchyRoleAndCourseMembership

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

Response Formats

application/json, text/json

Sample:

{
  "EntityArray": [
    {
      "MemberInCourse": true,
      "HierarchyRole": "sample string 2",
      "PersonId": 3,
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "FullName": "sample string 6",
      "ProfileUrl": "sample string 7",
      "AdditionalInfo": "sample string 8",
      "ProfileImageUrl": "sample string 9",
      "ProfileImageUrlSmall": "sample string 10"
    },
    {
      "MemberInCourse": true,
      "HierarchyRole": "sample string 2",
      "PersonId": 3,
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "FullName": "sample string 6",
      "ProfileUrl": "sample string 7",
      "AdditionalInfo": "sample string 8",
      "ProfileImageUrl": "sample string 9",
      "ProfileImageUrlSmall": "sample string 10"
    }
  ],
  "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 xmlns:d2p1="http://schemas.datacontract.org/2004/07/Itslearning.RestApi.Entities">
    <d2p1:PersonSimpleWithHierarchyRoleAndCourseMembership>
      <AdditionalInfo>sample string 8</AdditionalInfo>
      <FirstName>sample string 4</FirstName>
      <FullName>sample string 6</FullName>
      <LastName>sample string 5</LastName>
      <PersonId>3</PersonId>
      <ProfileImageUrl>sample string 9</ProfileImageUrl>
      <ProfileImageUrlSmall>sample string 10</ProfileImageUrlSmall>
      <ProfileUrl>sample string 7</ProfileUrl>
      <HierarchyRole>sample string 2</HierarchyRole>
      <d2p1:MemberInCourse>true</d2p1:MemberInCourse>
    </d2p1:PersonSimpleWithHierarchyRoleAndCourseMembership>
    <d2p1:PersonSimpleWithHierarchyRoleAndCourseMembership>
      <AdditionalInfo>sample string 8</AdditionalInfo>
      <FirstName>sample string 4</FirstName>
      <FullName>sample string 6</FullName>
      <LastName>sample string 5</LastName>
      <PersonId>3</PersonId>
      <ProfileImageUrl>sample string 9</ProfileImageUrl>
      <ProfileImageUrlSmall>sample string 10</ProfileImageUrlSmall>
      <ProfileUrl>sample string 7</ProfileUrl>
      <HierarchyRole>sample string 2</HierarchyRole>
      <d2p1:MemberInCourse>true</d2p1:MemberInCourse>
    </d2p1:PersonSimpleWithHierarchyRoleAndCourseMembership>
  </EntityArray>
  <PageSize>3</PageSize>
  <Total>1</Total>
</EntityList>