GET restapi/personal/hierarchies/{hierarchyId}/parents/v1?visibleInSearchOnly={visibleInSearchOnly}

Get all parents of a specific hierarchy.

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
visibleInSearchOnly	If true then return only visible is search parents.	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

List of children hierarchies.

Collection of 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
  },
  {
    "HierarchyId": 1,
    "ParentHierarchyId": 2,
    "Title": "sample string 3",
    "Path": "sample string 4",
    "OrganizationType": 0,
    "OrganizationHierarchyId": 5
  }
]

application/xml, text/xml

Sample:

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