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

Get all organisations to which current person belongs to and has specific role.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
role

The required role of the person in organization.

Itslearning.RestApi.Entities.HierarchyRole

Default value is 0

Body Parameters

None.

Response Information

Resource Description

List of organisations.

EntityListOfItslearning.RestApi.Entities.HierarchySimple
NameDescriptionTypeAdditional information
EntityArray

Collection of Itslearning.RestApi.Entities.HierarchySimple

None.

Total

integer

None.

CurrentPageIndex

integer

None.

PageSize

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "EntityArray": [
    {
      "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
    }
  ],
  "Total": 1,
  "CurrentPageIndex": 2,
  "PageSize": 3
}

application/xml, text/xml

Sample:
<EntityList xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CurrentPageIndex>2</CurrentPageIndex>
  <EntityArray>
    <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>
  </EntityArray>
  <PageSize>3</PageSize>
  <Total>1</Total>
</EntityList>