GET restapi/personal/hierarchies/default/v1

Get default hierarchy for the current person.

Could be School if person is a member of only one school or has home organization set, a whole Site otherwise.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Default hierarchy for the current person.

Itslearning.RestApi.Entities.HierarchySimple

Name	Description	Type	Additional information
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:

{
  "HierarchyId": 1,
  "ParentHierarchyId": 2,
  "Title": "sample string 3",
  "Path": "sample string 4",
  "OrganizationType": 0,
  "OrganizationHierarchyId": 5
}

application/xml, text/xml

Sample:

<HierarchySimple xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <HierarchyId>1</HierarchyId>
  <OrganizationHierarchyId>5</OrganizationHierarchyId>
  <OrganizationType>Undefined</OrganizationType>
  <ParentHierarchyId>2</ParentHierarchyId>
  <Path>sample string 4</Path>
  <Title>sample string 3</Title>
</HierarchySimple>