GET restapi/personal/hierarchies/{hierarchyId}/v1?role={role}

Get all members of a specific hierarchy with the given role.

Returns HTTP status 404 not found, if the hierarchyId does not exist for the user or user has no permission to read it.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
hierarchyId

The identifier of the hierarchy.

 integer

Required
role

Required role.

 Itslearning.RestApi.Entities.HierarchyRole

Default value is 0

Body Parameters

None.

Response Information

Resource Description

List of members.

Collection of Itslearning.RestApi.Entities.PersonSimple
NameDescriptionTypeAdditional information
PersonId

The unique id for for the person, in scope of a site (itslearning customer).

 integer

None.
FirstName

The person's first name. It can only be used when first name is displayed without last name. Otherwise must be used.

 string

None.
LastName

The person's last name. It can only be used when last name is displayed without first name. Otherwise must be used.

 string

None.
FullName

The person's full name formatted according to regional settings of a site.

 string

None.
ProfileUrl

The url to view the person's profile in itslearning.

 string

None.
AdditionalInfo

Additional information about the person. This can be context sensitive. For example when using the rest api method for message recipients search, this field can contain extra information about the person, that helps the user distinguish between persons with identical names.

 string

None.
ProfileImageUrl

The absolute URL to the person's profile image. This can be null or empty if the person does not have a profile image.

 string

None.
ProfileImageUrlSmall

The absolute URL to the person's profile image. This can be null or empty if the person does not have a profile image.

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "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"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfPersonSimple xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <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>
</ArrayOfPersonSimple>