Update Assessment order

patch https://dc1demogwext.paylocity.com/apiHub/performanceManagement/v1/companies/{companyId}/assessmentOrders/{orderId}

🚧
Partner Restricted
All assessment API endpoints are restricted to assessment providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com 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

Path Params

companyId

string

required

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

orderId

string

required

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

Body Params

Assessment order request payload..

partnerTrackingId

string | null

Partner tracking id used for troubleshooting.

overallScore

string | null

An indication of whether the assessee met all necessary predetermined ranges set for the job.

overallScoreDescription

string | null

Description of the overall score.

overallReport

object

Assessment order overall report payload.

assessments

array of objects | null

Collection of assessment results.

assessments

Headers

testMode

boolean

If true all responses are mocked and generated randomly.

Authorization

string

Authorization token. Ex. Bearer ...

Responses

204

No Content - Resource has been deleted.

Language


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://dc1demogwext.paylocity.com/apiHub/performanceManagement/v1/companies/companyId/assessmentOrders/orderId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/*+json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad Request - Returns the details of the error.

404Not Found - Returns the details of the error.

415Unsupported Media Type - Returns the details of the error.