Create

POST 
https://api.envizage.me/scenarios/:scenarioId/persons/children

Creates a Child under in the Household form the given scenario.

Request

Path Parameters

scenarioId stringrequired

The scenario's id

application/json

Body

required

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.

Responses

201

Created

application/json

Schema

Schema

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.

Example (from schema)

{
  "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
}

404

Not Found

500

Internal Server Error

Authorization: openIdConnect

name: authenticationtype: openIdConnectscopes: scenarios:full,scenarios:writebearerFormat: JWTopenIdConnectUrl: https://id.production.envizage.me/realms/:realmId/protocol/openid-connectscheme: Bearer

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X POST 'https://api.envizage.me/scenarios/:scenarioId/persons/children' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "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
}'

Request Collapse all

Base URL

https://api.envizage.me

Auth

Parameters

scenarioId — pathrequired

Body required

{
  "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
}

ResponseClear

Click the Send API Request button above and see the response here!