GET /assessments

Provides access to details associated with all supported assessments.

Request

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

Path Parameters

ParameterTypeValueRequiredNotes
assessmentIdstringThe id of the assessmentNoWhen provided, will return all supported Assessment with that specific assessmentId, otherwise the entire set of Assessments accessible is returned.

Query Parameters

N/A

Request Body

N/A

Response

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

Response Body

ParameterTypeValueNotes
assessmentIdstringThe 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 stringThe assessment taker's first name
middleName stringThe assessment taker's middle name 
lastName stringThe assessment taker's last name
email stringThe assessment taker's email address
expirationDateTimestringThe 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.

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

administeredByFirstName stringThe first name of the person who administered the assessment


administeredByLastName stringThe last name of the person who administered the assessment
administeredByEmail stringThe email address of the person who administered the assessment


administeredByPhonestringThe phone number of the person who administered the assessment


associatedPositionTitlestringThe title of the position associated to the assessment
gender numberThe gender of the assessment taker

Values are:

0 = Unknown

1 = Male

2 = Female

personTypestringThe type of the person of the assessment taker

Values are:

Unknown

Candidate

Other

Employee

Former Employee

assessmentStatusWebHookstringThe complete path to the web-hook that will be called when the assessment is created or completed 
assessmentUrlstringThe complete path to the website that the assessment taker will use to complete the assessment including embedded credentials
notifyAssessmentAvailableUsingEmailnumberIndicates if assessment taker will be notified via email upon creation of the assessment

Values are:

0 = Don't Notify

1 = Notify

externalId stringThis is a caller defined ID that allows for convenient lookups by an identifier generated by the callers system. 
externalPersonId stringThis is a caller defined ID for the assessment taker that allows for convenient creation of new assessments for the same user
assessmentUserIdstring This is the system assigned ID for the assessment taker that allows for convenient creation of new assessments for the same user
redirectUrlstringThe URL the assessment taker will be directed to after the assessment is completed.


selfSigmaScoreSigma ArrayScore representing the Self graphPlease refer to the Common page for more details.
selfConceptSigmaScoreSigma ArrayScore representing the Self Concept graphPlease refer to the Common page for more details.
synthesisSigmaScoreSigma ArrayScore representing the Synthesis graphPlease refer to the Common page for more details.
positionSigmaScoreSigma ArrayScore representing the associated Position's Job Profile Please refer to the Common page for more details.
customFieldsarrayAn array of Custom Fields (Custom Field Name and Assigned Value)

Example Request

curl -X GET https://pi.predictiveindex.com/api/v1/assessments/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://accesspi.piworldwide.com/Browse/PersonDetails?assessmentUserId=aaaabbbb-cccc-dddd-eeee-ffffgggghhhh",

   "redirectUrl": null,

   "selfSigmaScore": null, 

   "selfConceptSigmaScore": null,

   "synthesisSigmaScore": null,

   "positionSigmaScore": null,

   "customFields": null

}