POST restapi/personal/courses/{courseId}/resources/extended/v1?PageIndex={PageIndex}&PageSize={PageSize}

Returns all resources in course.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
PageIndex

integer

None.

PageSize

integer

None.

courseId

ID of course

integer

Required

Body Parameters

Request parameters

Itslearning.RestApi.Entities.Personal.Course.GetCourseResourcesPayload
NameDescriptionTypeAdditional information
ElementType

Type of element

Itsolutions.ItslUtils.Constants.ElementType

None.

LearningToolIds

IDs of learning tool (extension IDs)

Collection of integer

None.

LearningToolType

Type of learning tool

Itslearning.Platform.RestApi.Sdk.Common.Entities.LearningToolType

None.

ElementPermission

Permissions for the element

Itslearning.Platform.RestApi.Sdk.LearningToolApp.Entities.ElementPermission

None.

ElementIds

Element IDs

Collection of integer

None.

IncludeDeleted

Whether to include deleted resources

boolean

None.

IncludeExtraWorkElements

Whether to include extra work elements

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "ElementType": 0,
  "LearningToolIds": [
    1,
    2
  ],
  "LearningToolType": 0,
  "ElementPermission": 0,
  "ElementIds": [
    1,
    2
  ],
  "IncludeDeleted": true,
  "IncludeExtraWorkElements": true
}

application/xml, text/xml

Sample:
<GetCourseResourcesPayload xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ElementIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ElementIds>
  <ElementPermission>All</ElementPermission>
  <ElementType>Post</ElementType>
  <IncludeDeleted>true</IncludeDeleted>
  <IncludeExtraWorkElements>true</IncludeExtraWorkElements>
  <LearningToolIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </LearningToolIds>
  <LearningToolType>LearningResource</LearningToolType>
</GetCourseResourcesPayload>

application/x-www-form-urlencoded

Sample:
No sample available

Response Information

Resource Description

EntityListOfItslearning.RestApi.Entities.Personal.Course.CourseResource
NameDescriptionTypeAdditional information
EntityArray

Collection of Itslearning.RestApi.Entities.Personal.Course.CourseResource

None.

Total

integer

None.

CurrentPageIndex

integer

None.

PageSize

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "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
}

application/xml, text/xml

Sample:
<EntityList xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <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>
</EntityList>