Retrieve

GET 
/scenarios/:scenarioId/persons/:personId/insurances/mortgage-life/:lifeInsuranceId

Provides information on a given Mortgage Life for the specified Household.

Request

Path Parameters

scenarioId stringrequired

The scenario's id

personId stringrequired

The person's id

lifeInsuranceId stringrequired

The insurance's id

Responses

200

OK

application/json

Schema

Schema

description string

Description of the resource.

id string

The id of the resource.

joint booleanrequired

Whether this insurance is joint (insures both parthers).

mortgageId stringrequired

The mortgage id that this life insurance associates.

name string

The name of the resource.

properties object

Properties of the resource.

property name* object

Properties of the resource.

Example (from schema)

{
  "description": "My resource's description",
  "id": "1",
  "joint": true,
  "mortgageId": "string",
  "name": "My resource",
  "properties": {
    "property_1": "Value of property 1",
    "property_2": "Value of property 2"
  }
}

404

Not Found

500

Internal Server Error

Loading...