GET restapi/personal/courses/{courseId}/tasks/v1?PageIndex={PageIndex}&PageSize={PageSize}&status={status}&deadline={deadline}&isHomework={isHomework}
Gets a list of tasks for the given course.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
courseId |
The course identifier. |
integer |
Required |
PageIndex | integer |
None. |
|
PageSize | integer |
None. |
|
status |
Used for filtering tasks by status |
Itslearning.RestApi.Entities.TaskStatusFilter |
Default value is Active |
deadline |
Used for filtering tasks by deadline |
Itslearning.RestApi.Entities.TaskDeadlineFilter |
Default value is All |
isHomework |
Used for filtering tasks by homework property |
boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
This method return a collection of entity . Each entity is a task that is assigned to the user and is not completed and not hidden.
EntityListOfItslearning.RestApi.Entities.TaskName | Description | Type | Additional information |
---|---|---|---|
EntityArray | Collection of Itslearning.RestApi.Entities.Task |
None. |
|
Total | integer |
None. |
|
CurrentPageIndex | integer |
None. |
|
PageSize | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "EntityArray": [ { "Description": "sample string 1", "LocationTitle": "sample string 2", "LocationFriendlyName": "sample string 3", "TaskId": 4, "Title": "sample string 5", "Status": "Unknown", "Deadline": "2025-06-16T08:40:19Z", "Url": "sample string 6", "ContentUrl": "sample string 7", "IconUrl": "sample string 8", "ElementId": 9, "ElementType": "Unknown", "LearningToolId": 10, "Homework": true, "LocationType": "Course", "LocationId": 1 }, { "Description": "sample string 1", "LocationTitle": "sample string 2", "LocationFriendlyName": "sample string 3", "TaskId": 4, "Title": "sample string 5", "Status": "Unknown", "Deadline": "2025-06-16T08:40:19Z", "Url": "sample string 6", "ContentUrl": "sample string 7", "IconUrl": "sample string 8", "ElementId": 9, "ElementType": "Unknown", "LearningToolId": 10, "Homework": true, "LocationType": "Course", "LocationId": 1 } ], "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> <Task> <ContentUrl>sample string 7</ContentUrl> <Deadline>2025-06-16T08:40:19Z</Deadline> <ElementId>9</ElementId> <ElementType>Unknown</ElementType> <Homework>true</Homework> <IconUrl>sample string 8</IconUrl> <LearningToolId>10</LearningToolId> <LocationId>1</LocationId> <LocationType>Course</LocationType> <Status>Unknown</Status> <TaskId>4</TaskId> <Title>sample string 5</Title> <Url>sample string 6</Url> <Description>sample string 1</Description> <LocationFriendlyName>sample string 3</LocationFriendlyName> <LocationTitle>sample string 2</LocationTitle> </Task> <Task> <ContentUrl>sample string 7</ContentUrl> <Deadline>2025-06-16T08:40:19Z</Deadline> <ElementId>9</ElementId> <ElementType>Unknown</ElementType> <Homework>true</Homework> <IconUrl>sample string 8</IconUrl> <LearningToolId>10</LearningToolId> <LocationId>1</LocationId> <LocationType>Course</LocationType> <Status>Unknown</Status> <TaskId>4</TaskId> <Title>sample string 5</Title> <Url>sample string 6</Url> <Description>sample string 1</Description> <LocationFriendlyName>sample string 3</LocationFriendlyName> <LocationTitle>sample string 2</LocationTitle> </Task> </EntityArray> <PageSize>3</PageSize> <Total>1</Total> </EntityList>