chatbot
clear chat
Skip to main content

Retrieve

GET 

/scenarios/:scenarioId/persons/parents/:parentId

Retrieve the specified Parent from the given scenario.

Request

Path Parameters

    scenarioId stringrequired

    The scenario's id

    parentId stringrequired

    The goal's id

Responses

OK

Schema
    description string

    Description of the resource.

    educationLevel stringrequired

    Possible values: [NO_EDUCATION, PRIMARY_EDUCATION, SECONDARY_EDUCATION, VOCATIONAL_EDUCATION, TERTIARY_1_EDUCATION, TERTIARY_2_EDUCATION, TERTIARY_3_EDUCATION, TERTIARY_4_EDUCATION]

    The education level (any of NO_EDUCATION, PRIMARY_EDUCATION, SECONDARY_EDUCATION, VOCATIONAL_EDUCATION, TERTIARY_1_EDUCATION, TERTIARY_2_EDUCATION, TERTIARY_3_EDUCATION, TERTIARY_4_EDUCATION).

    expectedRetirementAge int32required

    The expected retirement age.

    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.

    jobType stringrequired

    Possible values: [UNEMPLOYED, SEDENTARY, ACTIVE, PHYSICAL]

    The job type (any of UNEMPLOYED, SEDENTARY, ACTIVE, PHYSICAL).

    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.

Loading...