GET restapi/personal/courses/{courseId}/searchhierarchies/v1?searchText={searchText}

Search syncable hierarchies for the course provided

Request Information

URI Parameters

Name	Description	Type	Additional information
courseId	The course id.	integer	Required
searchText	The text to search for. Example usage ?searchText=class%20B2	string	Required

Body Parameters

None.

Response Information

Resource Description

The matching hierarchies with member count

EntityListOfItslearning.RestApi.Entities.HierarchySimpleWithMemberCount

Name	Type	Additional information
EntityArray	Collection of Itslearning.RestApi.Entities.HierarchySimpleWithMemberCount	None.
Total	integer	None.
CurrentPageIndex	integer	None.
PageSize	integer	None.

Response Formats

application/json, text/json

Sample:

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