PApaylocity
Order

Update Assessment Order

Changed on

🚧 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
patch/apiHub/performanceManagement/v1/companies/{companyId}/assessmentOrders/{orderId}

Request

  • Base URL
    dc1demogwext.paylocity.com (relative, and the document’s source URL is not known)
  • URL
    dc1demogwext.paylocity.com/apiHub/performanceManagement/v1/companies/{companyId}/assessmentOrders/{orderId}
  • Auth
    none declared. Required headers: Authorization

Path parameters

companyIdstring required

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

orderIdstring required

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

Headers

testModeboolean

If true all responses are mocked and generated randomly.

Authorizationstring required

Authorization token. Ex. Bearer ...

Request body

partnerTrackingIdstring nullable

Partner tracking id used for troubleshooting. Optional.

overallScorestring nullable

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

overallScoreDescriptionstring nullable

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

Response

No Content - Resource has been updated.

Changes