API Documentation.

Getting Started.

To get started using the ValeLearning API, please review the following sections:

Before you start

You will need:

• A client ID.
• A client Access Token.
• A browser to run your query.
• A command-line tool such as Terminal or an app like Postman that can perform cURL requests (For advanced requests only).

Register with L&D

Before your Client ID and Access Tokens are issued, we need to verify the legitimacy of your application. Please fill out the following form to request a developer account. Developer accounts contain your unique Client ID and Access Tokens.

Verifying your account credentials

Before you can query the API, you need to verify your account. Start by constructing an authorization window URL below, replacing {CLIENT_ID} with your Client ID and {ACCESS_TOKEN} with your Client Access Token.

If the credentials inputted above are valid, you will recieve the following JSONP response. Once recieved, you can start to perform basic queries with the API.

Supported API Queries.

To begin requesting contractor training data, please review the following sections:

Requesting All Contractor Information

You can query the API to recieve a full or ranged export of all contractor information. This is the only query that supports {START} and {END} parameters that target when the profile was last updated or created. Start by constructing an authorization window URL below. In addition to your account credentials, you will need to replace {START} and {END} with a date string (YYYY-MM-DD). If you wish to export all contractors, then you will set both {START} and {END} parameters to "all".

Since responses are formatted in JSONP, all queries require a unique callback. Replace {CALL} with your unique numerical callback.

If contractor accounts where updated or created within your parameters, the profiles will be exported in a JSONP response with your unique callback superseding the object. Please review the example response below:

Requesting a Single Contractor Profile

You can query the API to recieve a contractors full profile in a JSONP response. Start by constructing an authorization window URL below. In addition to your account credentials, you will need to replace {ID} with the contractors Vale Identification. Vale ID's come in many shapes and sizes such as:

• Vale Contractor Pass Number.
• Series C1000 number.
• NORCAT Number.
• Long Harbour 66LCH Number.
• Manitoba MB-C-0 Number.
  
  
  

Since responses are formatted in JSONP, all queries require a unique callback. Replace {CALL} with your unique numerical callback.

If the contractor exists, the profile will be exported in a JSONP response with your unique callback superseding the object. Please review the example response below:

In addition to the contractor information above, each contractor profile includes a full list of training records. Each training module has a unique ID and has five (5) data points. In the example below, the data pertains to Module ID 32 - Tier 1: General Orientation. For a full list of Module ID's, please view the Module ID Reference List.

The list below highlights the values of the JSON response above.

• "ID32": - Module status
• "ID32-CompletedDate": - Module completion date (YYYY-MM-DD)
• "ID32-ExpiryDate": - Module expiry date (YYYY-MM-DD)
• "ID32-Attempts": - Module exam re-attempts
• "ID32-Progression": - Module checkpoint (Only available if the module is in progress)
  
  
  

Requesting Module Completions

You can query the API to recieve module completions in a JSONP response. Start by constructing an authorization window URL below. In addition to your account credentials, you will need to replace {ID} with your desired course ID. You can find the full Module ID Reference List below in this tutorial.

Since responses are formatted in JSONP, all queries require a unique callback. Replace {CALL} with your unique numerical callback.

If the Module ID is valid, contractor profiles will be exported in a JSONP response with your unique callback superseding the object. Please review the example response below:

The list below highlights the values of the JSON response above:

• "CourseID": - The specified module
• "CourseStatus": - Module status
• "CourseCompleted": - Module completion date (YYYY-MM-DD)
• "CourseExpiry": - Module expiry date (YYYY-MM-DD)

Data Request Types

The ValeLearning API delivers data in two (2) formats. JSONP is the default data delivery type. If your application does not support JSONP, you can request the data in a downloadable CSV format for use in Microsoft Excel or simular applications. To request the CSV data type, simply change the {TYPE} object to equal "csv".

Queries that support CSV format:

• Requesting All Contractor Information (get_profiles)
• Requesting a Single Contractor Profile (user_profile)
• Requesting Module Completions (course_export)

Data Request Limits

The ValeLearning API has the following query limits in place:

• 2500 results per query (For basic developer accounts).
• 1 URL request every 5 seconds.
  
  
  

If you need these limits increased, please contact the system administrator.

Training Index ( items).

Module ID Reference List

Below is the full course offerings from ValeLearning.ca. If a new course is added, it will be recorded below.

Modules that have been replaced or removed are listed as depreciated. Contractor profiles may contain records associated with these modules but they are no longer supported or considered valid training.

Sudbury Operations

Port Colborne Operations

Long Harbour Operations

Voisey's Bay Operations

Thompson Operations

Critical Activity Requirements (CAR)

Zero Energy State (ZES)

Supplement Training