GET restapi/personal/hierarchies/defaultforcourse/{courseId}
Get default hierarchy for the current course.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
courseId |
The course ID. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Default hierarchy for the current person.
Itslearning.RestApi.Entities.HierarchySimpleWithMemberCountName | 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 }
application/xml, text/xml
Sample:
<HierarchySimpleWithMemberCount xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <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>