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
/stateBenefitAge/income
Description
The integer age at which your state benefit will be paid. This is the age at which the other APIs will model the state pension coming into payment. Please refer to the Pricing Plan and the Credits Plan for the number of credits required to call this API.
Parameters
None
Responses
/stateBenefitAge/age
Description
The integer age at which your state benefit will be paid. This is the age at which the other APIs will model the state pension coming into payment. Please refer to the Pricing Plan and the Credits Plan for the number of credits required to call this API.
Parameters
Responses
/stateBenefitAge/unroundedAge
Description
The integer age at which your state benefit will be paid. This is the age at which the other APIs will model the state pension coming into payment. Please refer to the Pricing Plan and the Credits Plan for the number of credits required to call this API.
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.
StateBenefitAgeParameters
Name |
Description |
Schema |
Required |
Range |
dateOfBirth |
ISO-8601 formatted date of the forcastee |
String (date) |
true |
|
gender |
gender of the forcastee |
Enum - MALE, FEMALE |
true |
|
Response
StateBenefitIncomeResults
Name |
Description |
Schema |
income |
The current state benefit income level |
Double |
StateBenefitAgeResults
Name |
Description |
Schema |
age |
the age at which someone of the gender and date of birth provided would receive their state pension |
Integer |
StateBenefitUnroundedResults
Name |
Description |
Schema |
age |
the unrounded age at which someone of the gender and date of birth provided would receive their state pension |
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 |