Credentials API
An API to access user credential 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 user credential assignment records for all active users. This will include assignment records for all credentials available in the site.
URL Options
Clients can choose to receive all user credential assignments as of the current date, or all user credential assignments with expiration dates falling within a given range. This includes credential assignments of any status (Active, Inactive, Expired).
Current Day Only
This version of the URL will return all user credential assignment records as of the current day and time.
Example URL (this example URL will not run):
Date Range
If more specific data is required, expiration date parameters can be used to limit the amount of records returned.
ExpirationDateFrom=mm-dd-yyyy
ExpirationDateTo=mm-dd-yyyy
These parameters can be used together or alone. Please note the date format for date parameters can be mm-dd-yyyy or yyyymmdd.
Using Both Parameters: Example URL (this example URL will not run):
In the above example, the URL will return a report of all user credential assignments with expiration dates from 1/114 to 3/31/14.
Using a Single Parameter: Example URL (this example URL will not run):
In the above example, the URL will return a report of all user credential assignments with expiration dates on or after 1/1/14.
Report Options
The CSV report will contain all user credential assignment records for all active and offline users*. 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 |
| Credential |
| Start Date |
| Expiration Date |
| Credential Number |
| Days to Expiration |
| Notes |
| Status |
*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