Create
POST/scenarios/:scenarioId/persons/:personId/assets/properties/residential
Create a Residential Property
Request
Path Parameters
The scenario's id
The person's id
- application/json
Body
required
The city in the country of the asset.
The country of the asset.
The currency in which the value is expressed. Valid currency code ISO-4217 from the list of supported currencies.
Description of the resource.
The id of the resource.
The name of the resource.
Is this property my primary residential property?
properties object
Properties of the resource.
Properties of the resource.
The region in the country of the asset.
Read-only field containing the source of the data (eg. if it was imported from a 3rd party service).
The state in the country of the asset.
The valuation date of the asset.
The value of the asset.
Responses
- 201
- 404
- 500
Created
- application/json
- Schema
- Example (from schema)
Schema
The city in the country of the asset.
The country of the asset.
The currency in which the value is expressed. Valid currency code ISO-4217 from the list of supported currencies.
Description of the resource.
The id of the resource.
The name of the resource.
Is this property my primary residential property?
properties object
Properties of the resource.
Properties of the resource.
The region in the country of the asset.
Read-only field containing the source of the data (eg. if it was imported from a 3rd party service).
The state in the country of the asset.
The valuation date of the asset.
The value of the asset.
{
"city": "London",
"country": "UK",
"currency": "GBP",
"description": "My resource's description",
"id": "1",
"name": "My resource",
"primary": true,
"properties": {
"property_1": "Value of property 1",
"property_2": "Value of property 2"
},
"region": "London",
"source": "Source of the resource",
"state": "England",
"valuationDate": "2023-01-01T12:27:37.670Z",
"value": 70000
}
Not Found
Internal Server Error