Follow

Incomplete Assignments API

Incomplete Assignments API

An API to access incomplete assignment data for all users from outside the TargetSolutions system.

Basic Function

A URL containing an encrypted key is given to the client. Clients will access this URL through an http request. When accessed, the request will return a CSV file containing incomplete assignment records for all active users, all courses and all activities available in the client site.

URL Options

Clients can choose to receive all incomplete assignment records as of the current date, or all incomplete assignments falling between a certain start date range and/or due date range.

Current Day Only

This version of the URL will return all incomplete assignment records as of the current day and time.

Example URL (this example URL will not run):

https://app.targetsolutions.com/tsapp/api/?action=reports.buildReport&reportType=incompleteassignments&key=32D4C23ADD5B9286F9DAFE6166E01F5&secret=B9D0FFC80322877B3

Date Range

If more specific data is required, 4 different date parameters can be used to return specific incomplete assignment records.

StartDateFrom=mm-dd-yyyy

StartDateTo=mm-dd-yyyy

DueDateFrom=mm-dd-yyyy

DueDateTo=mm-dd-yyyy

These parameters can be used in any order and any combination. Please note the date format for date parameters can be mm-dd-yyyy or yyyymmdd.

Using a Single Set of Parameters: Example URL (this example URL will not run):

http://app.targetsolutions.com/tsapp/api/?action=reports.buildReport&reportType=incompleteassignments&key=32D4C32ADD5B9286F9DAFE6166E01F5&secret=B9D0FFC80283777B3&StartDateFrom=09-01-2013&StartDateTo=10-01-2013

In the above example, the URL will return a report of all incomplete assignments with a start date occurring from 9/1/2013 to 10/1/13, regardless of due date.

Using All Parameters: Example URL (this example URL will not run):

https://app.targetsolutions.com/tsapp/api/?action=reports.buildReport&reportType=incompleteassignments&key=32D4C32ADD5B9286F9DAFE6166E01F5&secret=B9D0FFC80283777B3&StartDateFrom=09-01-2013&StartDateTo=10-01-2013&DueDateFrom=11-01-2013&DueDateTo=12-31-2013

In the above example, the URL will return a report of all incomplete assignments with a start date occurring from 9/1/2013 to 10/1/13 AND a due date occurring from 11/1/13 to 12/31/14.

Using a Combination of Parameters: Example URL (this example URL will not run):

https://app.targetsolutions.com/tsapp/api/?action=reports.buildReport&reportType=incompleteassignments&key=32D4C32ADD5B9286F9DAFE6166E01F5&secret=B9D0FFC80283777B3&StartDateFrom=09-01-2013&DueDateTo=12-31-2013

In the above example, the URL will return a report of all incomplete assignments with a start date occurring on or after 9/1/2013 AND a due date occurring any date on or before 12/31/14.

Report Options

The CSV report will contain all incomplete assignment records for all active and offline users* and for both courses and activities. The report can contain the following columns, in the following order. These are the only data columns available using this API.

First Name
Last Name
Employee ID
Assignment Name
Assignment Type
Assignment Method
Assigned By
Start Date
Due Date
Days Overdue
Time Spent in Course
Course Status
Tags
Course ID
RMS Code

 


*An offline user is a user who has not yet logged into the program. Once he or she logs in for the first time, their User Status will automatically change to active.


 

Related Articles

Training Records API

Credentials API