GET /behavioralassessments/{id}/reports/{reportType}
Provides access to several reports associated with Behavioral Assessments.
NOTE: The general development direction being taken by the PI Product Team is to implement reports in other APIs rather than in BehavioralAssessments. Several of the reports historically offered through this API are being offered now through the Persons API (example: POST /api/v1/persons/PrintMSGs). It is therefore a better practice to implement reports via the Persons API than via the BehavioralAssessments API.
Request
GET https://pi.predictiveindex.com/api/v1/behavioralassessments/<assessmentId>/reports/<reportType>
Path Parameters
| Parameter | Type | Value | Required | Notes |
| assessmentId | string | The id of the assessment | Required | Determines which Behavioral Assessment's data to use for generating the report. |
| reportType | string or integer | The name or number of the report type | Required | Select one of several report types: PersonDetailReport = 1 PersonDevelopmentChart = 2 Placard = 3 ManagerDevelopmentChart = 4 ManagementStrategyGuide = 5 (not working, see NOTE at the top) PlacardNexGen = 6 |
Query Parameters
| Parameter | Type | Value | Required | Notes |
| format | string | Required | The output format of the report, currently only PDF is supported | |
| gender | string or integer | Unknown or 0, Male or 1, Female or 2 | Required | English (en-US): As of Oct 2018, gender-neutral reports are now available by passing gender=0 or gender=Unknown. Passing Male (1) or Female (2) will generate reports using gender-specific pronouns.
Other Languages: If the desired language uses gender-specific pronouns, the only supported values are Male (1) or Female (2) if you wish to obtain a single report. For gender-specific languages, a value of Unknown (0) will return a ZIP file containing both male and female reports. (Roadmap note: gender-neutral reports are coming for non-English languages) |
| languageLocale | string | e.g. en-US or zu-ZA | Optional | The RFC 5646 language tag to use for the report output. If omitted, the default language defined for the account will be used. Note: Only certain language codes are supported in PI reports. Refer to the PI software user interface report settings drop-down list for a current list. |
| isManagementStyle | string or integer | true or 1, false or 0 | Optional | Flag to indicate whether to include the optional Management Style section in the PersonDetailReport. |
| isInfluencingStyle | string or integer | true or 1, false or 0 | Optional | Flag to indicate whether to include the optional Influencing Style section in the PersonDetailReport. This option should not be used with the isSellingStyle since both are re-wordings of the same content. |
| isSellingStyle | string or integer | true or 1, false or 0 | Optional | Flag to indicate whether to include the optional Selling Style section in the PersonDetailReport. This option should not be used with the isInfluencingStyle since both are re-wordings of the same content. |
Request Body
Response
Response Body
If successful, this method returns a 200 OK response code and the report file in the response data stream.
Example Request
curl -X GET https://pi.predictiveindex.com/api/v1/behavioralassessments/abcd6001-9t12-4d48-87dd-bb8ef85y3q94/reports/1?format=PNG&gender=1&languageLocale=en-US&isManagementStyle=true \
-H "api-key: 12345678-ABCD-EFGH-1234-ABCDEFGH1234"
Example Response
N/A
© Predictive Index