Overview
A Package is essentially a combined group of assessment services that Paylocity's customer has already created on a partners platform. As an example, a Package could be “Personality test” which includes all questions that would be applicable in the personality test for the job. An assessment partner platform can combine several such assessments, which are individual tests, and bundle up into a single assessment package with unique name and ID.
A PUT on the /assessmentPackages endpoint inserts or updates a list of the packages defined for Paylocity's customers. As an assessment partner, you can also remove any package which is not active by using the status value flag, or set end date on the package in order to remove the package information from Paylocity's UI. Paylocity will prevent any future orders using this package id, however, any in-flight assessment orders should still be processed by your platform.
Paylocity can support different assessment packages for every company you partner with. If the company is b6001 in the request URL then the assessmentpackages will be applicable for all the Paylocity companies, however, if you want to send assessment packages at a company level then use the specific companyId in the request which will allow you granular control on your offerings to our mutual customers.
| Property | Type | Required/Optional | Description |
|---|---|---|---|
| id | string Max length = 36 | Required | The unique ID of the package. |
| status | object | Required | Package status. It contains information about package validity. |
| status.startDate | DateTime | Required | Start date of package validity. For immediate start use DateTime.UtcNow |
| status.endDate | DateTime | Optional | End date of package validity. If package doesn’t have expiration date, this field should be null. |
| status.value | Enum | Optional | Status value. Possible values: “Active, Inactive, Deleted, Unknown”. If value is not provided it will be calculated based on start/end date. |
| summary | string Max length = 250 | Required | A summary of the package. |
| name | string Max length = 50 | Required | The name of the package. |
| assessments | array | Required | An array of objects representing the assessments included in the package. Each object contains the following properties: |
| assessment.id | string Max length = 36 | Required | The unique ID of the assessment. |
| assessment.name | string Max length = 50 | Required | The name of the assessment. |
| assessment.summary | string Max length = 250 | Required | A summary of the assessment. |
| assessment.tests.id | Guid string Max length = 36 | Required | ID of the test |
| assessment.tests.name | string Max length = 50 | Required | Name of the test |
| assessment.tests.category | string Max length = 50 | Required | Category of the test |
| assessment.tests.description | string Max length = 250 | Required | Description of the test |