Retrieve all

GET 
/scenarios/:scenarioId/persons/children

List all Children in the Household from the given Scenario {scenarioId}.

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.
gender stringrequired
Possible values: [UNSPECIFIED, MALE, FEMALE, TRANS_MALE, TRANS_FEMALE, OTHER_MALE, OTHER_FEMALE, OTHER]
The person's gender (any of UNSPECIFIED, MALE, FEMALE, TRANS_MALE, TRANS_FEMALE, OTHER_MALE, OTHER_FEMALE, OTHER).
healthStatus stringrequired
Possible values: [CRITICALLY_ILL, ILL, LONG_TERM_CARE, DISABLED, POOR, SMOKER, AVERAGE, GOOD, EXCELLENT]
The health status (any of CRITICALLY_ILL, ILL, LONG_TERM_CARE, DISABLED, POOR, SMOKER, AVERAGE, GOOD, EXCELLENT).
id string
The id of the resource.
lastName string
The person's last name.
maritalStatus stringrequired
Possible values: [UNSPECIFIED, SINGLE, ENGAGED, MARRIED, WIDOWED, SEPARATED, DIVORCED, IN_A_RELATIONSHIP, IN_A_CIVIL_UNION, IN_A_DOMESTIC_PARTNERSHIP]
The marital status (any of UNSPECIFIED, SINGLE, ENGAGED, MARRIED, WIDOWED, SEPARATED, DIVORCED, IN_A_RELATIONSHIP, IN_A_CIVIL_UNION, IN_A_DOMESTIC_PARTNERSHIP).
name string
The name of the resource.
primary boolean
Is this person the primary of this household?
properties object
Properties of the resource.
property name* object
Properties of the resource.
yearOfBirth int32required
The year of birth.
]
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",
      "gender": "MALE",
      "healthStatus": "EXCELLENT",
      "id": "1",
      "lastName": "Smith",
      "maritalStatus": "MARRIED",
      "name": "My resource",
      "primary": true,
      "properties": {
        "property_1": "Value of property 1",
        "property_2": "Value of property 2"
      },
      "yearOfBirth": 1980
    }
  ],
  "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...