Overview
Version information
Version 1.0.0
Contact information
Contact: EValue Support - support@ev.uk
URI scheme
Schemes: HTTP, HTTPS
Consumes
application/json
Produces
application/json
Paths
/riskProfiler/getQuestionnaireNames
Description
The Risk Questionnaire Profiler API provides a risk profile rating for an investor, and related asset allocation, based on risk profile questionnaire answers. This API contains 3 parts; getQuestionnaireNames has no request parameters and returns a list of the available questionnaires, getQuestionnaireData takes a questionnaire name (selected from the list returned in getQuesionnaireNames above) as the request parameter and returns the questions and associated answers. It also returns the version number for the questionnaire, calculateRisk takes the questionnaire name, question and response ids selected by client and investment term as request parameters. Returns the calculated risk profile and fund/asset breakdown for the calculated risk profile. Please refer to the Pricing Plan and the Credits Plan for the number of credits required to call this API.
Parameters
None
Responses
/riskProfiler/getQuestionnaireData
Description
The Risk Questionnaire Profiler API provides a risk profile rating for an investor, and related asset allocation, based on risk profile questionnaire answers. This API contains 3 parts; getQuestionnaireNames has no request parameters and returns a list of the available questionnaires, getQuestionnaireData takes a questionnaire name (selected from the list returned in getQuesionnaireNames above) as the request parameter and returns the questions and associated answers. It also returns the version number for the questionnaire, calculateRisk takes the questionnaire name, question and response ids selected by client and investment term as request parameters. Returns the calculated risk profile and fund/asset breakdown for the calculated risk profile. Please refer to the Pricing Plan and the Credits Plan for the number of credits required to call this API.
Parameters
| Type |
Name |
Description |
Schema |
Required |
| BodyParameter |
body |
The parameters required to get the questionnaire |
QuestionnaireDataParameters |
true |
Responses
/riskProfiler/calculateRisk
Description
The Risk Questionnaire Profiler API provides a risk profile rating for an investor, and related asset allocation, based on risk profile questionnaire answers. This API contains 3 parts; getQuestionnaireNames has no request parameters and returns a list of the available questionnaires, getQuestionnaireData takes a questionnaire name (selected from the list returned in getQuesionnaireNames above) as the request parameter and returns the questions and associated answers. It also returns the version number for the questionnaire, calculateRisk takes the questionnaire name, question and response ids selected by client and investment term as request parameters. Returns the calculated risk profile and fund/asset breakdown for the calculated risk profile. Please refer to the Pricing Plan and the Credits Plan for the number of credits required to call this API.
Parameters
| Type |
Name |
Description |
Schema |
Required |
| BodyParameter |
body |
The parameters required to calculate the risk profile |
RiskQuestionnaireParameters |
true |
Responses
Definitions
Request
Please note that only the following Definitions will be used when calculating the Result of this API call. Any other data submitted will not be validated or used in the calculation.
QuestionnaireDataParameters
| Name |
Description |
Schema |
Required |
Range |
| questionnaireName |
The name of the questionnaire to be returned |
String |
true |
|
RiskQuestionnaireParameters
| Name |
Description |
Schema |
Required |
Range |
| responses |
The responses to the risk questionnaire |
List of QuestionResponse |
true |
|
| questionnaireName |
The name of the risk questionnaire completed |
String |
true |
|
| term |
The investment term in years |
Integer |
true |
|
QuestionResponse
| Name |
Description |
Schema |
Required |
Range |
| questionId |
The question number |
Integer |
true |
|
| responseId |
The response number to the question |
Integer |
true |
|
Response
ValidationErrors
| Name |
Description |
Schema |
| errors |
A list of errors from validating the API input parameters |
List of ValidationError |
QuestionnaireNamesResult
| Name |
Description |
Schema |
| questionnaireNames |
The list of available risk questionnaire names |
List of String |
QuestionnaireDataResult
| Name |
Description |
Schema |
| name |
The name of the questionnaire |
String |
| questions |
The list of questions and responses for the questionnaire |
List of QuestionData |
| version |
The version of the questionnaire |
Integer |
QuestionData
| Name |
Description |
Schema |
| questionId |
The question number |
Integer |
| questionText |
The question text |
String |
| metaInf |
Implementation specific custom meta information for the question |
String |
| responses |
The list of responses for this question |
List of ResponseData |
ResponseData
| Name |
Description |
Schema |
| responseId |
The response number |
Integer |
| responseText |
The response text |
String |
| linkedQuestionId |
A linked question number for this response, typically the next question to ask. A value of null indicates ask the next sequential question number, a value of -1 means the end of the questionaire, no further questions. |
Integer |
| metaInf |
Any META-INF for this response |
String |
ScoreLikelihood
| Name |
Description |
Schema |
| likelihoodOfHigher |
Based on the user responses, this is the probability that the actual risk band of the user is higher than the one that has been returned. |
String |
| likelihoodOfLower |
Based on the user responses, this is the probability that the actual risk band of the user is lower than the one that has been returned. |
String |
Fund
| Name |
Description |
Schema |
| code |
Enter fund code for forecast. Use Citicode or asset class - see documentation for further information on asset class codes. |
String |
| name |
The name of the fund. |
String |
| contributionPercentage |
Contribution percentage allocated to that fund. |
Double |
RiskQuestionnaireResult
| Name |
Description |
Schema |
| riskProfile |
The calculated risk profile from the questionnaire responses |
Integer |
| riskProfileName |
The name of the calculated risk profile from the questionnaire responses |
String |
| riskProfileDescription |
The description of the calculated risk profile from the questionnaire responses |
List of String |
| allocations |
The allocations list represents the fund allocations retrieved from the portfolio that relates to the risk profile and term. |
List of Fund |
| score |
The calculated questionnaire score from the questionnaire responses. This score determines which risk band the user falls into. |
Double |
| scoreLikelihood |
Based on the user responses, this is the probability that the risk band returned is the correct band |
ScoreLikelihood |
| version |
The version of the questionnaire |
Integer |
| dateGenerated |
The date that this api was called. |
String (date) |
| validationErrors |
Validation errors caused by the questionnaire responses |
List of QuestionnaireValidationError |
QuestionnaireValidationError
| Name |
Description |
Schema |
| type |
The type of validation error |
Enum - MESSAGE_AND_CONFIRM, INCONSISTENT_RESPONSE, MESSAGE, QUESTIONNAIRE |
| title |
The title of the validation error |
String |
| message |
The validation error message |
String |
| inconsistentQ1 |
The first question that has an answer that contradicts another |
Integer |
| inconsistentQ2 |
The second question that has an answer that contradicts another |
Integer |
ValidationError
| Name |
Description |
Schema |
| field |
The field that is invalid |
String |
| code |
The type of validation error that has occurred |
Enum - REQUIRED, OUT_OF_RANGE, INVALID, INVALID_TOTAL |
| message |
The validation error message |
String |
| value |
The value that is invalid |
String |
SystemError
| Name |
Description |
Schema |
| systemError |
The system error message. |
String |
