Skip to main content

Update

PUT 

/scenarios/:scenarioId/assets/properties/residential/:residentialPropertyAssetId

Updates the Residential Property Asset with {assetId} in the given scenario.

Request

Path Parameters

    scenarioId stringrequired

    The scenario's id

    residentialPropertyAssetId stringrequired

    The asset's id

Body

required
    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.

    primary booleanrequired

    Is this property my primary residential property?

    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.

Responses

OK

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.

    primary booleanrequired

    Is this property my primary residential property?

    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.

Loading...