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 the assessmentState 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

The assessmentStatusWebHook property section has been moved to its own article: Webhooks

Person Type

The following values may be returned in the personType 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 the gender 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
2 - Rejected

Scoring Method

There are several avenues by which assessments responses are collected in the PI platform. These are known internally as scoring methods. When this value appears in API results, this does not imply that scores are calculated differently based on each method (calculations are the same for all methods), but it only describes which mechanism was used to offer the assessment and collect responses:

1 - Email Invitation sent to an individual assessment taker through the PI platform
2 - Checklist - assessment administrator manually transcribes the written responses recorded by assessment taker on a printed assessment
3 - Open Invitation Link - a pre-configured, unique web link shared with assessment takers requiring them to enter their own name and email before completing the assessment via the PI Classic software - like #9
4 - Datasheet - assessment administrator enters one or more assessments via the PI Classic software
5 - Combined Pattern - legacy scoring method used to combine results across versions of the Behavioral assessment
6 - Datasheet ScoreID - same as #4 except that assessment taker enters a Behavioral Score ID belonging to a previously completed assessment which copies previous responses into current assessment
7 - Email Invitation ScoreID - same as #1 but using Behavioral Score ID to copy previous responses
8 - Open Invitation ScoreID - same as #3 but using Behavioral Score ID to copy previous responses
9 - Open Invitation 2.0 - same as #3 but using new settings developed in the New PI Experience software

Date and Time

All date and time values are expressed in UTC using the ISO 8601 standard.

ISO 8601 date and time format

Example: "2015-01-31T23:59:59.0123456Z"

Behavioral Pattern Reference Profiles

There are 17 general behavioral pattern clusters known as "Reference Profiles" identified in the Predictive Index Behavioral Assessment results.

Learn about Reference Profiles here: https://www.predictiveindex.com/reference-profiles

IMPORTANT NOTE: Historically Predictive Index used pattern numbers to classify numerous PI pattern groupings. This practice is no longer being emphasized in favor of the smaller collection of 17 Reference Profiles. As a developer, you cannot use the originalPatternNumber property (sometimes named patternNumber) to determine the correct Reference Profile -- there is not a strict 1-to-1 mapping relationship between them. Several original patternNumbers are associated with more than one Reference Profile because the boundaries have been defined slightly differently.

To obtain the reference profile name via the API, use one of the following two methods:

GET /api/v2/peopleandjobs/{assessmentUserId} - returns the reference profile name in property: referencePatternInformation/name
GET /api/v2/behavioralassessments/{assessmentId}/guidebook - returns the reference profile name in property: referencePattern/name

The 17 reference profile names and descriptions are as follows:
*NOTE: Reference Profile ID is similar to but not the same as the original patternNumber!

Reference Profile Name	Reference Profile Description	Reference Profile ID*
Adapter	Flexible and situational. Ability to work with different people and adjust style as needed.	0
Venturer	Self-starter, self-motivator, risk-taker with a goal-oriented mind.	8
Strategist	Results-oriented, innovative, and analytical with a drive for change.	10
Analyzer	Analytical and technical, strong drive for ownership and need for rules and structure.	12
Controller	Focused on quality outcomes and control over work. Analytical and technical.	14
Specialist	Structured, highly detailed. Reserved and analytical, while respecting authority.	20
Scholar	Thorough, careful, and structured. Authoritative and direct. Consistent follow up.	22
Individualist	Highly independent and persistent, while remaining results-oriented.	24
Captain	Problem-solver, risk-taker, self-starter. Drive to control big picture, independent.	26
Maverick	Risk-taker and big picture thinker. Not afraid of taking action.	30
Persuader	Persuasive, risk-taker. Quick to connect and strong drive for results.	36
Altruist	Team player, fast pace, quick to connect. Drive to do things quickly and correctly.	46
Collaborator	A friendly, understanding, willing and patient team player.	54
Promoter	Casual and uninhibited. A persuasive extrovert with a tendency for informality.	56
Guardian	Precise, structured, team player. Patient and consistent approach.	60
Operator	Steady, conscientious, and relaxed. Learns through repetition.	64
Craftsman	Structured, analytical, team player. Focused on detail and process.	70

Sigma Score Array

The values in the API results properties using names likeaSigma orbSigma correspond to the distance in Sigmas from the Midpoint of the Behavioral Assessment graph. Values are rounded to the tenth or hundredth of a Sigma.

Examples:

"1.0" indicates the factor is 1 Sigma to the right (High) of the Midpoint
"-0.5" indicates the factor is 1/2 Sigma to the left (Low) of the Midpoint
"0.6" indicates the factor is 3/5 Sigma to the right (High) of the Midpoint

Note: A trained PI Practitioner or Certified Partner should always be consulted when implementing the use of this data.

Parameter	Type	Value	Notes
aSigma	decimal	Adjusted Z value for the A Factor (Dominance)
bSigma	decimal	Adjusted Z value for the B Factor (Extraversion)
cSigma	decimal	Adjusted Z value for the C Factor (Patience)
dSigma	decimal	Adjusted Z value for the D Factor (Formality)
eSigma	decimal	Adjusted Z value for the E Factor (Objectivity)	Some arrays may have a NULL value indicating that this parameter is not relevant for that array. This parameter is not included with Position scores.
mScore	integer	The M Score value indicating the number of responses chosen	This parameter is not included with Position scores.

Language Locale

The property languageLocale specifies the locale of the language of the assessment based on RFC 5646 Language-Region format. Below are the supported language locales supported for taking the Behavioral Assessment, obtaining a Behavioral Report, taking the Cognitive Assessment, and obtaining a Cognitive Report. The list of language locales available for other reports or assessments is a subset of these below, using the same codes when available. To learn which language locales are available for other reports or assessments, it is best to look at the Predictive Index software settings user interface controls to get the most accurate current list.

English Name	Language Locale	Local Name	Behav. Assess.	Behav. Report	Cognitive Assess.	Cognitive Report
Afrikaans	af-ZA	Afrikaans	True	False	True	False
Albanian	sq-AL	Shqip	True	False	True	False
Arabic (International)	ar-XM	العربية	True	False	True	False
Arabic (Gulf)	ar-AE	لعربية	False	False	True	False
Armenian	hy-AM	հայերեն	True	False	True	False
Azeri	Lt-az-AZ	azərbaycan dili	False	False	True	False
Basque	eu-ES	Euskara	True	False	True	False
Bulgarian	bg-BG	Български	True	False	True	False
Catalan	ca-ES	Català	True	False	True	False
Chinese (Simplified)	zh-CN	简体中文	True	True	True	True
Chinese (Traditional)	zh-TW	繁體中文	True	False	True	False
Croatian	hr-HR	Hrvatski	True	False	True	False
Czech	cs-CZ	Ceština	True	True	True	True
Danish	da-DK	Dansk	True	True	True	True
Dutch	nl-NL	Nederlands	True	True	True	True
English	en-US	English	True	True	True	True
Estonian	et-EE	Eesti Keel	True	False	True	False
Farsi	fa-IR	فارسی	True	False	True	False
Filipino	fil-PH	Tagalog	True	False	True	False
Finnish	fi-FI	Suomi	True	True	True	True
Flemish	nl-BE	Vlaams	False	False	True	False
French	fr-FR	Français	True	True	True	True
Georgian	ka-GE	ქართული	True	False	True	False
German	de-DE	Deutsch	True	True	True	True
Greek	el-GR	Ελληνικά	True	False	True	False
Greenlandic	kl-GL	Kalaallisut	True	False	False	False
Guajarati	gu-IN	ગુજરાતી	True	False	False	False
Haitian Creole	ht-HT	Kreyòl Ayisyen	True	False	False	False
Hebrew	he-IL	עברית	True	False	True	False
Hindi	hi-IN	हिंदी	True	False	True	False
Hungarian	hu-HU	Magyar	True	True	True	True
Icelandic	is-IS	Íslenska	True	False	True	False
Ilocano	ilo-PH	Ilokano	True	False	False	False
Indonesian	id-ID	Bahasa Indonesia	True	False	True	False
Italian	it-IT	Italiano	True	True	True	True
Japanese	ja-JP	日本語	True	True	True	True
Kazakh	kk-KZ	Қазақ тілі	True	False	True	False
Khmer	km-KH	ភាសាខ្មែរ	True	False	True	False
Korean	ko-KR	한국어	True	True	True	True
Lao	lo-LA	ພາສາລາວ	True	False	True	False
Latvian	lv-LV	Latviešu	True	False	True	False
Lithuanian	lt-LT	Lietuvių k	True	False	True	False
Macedonian	mk-MK	Македонски	True	False	True	False
Malay	ms-MY	Bahasa Melayu	True	False	True	False
Malayalam	ml-IN	മലയാളം	True	False	True	False
Norwegian (Bokmål)	nb-NO	Norsk	True	True	True	True
Papiamentu	pap-AW	Papiamentu	True	False	False	False
Polish	pl-PL	Polski	True	True	True	True
Portuguese	pt-PT	Português	True	True	True	True
Portuguese (Brazil)	pt-BR	Português (Brasil)	True	True	True	True
Punjabi	pa-IN	ਪੰਜਾਬੀ	True	False	True	False
Romanian	ro-RO	Română	True	True	True	True
Russian	ru-RU	Русский	True	True	True	True
Samoan	sm-WS	Samoan	True	False	False	False
Serbian (Latin)	sr-Cyrl-CS	Srpski (Latinica)	True	False	True	False
Sesotho	st-LS	Sesotho	True	False	False	False
Sinhalese	si-LK	සිංහල	True	False	False	False
Slovak	sk-SK	Slovenčina	True	False	True	False
Slovenian	sl-SI	Slovensko	True	False	True	False
Spanish (Latin America)	es-XL	Español (Latinoamérica)	True	True	False	True
Spanish (Europe)	es-ES	Español (Europeo)	True	True	True	True
Swahili	sw-KE	Swahili	True	False	True	False
Swedish	sv-SE	Svenska	True	True	True	True
Tamil	ta-IN	தமிழ்	True	False	True	False
Thai	th-TH	ไทย	True	False	True	False
Tongan	to-TO	Lea Faka-Tonga	True	False	False	False
Turkish	tr-TR	Türkçe	True	False	True	False
Ukrainian	uk-UA	Українська	True	False	True	False
Urdu	ur-PK	اردو	False	False	True	False
Vietnamese	vi-VN	Tiếng Việt	True	False	True	False
Xhosa	xh-ZA	IsiXhosa	True	False	True	False
Zulu	zu-ZA	IsiZulu	True	False	True	False