Analysis results
TMA Analysis
Retrieves the analysis result based on a token and the selected culture for the correct translation of the description.
GEThttps://api.domain.com/api/candidateanalysisresult/AB12345/nl-NL
Parameters
No query parameters.
The token (e.g., AB12345) and culture (e.g., nl-NL) are part of the URL.
Result
- HTTP Status code 200 on success.
Returned Fields
| Parameter | DataType | Description |
|---|---|---|
| AnalysisToken | String | Token of the analysis |
| CandidateIdentifier | String | External ID of the candidate, in an external system |
| AptitudeScores | Object | List of aptitude scores (ID, Value, Description, ExternalCode) |
| NormScores | Object | List of norm scores (ID, Value, Description, ExternalCode) |
| NormScoresPercentage | Object | List of all norm percentage scores (ID, Value, Description, ExternalCode) |
| AptitudeScoresPercentage | Object | List of all aptitude percentage scores (ID, Value, Description, ExternalCode) |
| NormScoreScales | Object | List of all norm scale scores (ID, Value, Description, ExternalCode) |
| AptitudeScoresScale | Object | List of all aptitude scale scores (ID, Value, Description, ExternalCode) |
| Done | Bool | Indicates if the analysis is finished |
| DoneDate | DateTime | Date when the analysis was finished |
| ConsistencyScore | String | Score on how consistent the test was completed |
JIA Result
Retrieves the JIA result based on a token and the culture for correct translation of the description.
GEThttps://api.domain.com/api/candidateanalysisresult/JIA/AB12345/nl-NL
Parameters
No query parameters.
The token (AB12345), the JIA designation in the path, and culture (nl-NL) are part of the URL.
Result
- HTTP Status code 200 on success.
Returned Fields
| Parameter | DataType | Description |
|---|---|---|
| CandidateIdentifier | String | The external ID of the candidate |
| JiaLevel | String | Either High or Middle |
| Sectors | List | The interest scores in various sectors |
| Activities | List | The interest scores in various activities |
Each SectorInterestResult contains:
- Sector (string): name of the sector
- Score (int): the resulting interest score based on JIA
Each ActivityInterestResult contains:
- Activity (string): name of the activity
- Score (int): the resulting interest score based on JIA
Development Tips
Retrieves development tips for a single competence, based on the competence’s external code.
GEThttps://api.domain.com/api/TmaContent/DevelopmentTips/*
Parameters (body)
| Parameter | DataType | Description | Mandatory |
|---|---|---|---|
| CompetenceExternalCode | String | External code of the competence | Yes |
| Culture | String | Culture/language in which you want the content of the tips returned | Yes |
Result
- HTTP Status code 200 on success.
Returned Fields
| Parameter | DataType | Description |
|---|---|---|
| CompetenceExternalCode | String | External code of the competence |
| Culture | String | The culture of the result |
| Content | String array | Array of development tips |
Development Tips Bulk (deprecated)
Retrieves development tips for multiple competences, based on a list of competence external codes.
Coaching Tips
Retrieves coaching tips for a single competence, based on the competence’s external code.
GEThttps://api.domain.com/api/TmaContent/CoachingTips/*
Parameters (body)
| Parameter | DataType | Description | Mandatory |
|---|---|---|---|
| CompetenceExternalCode | String | External code of the competence | Yes |
| Culture | String | Culture/language in which you want the content of the coaching tips | Yes |
Result
- HTTP Status code 200 on success.
Returned Fields
| Parameter | DataType | Description |
|---|---|---|
| CompetenceExternalCode | String | External code of the competence |
| Culture | String | The culture of the result |
| Content | String array | Array of coaching tips |
Coaching Tips Bulk (deprecated)
Retrieves coaching tips for multiple competences, based on a list of competence external codes.
Learnability Advice
Retrieves learnability advice based on a scale value.
POSThttps://api.domain.com/api/TmaContent/LearnabilityAdvices/*
Parameters (body)
| Parameter | DataType | Description | Mandatory |
|---|---|---|---|
| Culture | String | Culture/language in which you want the content of the advice | Yes |
The scale values are handled internally by the API (e.g., sent in or derived from the request body).
Example structures may vary.
Result
- HTTP Status code 200 on success.
Returned Fields
Each returned item in the list includes:
| Parameter | DataType | Description |
|---|---|---|
| Content | String | Content of the learnability advice |
| Culture | String | The culture of the result |
| ScaleValue | Int | The scale value that matches this advice |
Candidate Analysis Summary
Retrieves the TMA analysis summary for a specific analysis token, for a specific culture.
GEThttps://api.domain.com/api/CandidateAnalysisSummary/AB12345/nl-NL
Parameters
No query parameters.
The token (AB12345) and culture (nl-NL) are part of the URL.
Result
- HTTP Status code 200 on success.
Returned Fields
Each item in the list includes:
| Parameter | DataType | Description |
|---|---|---|
| SummaryTitle | String | Title of the candidate TMA analysis summary |
| SummarySubTitle1 | String | SubTitle1 of the candidate TMA analysis summary |
| SummarySubTitle2 | String | SubTitle2 of the candidate TMA analysis summary |
| Summary | String | Summary text of the candidate TMA analysis |
| Talents | List | A collection of talents, including descriptive text |
Each TalentModel object includes:
- Name (string)
- Intro (string) – an introductory paragraph on the talent
- Value (int) – either 1–3 or 7–9
- List<TalentDescriptionModel> – a collection of descriptive paragraphs
Each TalentDescriptionModel object includes:
- Title (string)
- Text (string) – a small paragraph of information
Candidate Communication Advice
Retrieves advice, in the provided culture, on the preferred communication style of a candidate, based on the TMA analysis token.
GEThttps://api.domain.com/api/CandidateCommunicationAdvice/AB12345/nl-NL
Parameters
No query parameters.
The token (AB12345) and culture (nl-NL) are part of the URL.
Result
- HTTP Status code 200 on success.
Returned Fields
| Parameter | DataType | Description |
|---|---|---|
| EffectiveCommunicationTitle | String | Descriptor for effective communication |
| EffectiveCommunicationBlocks | List | Paragraphs on effective communication |
| IneffectiveCommunicationTitle | String | Descriptor for ineffective communication |
| IneffectiveCommunicationBlocks | List | Paragraphs on ineffective communication |
Candidate Learning Style
Retrieves a description, in the provided culture, of the preferred learning style of a candidate, based on the TMA analysis token.
GEThttps://api.domain.com/api/CandidateLearningStyle/AB12345/nl-NL
Parameters
No query parameters.
The token (AB12345) and culture (nl-NL) are part of the URL.
Result
- HTTP Status code 200 on success.
Returned Fields
The result is a CandidateLearningStyle object with two properties: Horizontal and Vertical, each of type CandidateLearningStyleAxis.
| Parameter | DataType | Description |
|---|---|---|
| Low | String | The axis name for a low score |
| High | String | The axis name for a high score |
| NormScore | Int | The candidate’s score on this axis |
Candidate Preferred Working Environment
Retrieves a description, in the provided culture, of the preferred working environment of a candidate, based on the TMA analysis token.
GEThttps://api.domain.com/api/CandidateWorkingEnvironment/AB12345/nl-NL
Parameters
No query parameters.
The token (AB12345) and culture (nl-NL) are part of the URL.
Result
- HTTP Status code 200 on success.
Returned Fields
The result is an IdealWorkingEnvironment object:
| Parameter | DataType | Description |
|---|---|---|
| Title | String | The title for the content |
| Blocks | List | The paragraphs describing the ideal environment |
Candidate Drives
Retrieves a description, in the provided culture, of the drives associated with a candidate’s talents, based on the TMA analysis token.
GEThttps://api.domain.com/api/CandidateDrives/AB12345/nl-NL
Parameters
No query parameters.
The token (AB12345) and culture (nl-NL) are part of the URL.
Result
- HTTP Status code 200 on success.
Returned Fields
The result is a CandidateDimensionCollection object containing:
CandidateIdentifier(string) – external ID- A collection of DimensionDriveCollection objects named Drives
Each DimensionDriveCollection object includes:
- Name (string) – the name of the dimension
- A collection of DriveData objects named Drives
Each DriveData object includes:
| Parameter | DataType | Description |
|---|---|---|
| Drive | String | Name of the drive |
| DriveDefinition | String | Description of the drive |
| TalentLow | String | Name of the talent associated with a low score |
| TalentHigh | String | Name of the talent associated with a high score |
| Value | Int | The score on the drive, indicating a talent |