GET behavioralassessments

GET /behavioralassessments

Provides access to details associated with Behavioral Assessments.

Request

GET https://pi.predictiveindex.com/api/v1/behavioralassessments/<assessmentId>

Path Parameters

Parameter	Type	Value	Required	Notes
assessmentId	string	The id of the assessment	Optional	When provided, will return the Behavioral Assessment with that specific assessmentId, otherwise the entire set of Behavioral Assessments accessible is returned.

Query Parameters

OData filters are supported.

Request Body

N/A

Response

If successful, this method returns a 200 OK response code and the Behavioral Assessment object in the response body.

Response Body

Parameter	Type	Value	Notes
assessmentId	string	The unique assessmentId for the assessment	No assumptions as to the format of the string should be assumed as it can change from version to version. IDs from previous versions will retain their value and structure.
firstName	string	The assessment taker's first name
middleName	string	The assessment taker's middle name
lastName	string	The assessment taker's last name
email	string	The assessment taker's email address
expirationDateTime	string	The expiration date/time of the assessment invitation	The date and time is in UTC using the ISO 8601 standard. This parameter is down to seven (7) decimal places of precision. Examples: "2015-01-31T23:59:59.0123456Z"
administeredByFirstName	string	The first name of the person who administered the assessment
administeredByLastName	string	The last name of the person who administered the assessment
administeredByEmail	string	The email address of the person who administered the assessment
administeredByPhone	string	The phone number of the person who administered the assessment
associatedPositionTitle	string	The title of the position associated to the assessment
gender	number	The gender of the assessment taker	Valid values: 0 = Unknown 1 = Male 2 = Female
personType	string	The type of the person of the assessment taker	Valid values: Unknown Candidate Other Employee Former Employee
assessmentStatusWebHook	string	The complete path to the web-hook that will be called when the assessment is created or completed
assessmentUrl	string	The complete path to the website that the assessment taker will use to complete the assessment including embedded credentials
notifyAssessmentAvailableUsingEmail	number	Indicates if assessment taker will be notified via email upon creation of the assessment	Valid values: 0 = Don't Notify 1 = Notify
externalId	string	This is a caller defined ID that allows for convenient lookups by an identifier generated by the callers system.
externalPersonId	string	This is a caller defined ID for the assessment taker that allows for convenient creation of new assessments for the same user
assessmentUserId	string	This is the system assigned ID for the assessment taker that allows for convenient creation of new assessments for the same user
redirectUrl	string	The URL the assessment taker will be directed to after the assessment is completed.
selfSigmaScore	Sigma Array	Score representing the Self Graph.	Please refer to the Common page for more details.
selfConceptSigmaScore	Sigma Array	Score representing the Self Concept Graph.	Please refer to the Common page for more details.
synthesisSigmaScore	Sigma Array	Score representing the Synthesis Graph	Please refer to the Common page for more details.
positionSigmaScore	SigmaArray	Score representing the associated Position.	Please refer to the Common page for more details.
customFields	array	An array of Custom Fields (Custom Field Name and Assigned Value)

Example Request

curl -X GET https://pi.predictiveindex.com/api/v1/behavioralassessments/abcd6001-9t12-4d48-87dd-bb8ef85y3q94 \

-H "api-key: 12345678-ABCD-EFGH-1234-ABCDEFGH1234"

Example Response

{

"assessmentId": "abcd6001-9t12-4d48-87dd-bb8ef85y3q94",

"firstName": "Sam",

"middleName": "Kevin",

"lastName": "Flynn",

"email": "test@predictiveindex.com",

"assessmentDateTime": "2016-10-02T23:59:59.0123456Z",

"expirationDateTime": "2017-12-31T23:59:59.0123456Z",

"administeredByEmail": "recruiter@predictiveindex.com",

"administeredByPhone": "+1 781-235-8872",

"administeredByFirstName": "Recruiter First",

"administeredByLastName": "Recruiter Last",

"scoringMethod": 1,

"patternNumber": null,

"descriptiveReportUrl": "",

"associatedPositionTitle": null,

"associatedPositionImageUrl": "",

"folderPath": "Finance",

"patternFullUrl": "",

"patternSelfUrl": "",

"gender": 1,

"personType": "Candidate",

"isDeleted": 0,

"assessmentState": 0,

"assessmentStatusWebHook": "https://my.predictiveindex.com/behavioralcomplete",

"notifyAssessmentAvailableUsingEmail": 1,

"externalId": "894ever-behavioral",

"externalPersonId": "EightyNine4ever",

"assessmentUserId": "aaaabbbb-cccc-dddd-eeee-ffffgggghhhh",

"assessmentUrl": "https://assess.piworldwide.com/Account/LoginPi?a=+HMLjoyelhDxk0Gg4UHaHY7C9r3T424079jdYgSotAFWlej6xJ126rIIN5iAffm7&lang=en-US",

"assessmentPassword": "1234",

"descriptiveReportPageUrl": "",

"personPageUrl": "https://pi.predictiveindex.com/Browse/PersonDetails?assessmentUserId=aaaabbbb-cccc-dddd-eeee-ffffgggghhhh",

"redirectUrl": null,

"selfSigmaScore": null,

"selfConceptSigmaScore": null,

"synthesisSigmaScore": null,

"positionSigmaScore": null,

"customFields": null

}