Update
PUT/scenarios/:scenarioId/persons/:personId
Update a Person.
If you want to update the primary person details, please use the Update Primary endpoint. If you want to update the partner person details, please use the Update Partner endpoint.
Request
Path Parameters
The scenario's id
The person's id
- application/json
Body
required
Description of the resource.
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.
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
- 200
- 404
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Description of the resource.
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.
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",
"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
}
Not Found
Internal Server Error