Update Assessment Order

🚧

Partner Restricted

All assessment API endpoints are restricted to assessment providers that have signed a Paylocity technology partnership agreement.
Please reach out to our team if you would like to discuss partnership opportunities.

Summary Description

This endpoint updates the Assessment Order status for the given companyId and OrderId. The patch operation on the candidate status endpoint allows you to update the status of the overall assessment order (package) and the related tests. You can also send the URL where the PCTY user can view the complete assessment result.

Use Cases

  • Customizable Endpoints: The Partner would use this to provide a general endpoint for all Paylocity clients by specifying b6001
  • Notification Management: The Partner would use this endpoint to receive notifications about new orders, errors, and job creation events
  • Please note: When using the ‘Complete’ statuses (Complete, Complete- Review, Expired) on Assessment level, all tests statuses must be in a ‘Complete’ status as well (Complete, Retest Recommended, Expired). See the Order Overview page for more information
Path Params
string
required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.
Allowable Values:
9 char max.

string
required

Unique identifier of the assessment order that was sent to you, the partner.

Body Params

Assessment order request payload..

Assessment order patch payload.

string | null

Partner tracking id used for troubleshooting. Optional.

string | null

An indication of whether the assessee met all necessary predetermined ranges set for the job.
Max length = 30. Optional.

string | null

Description of the overall score.
Max length = 250. Optional.

overallReports
array of objects | null

Reports of the assessment order. Optional.

overallReports
assessments
array of objects | null

Collection of assessment results. Required.

assessments
Headers
boolean

If true all responses are mocked and generated randomly.

string
required

Authorization token. Ex. Bearer ...

string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses
204

No Content - Resource has been updated.

Language
LoadingLoading…
Response
Choose an example:
application/json