Assessments
All Performance Learning assessments are tailored for specific learners. To access an assessment you need your authorization API KEY as well as a learner_id. To find out how to obtain an API KEY, read up on Authentication. To find out how to register users/learners, read up on Learner Registration.
Getting the next available assessment
Endpoint: GET https://app.plex.coach/plapi/v1/partners/assessments/next-assessment
This is a GET Request. See the requirements and response schema below.
HEADER PARAMETERS{apikey: 'string' (Your API KEY),learnerid: 'string'}
Response
{"status": "string","assessment_id": 0,"target_group": "string","assessment_version": 0}
We recommend storing your assesment_id, you will need it to access the assessment's results.
Fetch Assessment Content
Endpoint: GET https://app.plex.coach/plapi/v1/partners/assessments/view-assessment/{assessment_id}
This a GET request. You need an assessment_id as a path parameter. See the requirements and sample response below.
HEADER PARAMETERS{apikey: 'string' (Your API KEY),learnerid: 'string'}
PATH PARAMETERS{assessment_id: integer}
Response
We recommend keeping a count of questions for a comparison before submission. To avoid any errors, the number of responses should match the number of questions. Use the DisplayOrder property to arrange the display of the questions. The assessment_session property will be used for submission.
{{"questions": [{"id": "361","Question": "This is the next question to be answered","Group": "Time management","Created": "2019-09-30T08:21:45.363954+00:00","DisplayOrder": 1,"UpdatedDateTime": "2019-11-20T14:48:09.699870+00:00","answers": [{"id": "1900","Question": "This is the next question to be answered","QuestionId": "361","DisplayOrder": 1,"AnswerCopy": "Answer 1","Icon": "1"}]},{"id": "360","Question": "This is the question to be answered","Group": "Time management","Created": "2019-09-30T08:20:53.218784+00:00","DisplayOrder": 2,"UpdatedDateTime": "2019-11-20T14:48:09.703797+00:00","answers": [{"id": "1899","Question": "This is the question to be answered","QuestionId": "360","DisplayOrder": 1,"AnswerCopy": "Answer 1","Icon": "1"}]}],"assessment_session": "61980120302267","assessment_info": {"Title": "1.0 test assessment","Level": "PLOA_FE","Preassess": false,"Version": 1.0,"id": 34}}}
Submitting the Assessment
Endpoint: POST https://app.plex.coach/plapi/v1/partners/assessments/submit-assessment
This is a POST request. The assessment payload must contain responses and the provided session. See the requirements below. Success or failure feedback will adhere to the response codes provided in this table.
HEADER PARAMETERS{apikey: 'string' (Your API KEY),learnerid: 'string'}
Request body schema
{"responses": [ ],"session": 0}
Viewing Assessment Results
Endpoint: GET https://app.plex.coach/plapi/v1/partners/assessments/results/{assessment_id}
Access assessment results using an assessment_id as a PATH PARAMETER. See below the parameters and a truncated sample of the response.
HEADER PARAMETERS{apikey: 'string' (Your API KEY),learnerid: 'string'}
PATH PARAMETERS{assessment_id: integer}
Response
{"PLOAScore": 52.9,"RiskLevel": "Moderate Alert 2","TraitSigns": "<ul>\n\t<li>Overwhelmed and poor resilience/capacity to handle pressure</li>\n\t<li>Average - good lesson engagement and participation</li>\n\t<li>Fluctuation in quality of work</li>\n\t<li>Easily influenced by lower performing learners</li>\n\t<li>Good in certain subjects, poor in others</li>\n\t<li>Mostly alert and enthusiastic to learn and improve (in control)</li>\n\t<li>Shows up when told</li>\n</ul>","TraitTitle": "Good Behaviour, Struggles to be Organised & Poor Retention","TraitTips": "In order for this learner to develop into lower risk areas they must focus on developing the following skills:</p>\n<ol type=\"\"A\"\">\n <li>Revision schedules and time management</li>\n <li>Learn to work towards outcomes</li>\n <li>Dissect work into digestible ‘chunks’</li>\n <li>Improve their ‘take in’ of information</li>\n <li>Improve recovery of information</li>\n <li>Learn how to take notes efficiently and manage weekly workload</li>\n</ol>\"","TraitCopy": "Very good behaviour but struggles to stay organised and to retain and recall information. Participates in lessons but needs to improve their overall skill base.","ResultDescription": "<h3>Learners in this category may work hard and as a result easily maintain good levels of progress and attainment and this leads to good assessment outcomes. They are the group with the highest potential for improvement, and with additional effort can reach the higher boundaries of assessment outcomes.</h3>\n<p>The severe challenges in behaviour that those in the high/ extremely high risk areas face are virtually non-existent. However in lesson context, learners in this category may get distracted by higher risk learners. These learners may be all-round good performers - they complete their work on time, are fairly engaged in lessons and mostly stay out of trouble - but they do feel overwhelmed when under pressure.</p>\n<p>Their stress threshold may be low, and they may regularly lose marks due to careless mistakes. They tend to feel anxious in tests and may dislike being tested on a regular basis. They likely revise for tests but it may not be until the last few months (consistent cramming and last-minute pushes get them through to the finish line). </p>\n<p>Their time management and memory is average to above average, hence assessment grades may fall within pass grades or the middle ground of assessment outcomes and not higher grade outcomes. When shown what to do, they will typically do it, but need to be checked upon and motivated carefully, otherwise they have the potential to drop a grade very easily.</p>","focus_areas": [{"search_filter_name": "SLEEP & TIREDNESS","needs_help": "no","questions_count": 0},{"search_filter_name": "RETAINING & RECALLING INFORMATION","needs_help": "no","questions_count": 0},{"search_filter_name": "EXAM ANXIETY","needs_help": "no","questions_count": 0},{"search_filter_name": "FOCUS & MOTIVATION","needs_help": "no","questions_count": 0},{"search_filter_name": "ORGANIZATION & TIME MANAGEMENT","needs_help": "no","questions_count": 0},{"search_filter_name": "STRESS & STRAIN","needs_help": "no","questions_count": 0},{"search_filter_name": "CONFIDENCE","needs_help": "no","questions_count": 0}]}