Common Parameters / Objects / Enumerated Values

Below are common attributes, features, parameters and objects used in the APIs.

Assessment State/Status

The following statuses may be returned in theassessmentState property of any assessment-related API call (such as GET behavioralassessments) or in the body of an assessmentStatusWebHook call, as described below:

10 - Sent
20 - Opened
30 - Started
40 - Completed
50 - Expired
60 - Failed
65 - Aborted

Assessment Status WebHooks

TheassessmentStatusWebHook property section has been moved to its own article: Webhooks

Person Type

The following values may be returned in thepersonType property of any assessment-related API call (such as GET behavioralassessments), as described below:

1 - Unknown
2 - Other
3 - Candidate
4 - Employee
5 - Former Employee

Gender

Although the Predictive Index platform does not require or offer to collect gender information for all supported languages, the following values may be returned in thegender property of any assessment-related API call (such as GET behavioralassessments), as described below:

0 - Unknown / Unspecified
1 - Male
2 - Female

Candidate Impression

The candidate impression field aims to support a tentative overall impression. Although support for the use of the impression field is still not fully implemented in the PI software, the following values may be returned in the impression property of any assessment-related API response as described below:

0 - Unset
1 - Favorite