chatbot
clear chat
Skip to main content

Retrieve all

GET 

/scenarios/:scenarioId/persons

Retrieve all Persons

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

OK

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
Loading...