Retrieve

GET 
/scenarios/:scenarioId

Provides information on a given Scenario.

Request

Path Parameters

scenarioId stringrequired

The scenario's id

Responses

200

OK

application/json

Schema

Schema

created date-time

The scenario creation date. Valid date string in simplified extended ISO-8601 format (YYYY-MM-DDTHH:mm:ss.sssZ).

description string

Description of the resource.

household object
The scenario household data
description string
generations object[]
Array [
active boolean
assets object[]
Array [
description string
id string
name string
properties object
property name* object
to object[]
Array [
city string
country string
description string
id string
name string
properties object
property name* object
region string
source string
state string
valuationDate date-time
value string
]
]
debts object[]
Array [
amount string
annualAverageInterestRate double
description string
endDate date-time
id string
name string
properties object
property name* object
repaymentType string
Possible values: [PRINCIPAL_AMORTIZATION, INTEREST_ONLY_WITH_BALLOON_PAYMENT]
source string
startDate date-time
]
description string
expenses object[]
Array [
amount string
description string
endDate date-timerequired
endsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
frequency string
Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]
growthRate string
Possible values: [CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH]
id string
name string
properties object
property name* object
source string
spreadOverGrowthRate double
startDate date-timerequired
startsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
]
goals object[]
Array [
description string
desiredAmount string
discretionary boolean
enabled boolean
endDate date-timerequired
endsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
frequency string
Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]
fundingSources object[]
Array [
description string
id string
name string
]
growthRate string
Possible values: [CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH]
id string
maximumAbsoluteSpreadAllowed double
minimumAmount string
name string
priority int32
properties object
property name* object
source string
spreadOverGrowthRate double
startDate date-timerequired
startsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
]
id string
incomes object[]
Array [
amount string
description string
endDate date-timerequired
endsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
frequency string
Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]
growthRate string
Possible values: [CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH]
id string
maximumAbsoluteSpreadAllowed double
name string
properties object
property name* object
source string
spreadOverGrowthRate double
startDate date-timerequired
startsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
]
insurances object[]
Array [
description string
endDate date-timerequired
endsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
frequency string
Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]
id string
joint boolean
name string
payout string
properties object
property name* object
source string
startDate date-timerequired
startsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
]
name string
persons object[]
Array [
assets object[]
Array [
description string
id string
name string
properties object
property name* object
to object[]
Array [
city string
country string
description string
id string
name string
properties object
property name* object
region string
source string
state string
valuationDate date-time
value string
]
]
debts object[]
Array [
amount string
annualAverageInterestRate double
description string
endDate date-time
id string
name string
properties object
property name* object
repaymentType string
Possible values: [PRINCIPAL_AMORTIZATION, INTEREST_ONLY_WITH_BALLOON_PAYMENT]
source string
startDate date-time
]
description string
educationLevel string
Possible values: [NO_EDUCATION, PRIMARY_EDUCATION, SECONDARY_EDUCATION, VOCATIONAL_EDUCATION, TERTIARY_1_EDUCATION, TERTIARY_2_EDUCATION, TERTIARY_3_EDUCATION, TERTIARY_4_EDUCATION]
expectedRetirementAge int32
expenses object[]
Array [
amount string
description string
endDate date-timerequired
endsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
frequency string
Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]
growthRate string
Possible values: [CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH]
id string
name string
properties object
property name* object
source string
spreadOverGrowthRate double
startDate date-timerequired
startsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
]
gender string
Possible values: [UNSPECIFIED, MALE, FEMALE, TRANS_MALE, TRANS_FEMALE, OTHER_MALE, OTHER_FEMALE, OTHER]
goals object[]
Array [
description string
desiredAmount string
discretionary boolean
enabled boolean
endDate date-timerequired
endsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
frequency string
Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]
fundingSources object[]
Array [
description string
id string
name string
]
growthRate string
Possible values: [CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH]
id string
maximumAbsoluteSpreadAllowed double
minimumAmount string
name string
priority int32
properties object
property name* object
source string
spreadOverGrowthRate double
startDate date-timerequired
startsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
]
healthStatus string
Possible values: [CRITICALLY_ILL, ILL, LONG_TERM_CARE, DISABLED, POOR, SMOKER, AVERAGE, GOOD, EXCELLENT]
id string
incomes object[]
Array [
amount string
description string
endDate date-timerequired
endsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
frequency string
Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]
growthRate string
Possible values: [CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH]
id string
maximumAbsoluteSpreadAllowed double
name string
properties object
property name* object
source string
spreadOverGrowthRate double
startDate date-timerequired
startsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
]
insurances object[]
Array [
description string
endDate date-timerequired
endsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
frequency string
Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]
id string
joint boolean
name string
payout string
properties object
property name* object
source string
startDate date-timerequired
startsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
]
jobType string
Possible values: [UNEMPLOYED, SEDENTARY, ACTIVE, PHYSICAL]
lastName string
maritalStatus string
Possible values: [UNSPECIFIED, SINGLE, ENGAGED, MARRIED, WIDOWED, SEPARATED, DIVORCED, IN_A_RELATIONSHIP, IN_A_CIVIL_UNION, IN_A_DOMESTIC_PARTNERSHIP]
name string
pensions object[]
Array [
description string
endDate date-time
id string
name string
properties object
property name* object
startDate date-time
]
primary boolean
properties object
property name* object
yearOfBirth int32
]
properties object
property name* object
]
id string
initialized booleandeprecated
name string
persons object[]
Array [
assets object[]
Array [
description string
id string
name string
properties object
property name* object
to object[]
Array [
city string
country string
description string
id string
name string
properties object
property name* object
region string
source string
state string
valuationDate date-time
value string
]
]
debts object[]
Array [
amount string
annualAverageInterestRate double
description string
endDate date-time
id string
name string
properties object
property name* object
repaymentType string
Possible values: [PRINCIPAL_AMORTIZATION, INTEREST_ONLY_WITH_BALLOON_PAYMENT]
source string
startDate date-time
]
description string
educationLevel string
Possible values: [NO_EDUCATION, PRIMARY_EDUCATION, SECONDARY_EDUCATION, VOCATIONAL_EDUCATION, TERTIARY_1_EDUCATION, TERTIARY_2_EDUCATION, TERTIARY_3_EDUCATION, TERTIARY_4_EDUCATION]
expectedRetirementAge int32
expenses object[]
Array [
amount string
description string
endDate date-timerequired
endsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
frequency string
Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]
growthRate string
Possible values: [CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH]
id string
name string
properties object
property name* object
source string
spreadOverGrowthRate double
startDate date-timerequired
startsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
]
gender string
Possible values: [UNSPECIFIED, MALE, FEMALE, TRANS_MALE, TRANS_FEMALE, OTHER_MALE, OTHER_FEMALE, OTHER]
goals object[]
Array [
description string
desiredAmount string
discretionary boolean
enabled boolean
endDate date-timerequired
endsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
frequency string
Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]
fundingSources object[]
Array [
description string
id string
name string
]
growthRate string
Possible values: [CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH]
id string
maximumAbsoluteSpreadAllowed double
minimumAmount string
name string
priority int32
properties object
property name* object
source string
spreadOverGrowthRate double
startDate date-timerequired
startsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
]
healthStatus string
Possible values: [CRITICALLY_ILL, ILL, LONG_TERM_CARE, DISABLED, POOR, SMOKER, AVERAGE, GOOD, EXCELLENT]
id string
incomes object[]
Array [
amount string
description string
endDate date-timerequired
endsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
frequency string
Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]
growthRate string
Possible values: [CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH]
id string
maximumAbsoluteSpreadAllowed double
name string
properties object
property name* object
source string
spreadOverGrowthRate double
startDate date-timerequired
startsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
]
insurances object[]
Array [
description string
endDate date-timerequired
endsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
frequency string
Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]
id string
joint boolean
name string
payout string
properties object
property name* object
source string
startDate date-timerequired
startsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
]
jobType string
Possible values: [UNEMPLOYED, SEDENTARY, ACTIVE, PHYSICAL]
lastName string
maritalStatus string
Possible values: [UNSPECIFIED, SINGLE, ENGAGED, MARRIED, WIDOWED, SEPARATED, DIVORCED, IN_A_RELATIONSHIP, IN_A_CIVIL_UNION, IN_A_DOMESTIC_PARTNERSHIP]
name string
pensions object[]
Array [
description string
endDate date-time
id string
name string
properties object
property name* object
startDate date-time
]
primary boolean
properties object
property name* object
yearOfBirth int32
]
preferences object
property name* object
id string

The id of the resource.

name string

The name of the resource.

Example (from schema)

{
  "created": "2023-01-05T04:32:05.000Z",
  "description": "My resource's description",
  "household": null,
  "id": "1",
  "name": "My resource"
}

404

Not Found

500

Internal Server Error

Loading...