Retrieve

GET 
/scenarios/:scenarioId/persons/:personId/assets/properties/investment/:investmentPropertyAssetId

Provides information on the given Investment Property Asset belonging to a person from the specified household.

Request

Path Parameters

scenarioId stringrequired

The scenario's id

personId stringrequired

The person's id

investmentPropertyAssetId stringrequired

The asset's id

Responses

200

OK

application/json

Schema

Schema

city string

The city in the country of the asset.

country string

The country of the asset.

currency stringrequired

The currency in which the value is expressed. Valid currency code ISO-4217 from the list of supported currencies.

description string

Description of the resource.

id string

The id of the resource.

name string

The name of the resource.

properties object

Properties of the resource.

property name* object

Properties of the resource.

region string

The region in the country of the asset.

source string

Read-only field containing the source of the data (eg. if it was imported from a 3rd party service).

state string

The state in the country of the asset.

valuationDate date-timerequired

The valuation date of the asset.

value numberrequired

The value of the asset.

Example (from schema)

{
  "city": "London",
  "country": "UK",
  "currency": "GBP",
  "description": "My resource's description",
  "id": "1",
  "name": "My resource",
  "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
}

404

Not Found

500

Internal Server Error

Loading...