Package

Upsert Assessment Package

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 API endpoint is designed for assessment partners to manage their assessment packages within Paylocity’s platform by using the companyID and the packageID. In this API product, a package is a collection of related assessments, such as a “Skills Battery”, which includes all relevant tests for a job’s skills assessment. There could be multiple tests within a package. A job could also have multiple assessment packages, if needed.

Use Cases

  • Insert or Update: Allows partners to insert new packages or update existing ones. This could involve removing or adding tests into a package
  • Deactivate or Remove: Partners can deactivate a package by setting the status flag or schedule its removal by specifying an endDate
  • Granular Control: By specifying a companyId, partners can target specific Paylocity clients, ensuring tailored assessment offerings
  • Global offering: by using companyId B6001 Partner’s can assign specific assessments for all clients that use your platform
put/apiHub/performanceManagement/v1/companies/{companyId}/assessmentPackages/{packageId}

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}/assessmentPackages/{packageId}
  • 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.

packageIdstring required

Package ID.

Headers

testModeboolean

If true all responses are mocked and generated randomly.

Authorizationstring required

Authorization token. Ex. Bearer ...

Request body

idstring nullable

The unique ID of the package. Required. Max length = 150.

summarystring nullable

A summary of the package. Required. Max length = 250.

namestring nullable

The name of the package. Required. Max length = 250.

Response

Created - Resource has been created.

idstring nullable

The unique ID of the package. Required. Max length = 150.

summarystring nullable

A summary of the package. Required. Max length = 250.

namestring nullable

The name of the package. Required. Max length = 250.

Changes