GuidesAPI ReferenceChangelog

Order

Overview

The patch operation on the assessee status endpoint allows you to update the status of the overall assessment order and relay the results of the assessment. You can also send the URL where the requester can view the complete assessment result.

PropertyTypeRequired/OptionalDescription
partnerTrackingIdstringOptionalPartner tracking id used for troubleshooting.
overallScorestring

Max length = 30
OptionalAn indication of if the assessee met all necessary predetermined ranges set for the job.
overallScoreDescriptionstring

Max length = 250
OptionalDescription of the overall score.
overallReportobjectOptionalCombined report of all of the assessments within a package.
overallReport.namestring

Max length = 50
OptionalThe name of the report.
overallReport.urlstring

Max length = 250
OptionalThe URL of the report that can be viewed on the partners web application.
assessmentResultsObject of assessments resultsOptionalThe object of the results for an assessment.
assessmentResults.Scorestring

Max length = 30
OptionalScore for the assessment, which could be made up of one or multiple tests.
assessmentResults.ScoreDescriptionstring

Max length = 250
OptionalDescription of the assessment score.
assessmentResults.ReportObjectOptionalReport for the assessment order, could contain one or multiple tests.
assessmentResults.report..namestring

Max length = 50
OptionalThe name of the report
assessmentResults.report..urlstring

Max length = 250
OptionalThe URL of the report that can be viewed on the partners web application.
testsArray of tests resultsOptional
tests.idString
Max length = 36
RequiredID of the test
tests.score.valueString
Max length = 50
RequiredThe value of the score
tests.score.descriptionString
Max length = 250
OptionalThe description of the score

This is an optional field where you can add description of what the score means for the assessee relative to the job posting.
tests.score.attemptintOptionalThe attempt of the test
tests.score.reports.nameString
Max length = 50
OptionalThe name of the report
tests.score.reports.urlString
Max length = 250
OptionalThe URL of the report that can be viewed on the partners web application.
tests.statusobjectOptionalTest status with test.
tests.status.updatedAtstring (date-time format. Ex: 2023-01-13T11:45:44.815Z)RequiredThe date and time when the assessment test was updated.
tests.status.valuestringRequiredThe new status of the assessment test.

Business Logic Notes

  • Tests collection update logic is the following: every new combination of id and attempt creates a new record in AssessmentOrderTests table (which represents test attempts); if API gets a request to update a test with id and attempt number already existing in the database, then it updates the corresponding record;
  • Reports collection for already existing test attempt always gets updated by simply adding newly provided items to the existing collection.

For statuses and their application see the below example:

  • Software Engineer II (name of package)
    • Software Engineer Skills (name of the assessment battery)
      • JavaScript code challenge (name of test)
      • Ruby code challenge (name of test)

There will not be a status on the name of package, but there will be the ability to provide a status on the assessment battery level and the individual test level. The above example would translate into the below for statuses:

  • Software Engineer Skills - In Progress
    • JavaScript code challenge – Complete
    • Ruby code challenge - Not started

Assessment Battery Level: The table below explains the order statuses with the relevant definitions.

StatusDefinition
OrderedDefault status when the assessmentrequest is submitted. Assessmentpartner doesnt have to send this back to PCTY since its the default status.
WaitingOnAssesseeWhen the assessment partner has initiated the assessment process by emailing the assessee.
InProgressWhen the assessee started at least one test in the assessment battery. At this point the assessment is in progress, and we are waiting for the candidate to complete all tests part of the assessment battery.
HoldWhen more information is requested from the assessee or employee to run the assessment.
CompleteWhen the assessment is complete. At this point all the underlying assessment tests are completed and a final report is available to the client.
Complete - ReviewThis can be used when all the tests that are part of the assessment are taken but at least one but not all tests are flagged for retest.
Retest RecommendedThis can be used when all tests in the assessment are recommended for retesting.
ExpiredThis will be used when the assessment was sent to the assessee, but the assessee never started the assessment and/or it was started but never completed.

This is up to the partner and clients to determine when expired status should be sent. This status will function the same as a ‘complete’ status.

Individual Test Level: The table below explains the order statuses with the relevant definitions.

StatusDefinition
PendingDefault status when the assessment request is submitted. Assessment partner doesn’t have to send this back to PCTY since it’s the default status.
InProgressThis can be used when the assessee has started the assessment. At this point the assessment is in progress, and we are waiting for the candidate to complete.
HoldWhen more information is requested from the assessee and/or client to send the assessment.
CompleteWhen the assessment is complete. At this point all the underlying assessment tests are completed and a final report is available to the client.
Retest RecommendedUsed when partner recommends that a certain test the assessee took should be retaken.
ExpiredUsed when the assessment test invite expired and candidate would need to be resent an assessment test to complete.


Copyright © 2024 Paylocity. All Rights Reserved. Privacy Center | Terms and Conditions | Accessibility