Create
POST/scenarios/:scenarioId/persons/:personId/insurances/disability
Creates a new Disability Insurance for a Household in the given scenario.
Request
Path Parameters
The scenario's id
The person's id
- application/json
Body
required
Description of the resource.
The Insurance end date. Valid date string in simplified extended ISO-8601 format (YYYY-MM-DDTHH:mm:ss.sssZ). Will be respected only in conjuction with endsOn equals to USER_DEFINED.
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.
Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]
The payout frequency of the life insurance.
The id of the resource.
Whether this insurance is joint (insures both parthers).
The name of the resource.
The payout amount of the life insurance. Must be at least 0.
The payout amount currency of the life insurance. Valid currency code ISO-4217 from the list of supported currencies.
properties object
Properties of the resource.
Properties of the resource.
Read-only field containing the source of the data (eg. if it was imported from a 3rd party service).
The Insurance start date. Valid date string in simplified extended ISO-8601 format (YYYY-MM-DDTHH:mm:ss.sssZ). Will be respected only in conjuction with startsOn equals to USER_DEFINED.
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.
Responses
- 201
- 404
- 500
Created
- application/json
- Schema
- Example (from schema)
Schema
Description of the resource.
The Insurance end date. Valid date string in simplified extended ISO-8601 format (YYYY-MM-DDTHH:mm:ss.sssZ). Will be respected only in conjuction with endsOn equals to USER_DEFINED.
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.
Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]
The payout frequency of the life insurance.
The id of the resource.
Whether this insurance is joint (insures both parthers).
The name of the resource.
The payout amount of the life insurance. Must be at least 0.
The payout amount currency of the life insurance. Valid currency code ISO-4217 from the list of supported currencies.
properties object
Properties of the resource.
Properties of the resource.
Read-only field containing the source of the data (eg. if it was imported from a 3rd party service).
The Insurance start date. Valid date string in simplified extended ISO-8601 format (YYYY-MM-DDTHH:mm:ss.sssZ). Will be respected only in conjuction with startsOn equals to USER_DEFINED.
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.
{
"description": "My resource's description",
"endDate": "2031-01-01T00:00:00.000Z",
"endsOn": "ON_DEATH",
"frequency": "ANNUALLY",
"id": "1",
"joint": true,
"name": "My resource",
"payout": 100000,
"payoutCurrency": "GBP",
"properties": {
"property_1": "Value of property 1",
"property_2": "Value of property 2"
},
"source": "Source of the resource",
"startDate": "2030-01-01T00:00:00.000Z",
"startsOn": "USER_DEFINED"
}
Not Found
Internal Server Error