GET restapi/personal/hierarchies/{hierarchyId}/childrenwithmembercountforcourse/v1?courseId={courseId}

Get all children of a specific hierarchy, with a count of how many members the hierarchy has.

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

Name	Description	Type	Additional information
hierarchyId	The identifier of the hierarchy.	integer	Required
courseId	[OPTIONAL] The course ID. Required if synchable is true. Example usage ?courseid=20	integer	Default value is -1

Body Parameters

None.

Response Information

Resource Description

List of children hierarchies.

Collection of Itslearning.RestApi.Entities.HierarchySimpleWithMemberCount

Name	Description	Type	Additional information
NumberOfMembers	Numbers of members in the hierarchy level	integer	None.
HasChildren	Has child hierarchies	boolean	None.
Synchable	Can be synchronised	boolean	None.
Inspectable	Can be inspected	boolean	None.
HierarchyId	Gets or sets the hierarchy id.	integer	None.
ParentHierarchyId	Gets or sets the parent hierarchy id.	integer	None.
Title	Gets or sets the title.	string	None.
Path	Gets or sets the hierarchy's path within the hierarchy tree.	string	None.
OrganizationType	Gets or sets the type of the hierarchy.	Itslearning.Platform.RestApi.Sdk.LearningToolApp.Entities.OrganizationType	None.
OrganizationHierarchyId	Gets or sets the organization id to which the hierarchy belongs to.	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "NumberOfMembers": 1,
    "HasChildren": true,
    "Synchable": true,
    "Inspectable": true,
    "HierarchyId": 5,
    "ParentHierarchyId": 6,
    "Title": "sample string 7",
    "Path": "sample string 8",
    "OrganizationType": 0,
    "OrganizationHierarchyId": 9
  },
  {
    "NumberOfMembers": 1,
    "HasChildren": true,
    "Synchable": true,
    "Inspectable": true,
    "HierarchyId": 5,
    "ParentHierarchyId": 6,
    "Title": "sample string 7",
    "Path": "sample string 8",
    "OrganizationType": 0,
    "OrganizationHierarchyId": 9
  }
]

application/xml, text/xml

Sample:

<ArrayOfHierarchySimpleWithMemberCount xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <HierarchySimpleWithMemberCount>
    <HierarchyId>5</HierarchyId>
    <OrganizationHierarchyId>9</OrganizationHierarchyId>
    <OrganizationType>Undefined</OrganizationType>
    <ParentHierarchyId>6</ParentHierarchyId>
    <Path>sample string 8</Path>
    <Title>sample string 7</Title>
    <HasChildren>true</HasChildren>
    <Inspectable>true</Inspectable>
    <NumberOfMembers>1</NumberOfMembers>
    <Synchable>true</Synchable>
  </HierarchySimpleWithMemberCount>
  <HierarchySimpleWithMemberCount>
    <HierarchyId>5</HierarchyId>
    <OrganizationHierarchyId>9</OrganizationHierarchyId>
    <OrganizationType>Undefined</OrganizationType>
    <ParentHierarchyId>6</ParentHierarchyId>
    <Path>sample string 8</Path>
    <Title>sample string 7</Title>
    <HasChildren>true</HasChildren>
    <Inspectable>true</Inspectable>
    <NumberOfMembers>1</NumberOfMembers>
    <Synchable>true</Synchable>
  </HierarchySimpleWithMemberCount>
</ArrayOfHierarchySimpleWithMemberCount>