Retrieve all

GET 
/scenarios/:scenarioId/insurances

Retrieve all Insurances

Request

Path Parameters

scenarioId stringrequired

The scenario's id

Query Parameters

page integer

Zero-based page index (0..N)

size integer

Default value: 20

The size of the page to be returned

sort string[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

200

OK

application/json

Schema

Schema

content object[]
Array [
description string
Description of the resource.
endDate date-timerequired
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.
endsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.
frequency stringrequired
Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]
The payout frequency of the life insurance.
id string
The id of the resource.
joint booleanrequired
Whether this insurance is joint (insures both parthers).
name string
The name of the resource.
payout numberrequired
The payout amount of the life insurance. Must be at least 0.
payoutCurrency stringrequired
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.
property name* object
Properties of the resource.
source string
Read-only field containing the source of the data (eg. if it was imported from a 3rd party service).
startDate date-timerequired
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.
startsOn string
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.
]
empty boolean
first boolean
last boolean
number int32
numberOfElements int32
pageable object
offset int64
pageNumber int32
pageSize int32
paged boolean
sort object
empty boolean
sorted boolean
unsorted boolean
unpaged boolean
size int32
sort object
empty boolean
sorted boolean
unsorted boolean
totalElements int64
totalPages int32

Example (from schema)

{
  "content": [
    {
      "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"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}

404

Not Found

500

Internal Server Error

Loading...