Create
POST/scenarios/:scenarioId/persons/parents
Creates a Parent in the Household from the given scenario.
Request
Path Parameters
The scenario's id
- application/json
Body
required
Description of the resource.
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).
The expected retirement age.
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).
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).
The id of the resource.
Possible values: [UNEMPLOYED, SEDENTARY, ACTIVE, PHYSICAL]
The job type (any of UNEMPLOYED, SEDENTARY, ACTIVE, PHYSICAL).
The person's last name.
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).
The name of the resource.
Is this person the primary of this household?
properties object
Properties of the resource.
Properties of the resource.
The year of birth.
Responses
- 201
- 404
- 500
Created
- application/json
- Schema
- Example (from schema)
Schema
Description of the resource.
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).
The expected retirement age.
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).
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).
The id of the resource.
Possible values: [UNEMPLOYED, SEDENTARY, ACTIVE, PHYSICAL]
The job type (any of UNEMPLOYED, SEDENTARY, ACTIVE, PHYSICAL).
The person's last name.
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).
The name of the resource.
Is this person the primary of this household?
properties object
Properties of the resource.
Properties of the resource.
The year of birth.
{
"description": "My resource's description",
"educationLevel": "SECONDARY_EDUCATION",
"expectedRetirementAge": 67,
"gender": "MALE",
"healthStatus": "EXCELLENT",
"id": "1",
"jobType": "ACTIVE",
"lastName": "Smith",
"maritalStatus": "MARRIED",
"name": "My resource",
"primary": true,
"properties": {
"property_1": "Value of property 1",
"property_2": "Value of property 2"
},
"yearOfBirth": 1980
}
Not Found
Internal Server Error