chatbot
clear chat
Skip to main content

Retrieve all

GET 

/scenarios/:scenarioId/assets/properties/residential

List all Residential Property assets in a given household.

Request

Path Parameters

    scenarioId stringrequired

    The scenario's id

Query Parameters

    pageRequest objectrequired

Responses

OK

Schema
    content object[]
  • Array [
  • 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.

  • ]
  • empty boolean
    first boolean
    last boolean
    number int32
    numberOfElements int32
    pageable object
    offset int64
    pageNumber int32
    pageSize int32
    paged boolean
    sort object
    empty boolean
    sorted boolean
    unsorted boolean
    unpaged boolean
    size int32
    sort object
    empty boolean
    sorted boolean
    unsorted boolean
    totalElements int64
    totalPages int32
Loading...