Overview
Version information
Version
Contact information
Contact: EValue Support - support@ev.uk
URI scheme
Schemes: HTTP, HTTPS
Consumes
application/json
Produces
application/json
Paths
/riskAssetAllocation/calculate
Description
Returns the asset allocation of a requested risk profile.
Parameters
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.
RiskAssetAllocationParameters
| Name |
Description |
Schema |
Required |
Range |
| riskGroup |
User's risk benchmark to which their investment can be evaluated |
Integer |
true |
|
| riskProfile |
The efficient risk profile to be evaluated. |
Integer |
true |
|
| riskTerm |
Evaluated term for the efficient risk profile. |
Integer |
true |
0 to 75 |
Response
RiskAssetAllocationResult
| Name |
Description |
Schema |
| riskProfile |
The efficient risk profile to be evaluated. |
Integer |
| riskTerm |
Evaluated term for the efficient risk profile. |
Integer |
| allocations |
List of funds invested in the portfolio. |
List of Fund |
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 |
ValidationErrors
| Name |
Description |
Schema |
| errors |
A list of errors from validating the API input parameters |
List of ValidationError |
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 |
