GET restapi/personal/courses/{locationId}/resources/search/v1?locationType={locationType}&searchText={searchText}
Gets a list of resources in a given course, matching the search text provided
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
locationId |
The course or project identifier |
integer |
Required |
locationType |
The type of the location identifier |
Itsolutions.ItslUtils.Constants.LocationType |
Required |
searchText |
The search text |
string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
A collection of resources
Itslearning.RestApi.Entities.Personal.Course.CourseFolderDetailsName | Description | Type | Additional information |
---|---|---|---|
Resources |
List of resources in a folder. |
EntityListOfItslearning.RestApi.Entities.Personal.Course.CourseResource |
None. |
AddElementUrl |
Url to itslearning to add new element. It's empty if user doesn't have permissions to add new element. |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Resources": { "EntityArray": [ { "Title": "sample string 1", "ElementId": 2, "ElementType": "Unknown", "CourseId": 3, "Url": "sample string 4", "ContentUrl": "sample string 5", "IconUrl": "sample string 6", "Active": true, "LearningToolId": 8, "AddElementUrl": "sample string 9", "Homework": true, "Path": "sample string 11", "LearningObjectId": 12, "LearningObjectInstanceId": 13 }, { "Title": "sample string 1", "ElementId": 2, "ElementType": "Unknown", "CourseId": 3, "Url": "sample string 4", "ContentUrl": "sample string 5", "IconUrl": "sample string 6", "Active": true, "LearningToolId": 8, "AddElementUrl": "sample string 9", "Homework": true, "Path": "sample string 11", "LearningObjectId": 12, "LearningObjectInstanceId": 13 } ], "Total": 1, "CurrentPageIndex": 2, "PageSize": 3 }, "AddElementUrl": "sample string 1" }
application/xml, text/xml
Sample:
<CourseFolderDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <AddElementUrl>sample string 1</AddElementUrl> <Resources> <CurrentPageIndex>2</CurrentPageIndex> <EntityArray> <CourseResource> <Active>true</Active> <AddElementUrl>sample string 9</AddElementUrl> <ContentUrl>sample string 5</ContentUrl> <CourseId>3</CourseId> <ElementId>2</ElementId> <ElementType>Unknown</ElementType> <Homework>true</Homework> <IconUrl>sample string 6</IconUrl> <LearningObjectId>12</LearningObjectId> <LearningObjectInstanceId>13</LearningObjectInstanceId> <LearningToolId>8</LearningToolId> <Path>sample string 11</Path> <Title>sample string 1</Title> <Url>sample string 4</Url> </CourseResource> <CourseResource> <Active>true</Active> <AddElementUrl>sample string 9</AddElementUrl> <ContentUrl>sample string 5</ContentUrl> <CourseId>3</CourseId> <ElementId>2</ElementId> <ElementType>Unknown</ElementType> <Homework>true</Homework> <IconUrl>sample string 6</IconUrl> <LearningObjectId>12</LearningObjectId> <LearningObjectInstanceId>13</LearningObjectInstanceId> <LearningToolId>8</LearningToolId> <Path>sample string 11</Path> <Title>sample string 1</Title> <Url>sample string 4</Url> </CourseResource> </EntityArray> <PageSize>3</PageSize> <Total>1</Total> </Resources> </CourseFolderDetails>