Follow

Training Records API

Training Records API

An API for clients to use in order to access course and activity completion data 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 completion records for all active users and all courses and activities available in the client site.

URL Options

Clients can choose to receive all records completed on the day the report is run, or a range of dates.

Current Day Only

This version of the URL will return all records completed on the day the request is made, from 00:00:00 hours to whatever particular time the request is made.

If the request is made again on the same date at a later time, it will return all records completed from 00:00:00 hours to whatever time the second request is made.

Example URL (this example URL will not run):

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

Date Range

If a larger amount of data is required, start and end date parameters can be used to return completions from a specified date range. This type of URL is most common.

This version will return all records completed from 00:00:00 hours on the start date to 23:59:59 hours on the end date.

A request with an end date parameter occurring in the past will return the same results, no matter what date or time the request is made. However, if the end date occurs in the future, than you will only receive the records that have been completed up to whatever particular time the request is made.

Example URL (this example URL will not run):

https://app.targetsolutions.com/tsapp/api/?action=reports.buildReport&reportType=completionsall&key=32D4C32ADD5B9286F9DAFE6166E01F5&secret=B9D0FFC80283777B3&startDate=09-01-2012&endDate=10-01-2012

(Please note the date format for startDate and endDate parameters must be mm-dd-yyyy)

Header Option

The .csv files outputted include a header. You can use an &noheader parameter to eliminate the header.

Example URL (this example URL will not run):

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

Example URL (this example URL will not run):

https://app.targetsolutions.com/tsapp/api/?action=reports.buildReport&reportType=completionsall&&noheaderkey=32D4C32ADD5B9286F9DAFE6166E01F5&secret=B9D0FFC80283777B3&startDate=09-01-2017&endDate=10-01-2017

Report Output

The CSV report will contain all completions made for both courses and activities for all active and offline users[1].

The report can contain the following columns, in the following order. These are the only data columns available using this API.

Employee ID

Email

Assignment Name

Assignment Type

Assigned By

Date Assigned

Date Due

Completion Date

Completion Time

Time Spent In Course

Test Score

Test Attempts

Tags

Course ID

Transcript ID

RMS Code

Duration (hours)

Instructor

Location

Platform Capabilities Related to Report Output

The nature of some platform tools may affect the report output, depending on how they are used by the client.

Record Completions

This application allows activities to be completed for a date occurring in the past. If the record is created after the CSV has already been imported to a third party system for that day, the record will not be entered.

 

Delete Completions

This application allows activity completions to be deleted. If the record is deleted after the CSV has already been imported to a third party system, that system will not be updated with the deleted records.

 


[1] 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.