Using the PTP web API extract tool
Please download the WebAPI zip file attached to this Guide. No installation is required, just unzip it to a folder on your machine and launch the ‘WebAPIConsumer.exe’.
Once opened, you will be required to login using your PTP web API credentials (provided to you by K2 Medical Systems):
You will then have 5 options to choose from in the dropdown box as shown below. There is a text box next to the combo box to allow you to enter a custom query. Other than the Audit option it will be ‘?numberWeeksInHistory=52’. You may change the number of weeks value to suit you. Click on the [Request Data] button to run your query.
Note the question mark, it is important!
Combo box options: | Text box value: |
Audit (Returns list of users and their LMS Identifiers) | No query necessary, leave blank and hit ‘Request Data’ |
Progress (Returns all chapter completions for users of all hospitals assigned to the account) | ?numberWeeksInHistory=52 |
SimAggregateScores (Returns Aggregated Simulator Case completions) | ?numberWeeksInHistory=52 |
SimCompletions (returns every sim completion and the respective scores) | ?numberWeeksInHistory=52 |
Once the query has run, your results will be displayed below the drop down box. Hitting ‘Save CSV’ button will save the CSV file in the same folder where the application exe is stored.
You can also specify the time frame over which to extract data. You can select to view different weeks in history or from a specific date. It will override the number of weeks in history.
?numberWeeksInHistory=4 or ?numberWeeksInHistory=52&startDate=2018-11-8
Related Articles
Learning Pathways
As a hospital administrator you will have access to PTP's Learning Pathways feature. As a PTP administrator, you can create and assign Learning Pathways to individuals or groups in your user list. You decide which chapters, assessments and/ or sim ...Purchasing an Individual Licence
If you are not part of a hospital's K2 Perinatal Training Programme (PTP) group but would still like to continue your training, you can purchase an individual licence. An individual licence for PTP can be purchased at our website: ...Group Simulator
Many administrators would like to be able to use the new simulator in a group teaching environment, but do not want to impact their own training progress. The easiest solution is to create a generic user account (e.g. groupsim with a simple ...Managing PTP Users
As an Administrator, you can add or remove users, reset user’s passwords, view user’s progress & amend personal details for any user in your user group. To manage your user group, click on [User Manager] in the left hand menu. This will take you to ...Using the Messaging Service
K2's Perinatal Training Programme has a messaging service feature to facilitate communication between training administrators and users. Clicking on the Messages link in the index on the left side of the Training Programme homepage will display ...