Retrieve
GET/scenarios/:scenarioId
Provides information on a given Scenario.
Request
Path Parameters
The scenario's id
Responses
- 200
- 404
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
- ]
- Array [
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
The scenario creation date. Valid date string in simplified extended ISO-8601 format (YYYY-MM-DDTHH:mm:ss.sssZ).
Description of the resource.
household object
The scenario household data
generations object[]
assets object[]
properties object
to object[]
properties object
debts object[]
properties object
Possible values: [PRINCIPAL_AMORTIZATION
, INTEREST_ONLY_WITH_BALLOON_PAYMENT
]
expenses object[]
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
Possible values: [UNSPECIFIED
, ONE_OFF
, DAILY
, WEEKLY
, MONTHLY
, QUARTERLY
, SEMI_ANNUALLY
, ANNUALLY
]
Possible values: [CALCULATED
, NONE
, CPI
, MEDIAN_WAGE_GROWTH
, PROPERTY_GROWTH
]
properties object
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
goals object[]
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
Possible values: [UNSPECIFIED
, ONE_OFF
, DAILY
, WEEKLY
, MONTHLY
, QUARTERLY
, SEMI_ANNUALLY
, ANNUALLY
]
fundingSources object[]
Possible values: [CALCULATED
, NONE
, CPI
, MEDIAN_WAGE_GROWTH
, PROPERTY_GROWTH
]
properties object
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
incomes object[]
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
Possible values: [UNSPECIFIED
, ONE_OFF
, DAILY
, WEEKLY
, MONTHLY
, QUARTERLY
, SEMI_ANNUALLY
, ANNUALLY
]
Possible values: [CALCULATED
, NONE
, CPI
, MEDIAN_WAGE_GROWTH
, PROPERTY_GROWTH
]
properties object
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
insurances object[]
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
Possible values: [UNSPECIFIED
, ONE_OFF
, DAILY
, WEEKLY
, MONTHLY
, QUARTERLY
, SEMI_ANNUALLY
, ANNUALLY
]
properties object
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
persons object[]
assets object[]
properties object
to object[]
properties object
debts object[]
properties object
Possible values: [PRINCIPAL_AMORTIZATION
, INTEREST_ONLY_WITH_BALLOON_PAYMENT
]
Possible values: [NO_EDUCATION
, PRIMARY_EDUCATION
, SECONDARY_EDUCATION
, VOCATIONAL_EDUCATION
, TERTIARY_1_EDUCATION
, TERTIARY_2_EDUCATION
, TERTIARY_3_EDUCATION
, TERTIARY_4_EDUCATION
]
expenses object[]
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
Possible values: [UNSPECIFIED
, ONE_OFF
, DAILY
, WEEKLY
, MONTHLY
, QUARTERLY
, SEMI_ANNUALLY
, ANNUALLY
]
Possible values: [CALCULATED
, NONE
, CPI
, MEDIAN_WAGE_GROWTH
, PROPERTY_GROWTH
]
properties object
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
Possible values: [UNSPECIFIED
, MALE
, FEMALE
, TRANS_MALE
, TRANS_FEMALE
, OTHER_MALE
, OTHER_FEMALE
, OTHER
]
goals object[]
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
Possible values: [UNSPECIFIED
, ONE_OFF
, DAILY
, WEEKLY
, MONTHLY
, QUARTERLY
, SEMI_ANNUALLY
, ANNUALLY
]
fundingSources object[]
Possible values: [CALCULATED
, NONE
, CPI
, MEDIAN_WAGE_GROWTH
, PROPERTY_GROWTH
]
properties object
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
Possible values: [CRITICALLY_ILL
, ILL
, LONG_TERM_CARE
, DISABLED
, POOR
, SMOKER
, AVERAGE
, GOOD
, EXCELLENT
]
incomes object[]
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
Possible values: [UNSPECIFIED
, ONE_OFF
, DAILY
, WEEKLY
, MONTHLY
, QUARTERLY
, SEMI_ANNUALLY
, ANNUALLY
]
Possible values: [CALCULATED
, NONE
, CPI
, MEDIAN_WAGE_GROWTH
, PROPERTY_GROWTH
]
properties object
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
insurances object[]
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
Possible values: [UNSPECIFIED
, ONE_OFF
, DAILY
, WEEKLY
, MONTHLY
, QUARTERLY
, SEMI_ANNUALLY
, ANNUALLY
]
properties object
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
Possible values: [UNEMPLOYED
, SEDENTARY
, ACTIVE
, PHYSICAL
]
Possible values: [UNSPECIFIED
, SINGLE
, ENGAGED
, MARRIED
, WIDOWED
, SEPARATED
, DIVORCED
, IN_A_RELATIONSHIP
, IN_A_CIVIL_UNION
, IN_A_DOMESTIC_PARTNERSHIP
]
pensions object[]
properties object
properties object
properties object
persons object[]
assets object[]
properties object
to object[]
properties object
debts object[]
properties object
Possible values: [PRINCIPAL_AMORTIZATION
, INTEREST_ONLY_WITH_BALLOON_PAYMENT
]
Possible values: [NO_EDUCATION
, PRIMARY_EDUCATION
, SECONDARY_EDUCATION
, VOCATIONAL_EDUCATION
, TERTIARY_1_EDUCATION
, TERTIARY_2_EDUCATION
, TERTIARY_3_EDUCATION
, TERTIARY_4_EDUCATION
]
expenses object[]
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
Possible values: [UNSPECIFIED
, ONE_OFF
, DAILY
, WEEKLY
, MONTHLY
, QUARTERLY
, SEMI_ANNUALLY
, ANNUALLY
]
Possible values: [CALCULATED
, NONE
, CPI
, MEDIAN_WAGE_GROWTH
, PROPERTY_GROWTH
]
properties object
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
Possible values: [UNSPECIFIED
, MALE
, FEMALE
, TRANS_MALE
, TRANS_FEMALE
, OTHER_MALE
, OTHER_FEMALE
, OTHER
]
goals object[]
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
Possible values: [UNSPECIFIED
, ONE_OFF
, DAILY
, WEEKLY
, MONTHLY
, QUARTERLY
, SEMI_ANNUALLY
, ANNUALLY
]
fundingSources object[]
Possible values: [CALCULATED
, NONE
, CPI
, MEDIAN_WAGE_GROWTH
, PROPERTY_GROWTH
]
properties object
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
Possible values: [CRITICALLY_ILL
, ILL
, LONG_TERM_CARE
, DISABLED
, POOR
, SMOKER
, AVERAGE
, GOOD
, EXCELLENT
]
incomes object[]
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
Possible values: [UNSPECIFIED
, ONE_OFF
, DAILY
, WEEKLY
, MONTHLY
, QUARTERLY
, SEMI_ANNUALLY
, ANNUALLY
]
Possible values: [CALCULATED
, NONE
, CPI
, MEDIAN_WAGE_GROWTH
, PROPERTY_GROWTH
]
properties object
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
insurances object[]
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
Possible values: [UNSPECIFIED
, ONE_OFF
, DAILY
, WEEKLY
, MONTHLY
, QUARTERLY
, SEMI_ANNUALLY
, ANNUALLY
]
properties object
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
Possible values: [UNEMPLOYED
, SEDENTARY
, ACTIVE
, PHYSICAL
]
Possible values: [UNSPECIFIED
, SINGLE
, ENGAGED
, MARRIED
, WIDOWED
, SEPARATED
, DIVORCED
, IN_A_RELATIONSHIP
, IN_A_CIVIL_UNION
, IN_A_DOMESTIC_PARTNERSHIP
]
pensions object[]
properties object
properties object
preferences object
The id of the resource.
The name of the resource.
{
"created": "2023-01-05T04:32:05.000Z",
"description": "My resource's description",
"household": null,
"id": "1",
"name": "My resource"
}
Not Found
Internal Server Error