GetTasks2
GetTasks2(string APIKeyHeader, string Message, string PIDs, string UserID, string IDs, string TaskStatus, dateTime StartDate, dateTime EndDate, int ExtentionDays, bool ShowNotReady)
Retrieves all the tasks for one or more UserIDs.
Inputs: <InputParameter>
Properties | Attribute Type | Description |
---|---|---|
DataSourceID: string | Message Header |
Outputs: <OutputParameter>
Properties | Attribute Type | Description |
---|---|---|
TransactionID: long | Message Header | |
Message: string | Message Header |
Notes
For the parameter TaskStatus
- When TaskStatus = “completed”, GetTasks2() returns only completed tasks.
- When TaskStatus = “inprogress”, GetTasks2() returns only tasks that are in progress but not completed yet.
- When TaskStatus = “open”, GetTasks2() returns only tasks that are open.
- When TaskStatus = “notcompleted”, GetTasks2() tasks are either open, in progress or not ready tasks.
- When TaskStatus = “”, GetTasks2() returns tasks with all possible status.
When only tasks from one student is wanted, apply null for parameter PIDs and IDs.
Parameters StartDate and EndDate are for future functional expansion. Right now they have no effect on the returned records.
Parameter ExtentionDays is used to specify the returned records that include tasks which are how many days after task expiry date. Zero means not including expired tasks.
Parameter ShowNotReady is used to specify if the returned records contains “not ready” tasks.
Note: the returned TaskStatus for each task contains the following possible values:
- 0 means open
- 1 means in progress
- 2 means completed
- 3 means not ready (for example: the task start date has not been met yet)
GetTasks2() can be used in a customized grade blocking mechanism since it can retrieve course evaluation tasks for a student.