Alma logo
API docs by Redocly

Realty API (1.0)

Download OpenAPI specification:Download

Introduction

Realty API allows an agent to provide content for realty. Realty can be sold, rented or purchaced. Realties are divided into different types:

  • Residential share
  • Other share
  • Residential property
  • Estate property
  • Other property (includes also plot property)
  • Commercial property

Each type of realty has its own endpoint with POST, PUT, GET and DELETE methods.

Contact

If you have any questions, comments or feedback regarding our APIs, please contact developer@ovipro.fi.

Feature codes

This table contains the feature codes Ovi PRO application uses in ApartmentRoomFeature field for apartment room features.

Feature code
BATH_ROOM
WC
SHOWER
TWO_SHOWERS
SHOWER_WALL
WALK_IN_SHOWER
WASHING_MACHINE_CONNECTION
FIXED_LAMPS
UNDERFLOOR_HEATING
WASHING_MACHINE
TUMBLE_DRYER
DRYING_CABINET
MIRROR
MIRROR_CABINET
BASIN_CABINET
JACUZZI
BATHTUB
BATHROOM_CABINETS
KITCHEN
REFRIGERATOR_WITH_SMALL_FREEZER_COMPARTMENT
REFRIGERATOR_FREEZER
REFRIGERATOR
REFRIGERATED_CABINET
COLD_ROOM
FREEZER
REFRIGERATOR_CHILLER
DISHWASHER
DISHWASHER_CONNECTION
RESERVED_LOCATION_FOR_DISHWASHER
WASHING_MACHINE_CONNECTION
INTEGRATED_DISHWASHER
FREE_STANDING_ISLANDS
FLOOR_DRAIN
FREE_STANDING_CABINETS
WINE_CABINET
INTEGRATED_HOUSEHOLD_APPLIANCES
CERAMIC_STOVE
HOB
BAKING_OVEN
COOKTOP
INTEGRATED_STOVE
EXTRACTOR_HOOD
WOOD_BURNING_STOVE
ELECTRIC_STOVE
INDUCTION_STOVE
GAS_STOVE
MICROWAVE_OVEN
SEPARATE_OVEN
EXTRACTOR_HOOD_WITH_FLUE
COOKER_HOOD
CONCRETE
STONE
WOOD
LAMINATE
COMPOSITE
METAL
LIVING_ROOM
ROOM_WITH_FIREPLACE
SAUNA
ELECTRIC_HEATER
WOOD_HEATED_SAUNA_STOVE
ALWAYS_READY_HEATER
READY_FOR_ELECTRIC_HEATER
INTEGRATED_BUCKET
WATER_FAUCET
UNDERFLOOR_HEATING
FLOOR_DRAIN
OPTICAL_FIBRE_LIGHTING
LED_LIGHTING
WINDOW_OUT
TOILET
FLOOR_MOUNTED_WC
WALL_HUNG_WC
BIDET
UNDERFLOOR_HEATING
FLOOR_DRAIN
FREE_STANDING_CABINETS
BASIN_CABINET
MIRROR_CABINET
MIRROR
WASHING_MACHINE_CONNECTION
WASHING_MACHINE
TUMBLE_DRYER
DRYING_CABINET
SHOWER
SHOWER_WALL
WALK_IN_SHOWER
BATHTUB
JACUZZI
UTILITY_ROOM
WASHING_MACHINE_CONNECTION
WASHING_MACHINE
TUMBLE_DRYER
DRYING_CABINET
LAUNDRY_CABINETS
UNDERFLOOR_HEATING
FLOOR_DRAIN
TABLE_TOP
IRONING_TABLE_BOARD
BABY_CHANGING_TABLE
SINK
SHOWER_AND_DRAIN_BY_EXTERIOR_DOOR
CENTRAL_VACUUM_UNIT
EXIT

Realties

Realties API allows you to fetch and search realties created and stored in Ovi PRO using different query criteria. These realties originate from and are managed in Ovi PRO.

Fetch details for a specified realty.

Search with unique realty identifier in UUID format to get the specific realty.

Authorizations:
bearerAuth
path Parameters
realtyId
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique realty identifier in UUID format.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "realtyId": "ddc25849-7bc7-43c0-9c3b-602cb03f7806",
  • "friendlyId": "e2949574",
  • "supplierAssignedIdentifiers": [
    ],
  • "realtyTypeCode": "RESIDENTIAL_SHARE",
  • "realtyStatusCode": "FOR_SALE",
  • "categoryCode": "SALE",
  • "subcategoryCode": "SHARE",
  • "propertyTypeCode": "RESIDENTIAL",
  • "residentialTypeCode": "APARTMENT_HOUSE",
  • "ownershipTypeCode": "OWN",
  • "title": [
    ],
  • "description": [
    ],
  • "address": {
    },
  • "newBuilding": "NO",
  • "agencyOfficeId": "212114ec-819e-483c-a8e0-f82289ac6e19",
  • "apartmentArea": {
    },
  • "constructionYear": 2019,
  • "nextShowing": {
    },
  • "sellingPrice": 200000,
  • "debtFreePrice": 239000,
  • "startingPriceAmount": 115000,
  • "auctionAllowed": true,
  • "currencyCode": "EUR",
  • "availability": {
    },
  • "featuredImageUrl": "//d9zbdvy232i1i.cloudfront.net/{imageParameters}/eomqa1media/ovi/realty/images/ddc25849-7bc7-43c0-9c3b-602cb03f7806/001cd0a905922e7d87bb62de57fddfb8/ORIGINAL.jpeg",
  • "creationTime": "2021-08-31T09:20:11Z",
  • "modificationTime": "2021-08-31T11:42:02Z",
  • "responsibleAgent": {
    },
  • "apartmentRoomCountCode": "3H",
  • "realtyTags": [ ]
}

Search realties.

Search realties with several search criteria.

Authorizations:
bearerAuth
query Parameters
realtyId
Array of strings <uuid> (RealtyId)
Example: realtyId=9fd9124c-e6c1-4368-9f17-6938f0e2f524
friendlyId
string
Example: friendlyId=e29495

Unique friendly identifier for a marketplace announcement.

assignmentId
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: assignmentId=dcc25349-7bc7-48c0-9c8b-6202b03f7806

Search with unique assignment identifier in UUID format to get a list of realties under the specific assignment.

agentId
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: agentId=5d2a6d47-da73-4b11-8940-27cffabb6de5

Search with unique agent identifier in UUID format to get a list of realties the agent is responsible for.

agencyOfficeId
Array of strings <uuid>
Example: agencyOfficeId=212114ec-819e-483c-a8e0-f82289ac6e19

Search with unique agency office identifiers in UUID format to get a list of realties that belong to certain offices.

agencyId
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: agencyId=121241ec-316e-438c-a3e0-f32239ac9e16

Search with unique agency identifier in UUID format to get a list of realties that belong to a certain agency.

organizationGroupId
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: organizationGroupId=1212a1ec-316e-288c-a3e0-f84439bd9e61

Search with unique organization group identifier in UUID format to get a list of realties that belong to a certain organization group.

agencyOfficeTag
string
Example: agencyOfficeTag=Team Red

Search with an agency office tag to get a list of realties that belong to agency offices that have the specified tag.

realtyTypeCode
Array of strings (RealtyTypeCode)
Items Enum: "RESIDENTIAL_SHARE" "OTHER_SHARE" "RESIDENTIAL_PROPERTY" "ESTATE_PROPERTY" "COMMERCIAL_PROPERTY" "OTHER_PROPERTY"
Example: realtyTypeCode=RESIDENTIAL_SHARE

Search with realty type codes to get a list of realties that have the specified types.

realtyStatusCode
Array of strings (RealtyStatusCode)
Items Enum: "DRAFT" "FOR_SALE" "SOLD" "RESERVED" "UNSOLD" "REJECTED" "FOR_RENT" "RENTED" "UNRENTED"
Example: realtyStatusCode=FOR_SALE

Search with realty status codes to get a list of realties that have the specified statuses.

publishingService
string (PublishingService)
Enum: "ETUOVI" "VUOKRAOVI" "OWN_WEBSITE" "OIKOTIE" "TORI"
Example: publishingService=ETUOVI

Search with realty publishing service to get a list of realties that are published in that service.

realtyCategoryCode
Array of strings (RealtyCategoryCode)
Items Enum: "SALE" "RENTAL"
Example: realtyCategoryCode=SALE

Search with realty category codes to get a list of realties with specified categories.

realtySubcategoryCode
Array of strings (RealtySubcategoryCode)
Items Enum: "SHARE" "PROPERTY"
Example: realtySubcategoryCode=SHARE

Search with realty subcategory codes to get a list of realties with specified subcategories.

realtyPropertyTypeCode
Array of strings (RealtyPropertyTypeCode)
Items Enum: "ESTATE" "LEISURE" "PLOT" "RESIDENTIAL" "OTHER" "SUBLEASE" "SHARED_APARTMENT" "COMMERCIAL_PROPERTY"
Example: realtyPropertyTypeCode=RESIDENTIAL

Search with property type codes to get a list of realties with specified property types.

residentialTypeCode
Array of strings (ResidentialTypeCode)
Items Enum: "APARTMENT_HOUSE" "DETACHED_HOUSE" "ROW_HOUSE" "SEMI_DETACHED_HOUSE" "SEPARATE_HOUSE" "WOODEN_HOUSE_APARTMENT" "BALCONY_ACCESS_BLOCK" "COTTAGE" "TIME_SHARE_APARTMENT" "LEISURE_APARTMENT" "OTHER"
Example: residentialTypeCode=APARTMENT_HOUSE

Search with residential type codes to get a list of realties with specified residential types.

plotPropertyTypeCode
Array of strings (PlotPropertyTypeCode)
Items Enum: "APARTMENT_HOUSE_PLOT" "HOLIDAY_PLOT" "HOUSE_PLOT" "ROW_HOUSE_PLOT" "COMMERCIAL_OR_INDUSTRIAL_PLOT" "OTHER"
Example: plotPropertyTypeCode=HOLIDAY_PLOT

Search with plot property type codes to get a list of realties with specified plot types.

estatePropertyTypeCode
Array of strings (EstatePropertyTypeCode)
Items Enum: "ARABLE" "FARM" "FOREST" "PARCEL_OF_LAND" "WILDERNESS" "OTHER"
Example: estatePropertyTypeCode=ARABLE

Search with estate property type codes to get a list of realties with specified estate types.

otherShareTypeCode
Array of strings (OtherShareTypeCode)
Items Enum: "BOAT_HOLD" "CAR_SHED" "CAR_SHELTER" "GARAGE" "PARKING_SLOT" "STORAGE" "OTHER"
Example: otherShareTypeCode=GARAGE

Search with other share type codes to get a list of realties with specified share types.

commercialPropertyTypeCode
Array of strings (CommercialPropertyTypeCode)
Items Enum: "RETAIL_SPACE" "PRODUCTION_FACILITY" "WAREHOUSE" "OFFICE_SPACE" "COWORKING" "CARE_FACILITY" "OTHER" "COMMERCIAL_PLOT" "INDUSTRIAL_PLOT" "STORAGE_PLOT" "SOLAR_FARM"
Example: commercialPropertyTypeCode=RETAIL_SPACE

Search with commercial property type codes to get a list of realties with specified share types.

newBuilding
string (ChoiceEnum)
Enum: "YES" "NO" "NOT_KNOWN"
Example: newBuilding=YES

Search with the value indicating whether the realty has a new building to get a list of realties with new or old buildings. Realties with new buildings will be returned with value YES, realties with old buildings with value NO and realties where this information is not known with value NOT_KNOWN.

apartmentRoomCountCode
Array of strings (ApartmentRoomCountCode)
Items Enum: "1H" "2H" "3H" "4H" "5H" "5H+"
Example: apartmentRoomCountCode=2H&apartmentRoomCountCode=3H

Search with apartment room counts to get a list of realties with specified apartment room counts.

locationCode
Array of strings
Example: locationCode=FI_UUSIMAA&locationCode=FI_PIRKANMAA_TAMPERE&locationCode=FI_PIRKANMAA_TAMPERE_NEKALA

Search with one or more location codes to get a list of realties in any of the specified locations. Location codes represent locations from country to region to locality and district level as returned by location autosuggestion and used in the Realty API.

streetAddress
string
Example: streetAddress=Hämeenkatu 24

Search with street address to get a list of realties in that address.

district
Array of strings
Example: district=Tampere

Search with district names to get a list of realties in specified districts.

regionCode
string
Example: regionCode=FI_PIRKANMAA

Search with region code to get a list of realties with a matching region code.

postcode
string
Example: postcode=33100

Search with postcode to get a list of realties with a matching postcode.

postalArea
Array of strings
Example: postalArea=Tampere

Search with postal areas to get a list of realties in specified postal areas.

localityCode
string
Example: localityCode=FI_PIRKANMAA_TAMPERE

Search with locality code to get a list of realties with a matching locality code.

countryCode
string
Example: countryCode=FI

Search with country code to get a list of realties with a matching country code.

marketingActionStatusCode
Array of strings (PublishStatusCode)
Items Enum: "IN_PROGRESS" "WAITING" "PUBLISHED" "FINISHED" "FAILED"
Example: marketingActionStatusCode=IN_PROGRESS&marketingActionStatusCode=WAITING

Search with marketing action status code to get a list of realties with specified marketing action status codes.

hasApartmentBalcony
string (ChoiceEnum)
Enum: "YES" "NO" "NOT_KNOWN"
Example: hasApartmentBalcony=YES

Search with the value indicating whether the realty has an apartment with a balcony. Realties with apartment balconies will be returned with value YES, realties without balconies with value NO and realties where this information is set to not known with value NOT_KNOWN.

hasApartmentOwnSauna
string (ChoiceEnum)
Enum: "YES" "NO" "NOT_KNOWN"
Example: hasApartmentOwnSauna=YES

Search with the value indicating whether the realty has an apartment with a sauna. Realties with apartment saunas will be returned with value YES, realties without a sauna with value NO and realties where this information is set to not known with value NOT_KNOWN.

hasHousingCompanySauna
string (ChoiceEnum)
Enum: "YES" "NO" "NOT_KNOWN"
Example: hasHousingCompanySauna=YES

Search with the value indicating whether the housing company has a sauna. Realties with housing company saunas will be returned with value YES, realties without a housing company sauna with value NO and realties where this information is set to not known with value NOT_KNOWN.

hasHousingCompanyElevator
string (ChoiceEnum)
Enum: "YES" "NO" "NOT_KNOWN"
Example: hasHousingCompanyElevator=YES

Search with the value indicating whether the housing company has an elevator. Realties with housing company elevators will be returned with value YES, realties without a housing company elevator with value NO and realties where this information is set to not known with value NOT_KNOWN.

modifiedAfter
string <date> (Date)
Example: modifiedAfter=2021-12-31

Search with specific modified after date to get a list of realties which have been modified after and including the specified date.

modifiedBefore
string <date> (Date)
Example: modifiedBefore=2021-12-31

Search with specific modified before date to get a list of realties which have been modified before and including the specified date.

hasFutureShowings
boolean
Example: hasFutureShowings=true

Search with future showings flag to get a list of realties with showings in the future.

priceMin
number
Example: priceMin=200000

Search with minimum price to get a list of realties with price greater than or equal to the given price.

priceMax
number
Example: priceMax=250000

Search with maximum price to get a list of realties with price smaller than or equal to the given price.

conditionCode
Array of strings (ConditionCode)
Items Enum: "NEW" "GOOD" "SATISFACTORY" "TOLERABLE" "UNCLASSIFIED"
Example: conditionCode=GOOD&conditionCode=NEW

Search with condition codes to get a list of realties with specified conditions.

constructionYearMin
integer <int32>
Example: constructionYearMin=2020

Search with minimum construction year to get a list of realties with construction year greater than or equal to the given year.

constructionYearMax
integer <int32>
Example: constructionYearMax=2022

Search with maximum construction year to get a list of realties with construction year smaller than or equal to the given year.

livingAreaMin
number
Example: livingAreaMin=50

Search with minimum living area to get a list of realties with living area greater than or equal to the given area.

livingAreaMax
number

Search with maximum living area to get a list of realties with living area smaller than or equal to the given area.

areaMin
number
Example: areaMin=100

Search with minimum area to get a list of realties with area greater than or equal to the given area.

areaMax
number
Example: areaMax=100

Search with maximum area to get a list of realties with area smaller than or equal to the given area.

freeTextSearch
string
Example: freeTextSearch=Hirsitalo

Search with free text to match realty information with the given search text.

realtyTags
Array of strings (RealtyTag)
Items Enum: "EXCLUSIVE_REALTY" "POTENTIAL_REALTY" "PRIVATE_REALTY"
Example: realtyTags=EXCLUSIVE_REALTY&realtyTags=POTENTIAL_REALTY

Search with realty tags to get a list of realties that have atleast one of the specified tags.

startIndex
integer <int32> >= 0
Default: 0
Example: startIndex=20

Paginate returned data starting from this index inclusive. Index starts from 0.

endIndex
integer <int32> >= 0
Example: endIndex=40

Paginate returned data ending to this index inclusive.

sort
Array of strings
Example: sort=price|asc&sort=modified|desc

Realty search results sorting parameter. Sorting supports multiple sort criteria with combinations of field identifier and direction {field_identifier}|{asc|desc}.

Sort direction can be:

  • asc results are sorted in ascending order
  • desc results are sorted in descending order

Sort field identifier can be:

  • id results are sorted according to realtyId.
  • location results are sorted according to composite location field. Ascending order sorts by [streetAddress, postcode, municipality, country] with empty values last for each. Descending order will reverse this.
  • type results are sorted according to subcategoryCode Finnish translation. Empty values come last for an ascending sort.
  • price results are sorted according to sellingPrice.
  • nextShowing results are sorted according to next showing start time from nextShowing. Ascending order sorts future showings first, past showings next and no showings last. Descending order sorts by future showings in descending order, past showings next and no showings last.
  • status results are sorted according to realtyStatusCode.
  • modified results are sorted according to modificationTime.
  • responsibleAgent results are sorted according to composite agent name field [lastName, firstName] from responsibleAgent. Ascending order sorts empty values last.
header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "realties": [
    ],
  • "totalCount": 2
}

Update realty's friendlyId.

Updates the friendlyId of the realty whose id is given as a path variable.

Authorizations:
bearerAuth
path Parameters
realtyId
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique realty identifier in UUID format.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

Friendly Id data.

friendlyId
required
string (FriendlyId)

Unique friendly identifier for a marketing channel announcement.

Responses

Request samples

Content type
application/json
{
  • "friendlyId": "100000"
}

Response samples

Content type
application/json
{
  • "errorCode": "BAD_REQUEST_PARAMETERS",
  • "message": "Invalid request parameters",
  • "description": "Request parameters are missing or have invalid type.",
  • "errors": [
    ]
}

Residential Share

Residential Share API allows you to create, fetch, update and delete residential shares.

Create a residential share

Creates a new residential share by using the information found from the request body.

Authorizations:
bearerAuth
header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

Contains the information of the created residential share.

categoryCode
required
string (RealtyCategoryCode)
Enum: "SALE" "RENTAL"

Describes if the realty is sold or rented. Possible values are:

  • SALE. Realty is for sale.
  • RENTAL. Realty is for rent.
subcategoryCode
required
string (RealtySubcategoryCodeShare)
Value: "SHARE"

Describes that the realty is a share of the limited liability housing company.

propertyTypeCode
required
string (RealtyPropertyTypeCode)
Enum: "ESTATE" "LEISURE" "PLOT" "RESIDENTIAL" "OTHER" "SUBLEASE" "SHARED_APARTMENT" "COMMERCIAL_PROPERTY"

Describes the high-level type of the realty. Possible values are:

  • ESTATE is a large area of land that can include buildings.
  • LEISURE is a cottage, apartment, or a house that is meant for vacationing.
  • PLOT is a piece of land without habitable buildings.
  • RESIDENTIAL is an apartment which is meant for permanent living.
  • OTHER is most likely a storage or a parking place.
  • SUBLEASE is an apartment given for sublease by an existing tenant.
  • SHARED_APARTMENT is a private room within a shared apartment.
  • COMMERCIAL_PROPERTY is a commercial property.
required
object (RealtyOverview)

Realty details

object (ResidentialShareOverview)

Provides information about the residential share.

object (HousingCompany)

Contains the information of the housing company whose shares are sold.

object (HousingCompanyCharges)

Specifies the charges that must be paid by the share holder.

creationTime
string <date-time> (CreationTime)

Creation time of the realty in the ISO 8601 format. If the value is not provided, the time will be automatically generated upon creating the realty.

Responses

Request samples

Content type
application/json
{
  • "categoryCode": "SALE",
  • "subcategoryCode": "SHARE",
  • "propertyTypeCode": "RESIDENTIAL",
  • "realty": {
    },
  • "residentialShare": {
    },
  • "housingCompany": {
    },
  • "housingCompanyCharges": {
    }
}

Response samples

Content type
application/json
{
  • "realtyId": "91106d71-c3af-4a4a-baad-5b45afad8eda"
}

Get a residential share

Gets the information of the residential share whose id is given as a path variable.

Authorizations:
bearerAuth
path Parameters
realtyId
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique realty identifier in UUID format.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "realtyId": "ddc25849-7bc7-43c0-9c3b-602cb03f7806",
  • "realtyTypeCode": "RESIDENTIAL_SHARE",
  • "realtyStatusCode": "DRAFT",
  • "categoryCode": "SALE",
  • "subcategoryCode": "SHARE",
  • "propertyTypeCode": "RESIDENTIAL",
  • "realty": {
    },
  • "residentialShare": {
    },
  • "housingCompany": {
    },
  • "housingCompanyCharges": {
    },
  • "creationTime": "2021-10-13T17:03:29Z",
  • "modificationTime": "2021-10-14T09:49:23Z"
}

Delete a residential share

Deletes the information of the residential share property whose id is given as a path variable. Note that a residential share property can be deleted only if its status is: DRAFT.

Authorizations:
bearerAuth
path Parameters
realtyId
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique realty identifier in UUID format.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "errorCode": "BAD_REQUEST_PARAMETERS",
  • "message": "Invalid request parameters",
  • "description": "Request parameters are missing or have invalid type.",
  • "errors": [
    ]
}

Update a residential share

Updates the information of the residential share whose id is given as a path variable. The updated information of the residential share must be provided in the request body.

Authorizations:
bearerAuth
path Parameters
realtyId
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique realty identifier in UUID format.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

Contains the updated information of the residential share.

realtyId
required
string <uuid> (RealtyId) ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Unique identifier for the realty.

realtyStatusCode
required
string (RealtyStatusCode)
Enum: "DRAFT" "FOR_SALE" "SOLD" "RESERVED" "UNSOLD" "REJECTED" "FOR_RENT" "RENTED" "UNRENTED"

Realty status. The status defines what actions can be performed for the realty.

propertyTypeCode
string (RealtyPropertyTypeCode)
Enum: "ESTATE" "LEISURE" "PLOT" "RESIDENTIAL" "OTHER" "SUBLEASE" "SHARED_APARTMENT" "COMMERCIAL_PROPERTY"

Describes the high-level type of the realty. Possible values are:

  • ESTATE is a large area of land that can include buildings.
  • LEISURE is a cottage, apartment, or a house that is meant for vacationing.
  • PLOT is a piece of land without habitable buildings.
  • RESIDENTIAL is an apartment which is meant for permanent living.
  • OTHER is most likely a storage or a parking place.
  • SUBLEASE is an apartment given for sublease by an existing tenant.
  • SHARED_APARTMENT is a private room within a shared apartment.
  • COMMERCIAL_PROPERTY is a commercial property.
required
object (RealtyOverview)

Realty details

object (ResidentialShareOverview)

Provides information about the residential share.

object (HousingCompany)

Contains the information of the housing company whose shares are sold.

object (HousingCompanyCharges)

Specifies the charges that must be paid by the share holder.

Responses

Request samples

Content type
application/json
{
  • "realtyId": "ddc25849-7bc7-43c0-9c3b-602cb03f7806",
  • "realtyStatusCode": "DRAFT",
  • "realty": {
    },
  • "residentialShare": {
    },
  • "housingCompany": {
    },
  • "housingCompanyCharges": {
    }
}

Response samples

Content type
application/json
{
  • "errorCode": "BAD_REQUEST_PARAMETERS",
  • "message": "Invalid request parameters",
  • "description": "Request parameters are missing or have invalid type.",
  • "errors": [
    ]
}

Other Share

Other Share API allows you to create, fetch, update and delete other shares.

Create an other share

Creates a new other share by using the information found from the request body.

Authorizations:
bearerAuth
header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

Contains the information of the created other share.

categoryCode
required
string (RealtyCategoryCode)
Enum: "SALE" "RENTAL"

Describes if the realty is sold or rented. Possible values are:

  • SALE. Realty is for sale.
  • RENTAL. Realty is for rent.
subcategoryCode
required
string (RealtySubcategoryCodeShare)
Value: "SHARE"

Describes that the realty is a share of the limited liability housing company.

propertyTypeCode
required
string (RealtyPropertyTypeCode)
Enum: "ESTATE" "LEISURE" "PLOT" "RESIDENTIAL" "OTHER" "SUBLEASE" "SHARED_APARTMENT" "COMMERCIAL_PROPERTY"

Describes the high-level type of the realty. Possible values are:

  • ESTATE is a large area of land that can include buildings.
  • LEISURE is a cottage, apartment, or a house that is meant for vacationing.
  • PLOT is a piece of land without habitable buildings.
  • RESIDENTIAL is an apartment which is meant for permanent living.
  • OTHER is most likely a storage or a parking place.
  • SUBLEASE is an apartment given for sublease by an existing tenant.
  • SHARED_APARTMENT is a private room within a shared apartment.
  • COMMERCIAL_PROPERTY is a commercial property.
required
object (RealtyOverview)

Realty details

object (OtherShareOverview)

The information of an other share.

object (HousingCompany)

Contains the information of the housing company whose shares are sold.

object (HousingCompanyCharges)

Specifies the charges that must be paid by the share holder.

creationTime
string <date-time> (CreationTime)

Creation time of the realty in the ISO 8601 format. If the value is not provided, the time will be automatically generated upon creating the realty.

Responses

Request samples

Content type
application/json
{
  • "categoryCode": "SALE",
  • "subcategoryCode": "SHARE",
  • "propertyTypeCode": "OTHER",
  • "realty": {
    },
  • "otherShare": {
    },
  • "housingCompany": {
    },
  • "housingCompanyCharges": {
    }
}

Response samples

Content type
application/json
{
  • "realtyId": "91106d71-c3af-4a4a-baad-5b45afad8eda"
}

Delete an other share

Deletes the information of the other share whose id is given as a path variable. Note that an other share can be deleted only if its status is: DRAFT.

Authorizations:
bearerAuth
path Parameters
realtyId
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique realty identifier in UUID format.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "errorCode": "BAD_REQUEST_PARAMETERS",
  • "message": "Invalid request parameters",
  • "description": "Request parameters are missing or have invalid type.",
  • "errors": [
    ]
}

Get an other share

Gets the information of the other share whose id is given as a path variable.

Authorizations:
bearerAuth
path Parameters
realtyId
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique realty identifier in UUID format.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "realtyId": "ddc25849-7bc7-43c0-9c3b-602cb03f7806",
  • "realtyTypeCode": "OTHER_SHARE",
  • "realtyStatusCode": "DRAFT",
  • "categoryCode": "SALE",
  • "subcategoryCode": "SHARE",
  • "propertyTypeCode": "OTHER",
  • "realty": {
    },
  • "otherShare": {
    },
  • "housingCompany": {
    },
  • "housingCompanyCharges": {
    },
  • "creationTime": "2021-10-13T22:01:42Z",
  • "modificationTime": "2021-10-14T09:09:09Z"
}

Update an other share

Updates the information of the other share whose id is given as a path variable. The updated information of the other share must be provided in the request body.

Authorizations:
bearerAuth
path Parameters
realtyId
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique realty identifier in UUID format.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

Contains the updated information of the other share.

realtyId
required
string <uuid> (RealtyId) ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Unique identifier for the realty.

realtyStatusCode
required
string (RealtyStatusCode)
Enum: "DRAFT" "FOR_SALE" "SOLD" "RESERVED" "UNSOLD" "REJECTED" "FOR_RENT" "RENTED" "UNRENTED"

Realty status. The status defines what actions can be performed for the realty.

propertyTypeCode
string (RealtyPropertyTypeCode)
Enum: "ESTATE" "LEISURE" "PLOT" "RESIDENTIAL" "OTHER" "SUBLEASE" "SHARED_APARTMENT" "COMMERCIAL_PROPERTY"

Describes the high-level type of the realty. Possible values are:

  • ESTATE is a large area of land that can include buildings.
  • LEISURE is a cottage, apartment, or a house that is meant for vacationing.
  • PLOT is a piece of land without habitable buildings.
  • RESIDENTIAL is an apartment which is meant for permanent living.
  • OTHER is most likely a storage or a parking place.
  • SUBLEASE is an apartment given for sublease by an existing tenant.
  • SHARED_APARTMENT is a private room within a shared apartment.
  • COMMERCIAL_PROPERTY is a commercial property.
required
object (RealtyOverview)

Realty details

object (OtherShareOverview)

The information of an other share.

object (HousingCompany)

Contains the information of the housing company whose shares are sold.

object (HousingCompanyCharges)

Specifies the charges that must be paid by the share holder.

Responses

Request samples

Content type
application/json
{
  • "realtyId": "ddc25849-7bc7-43c0-9c3b-602cb03f7806",
  • "realtyStatusCode": "DRAFT",
  • "realty": {
    },
  • "otherShare": {
    },
  • "housingCompany": {
    },
  • "housingCompanyCharges": {
    }
}

Response samples

Content type
application/json
{
  • "errorCode": "BAD_REQUEST_PARAMETERS",
  • "message": "Invalid request parameters",
  • "description": "Request parameters are missing or have invalid type.",
  • "errors": [
    ]
}

Residential Property

Residential Property API allows you to create, fetch, update and delete residential properties.

Create a residential property

You can create a residential property with the required details.

Authorizations:
bearerAuth
header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

Residential property.

categoryCode
required
string (RealtyCategoryCode)
Enum: "SALE" "RENTAL"

Describes if the realty is sold or rented. Possible values are:

  • SALE. Realty is for sale.
  • RENTAL. Realty is for rent.
subcategoryCode
required
string (RealtySubcategoryCodeProperty)
Value: "PROPERTY"

Describes that the realty is a property.

propertyTypeCode
required
string (RealtyPropertyTypeCode)
Enum: "ESTATE" "LEISURE" "PLOT" "RESIDENTIAL" "OTHER" "SUBLEASE" "SHARED_APARTMENT" "COMMERCIAL_PROPERTY"

Describes the high-level type of the realty. Possible values are:

  • ESTATE is a large area of land that can include buildings.
  • LEISURE is a cottage, apartment, or a house that is meant for vacationing.
  • PLOT is a piece of land without habitable buildings.
  • RESIDENTIAL is an apartment which is meant for permanent living.
  • OTHER is most likely a storage or a parking place.
  • SUBLEASE is an apartment given for sublease by an existing tenant.
  • SHARED_APARTMENT is a private room within a shared apartment.
  • COMMERCIAL_PROPERTY is a commercial property.
required
object (RealtyOverview)

Realty details

object (PropertyOverview)

Property details

object (ResidentialPropertyOverview)

Residential property details

object (PlotOverview)

Plot details

creationTime
string <date-time> (CreationTime)

Creation time of the realty in the ISO 8601 format. If the value is not provided, the time will be automatically generated upon creating the realty.

Responses

Request samples

Content type
application/json
{
  • "categoryCode": "SALE",
  • "subcategoryCode": "PROPERTY",
  • "propertyTypeCode": "RESIDENTIAL",
  • "realty": {
    },
  • "property": {
    },
  • "residentialProperty": {
    },
  • "plot": {
    }
}

Response samples

Content type
application/json
{
  • "realtyId": "ddc25849-7bc7-43c0-9c3b-602bc30f7086"
}

Fetch a residential property

Fetch details for a specified residential.

Authorizations:
bearerAuth
path Parameters
realtyId
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique realty identifier in UUID format.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "realtyId": "ddc25849-7bc7-43c0-9c3b-602bc30f7086",
  • "realtyTypeCode": "RESIDENTIAL_PROPERTY",
  • "realtyStatusCode": "DRAFT",
  • "categoryCode": "SALE",
  • "subcategoryCode": "PROPERTY",
  • "propertyTypeCode": "RESIDENTIAL",
  • "realty": {
    },
  • "property": {
    },
  • "residentialProperty": {
    },
  • "plot": {
    },
  • "creationTime": "2021-10-13T16:26:04Z",
  • "modificationTime": "2021-10-14T11:02:51Z"
}

Update a residential property

You can update the details for an existing residential property.

Authorizations:
bearerAuth
path Parameters
realtyId
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique realty identifier in UUID format.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

Residential property.

realtyId
required
string <uuid> (RealtyId) ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Unique identifier for the realty.

realtyStatusCode
required
string (RealtyStatusCode)
Enum: "DRAFT" "FOR_SALE" "SOLD" "RESERVED" "UNSOLD" "REJECTED" "FOR_RENT" "RENTED" "UNRENTED"

Realty status. The status defines what actions can be performed for the realty.

propertyTypeCode
string (RealtyPropertyTypeCode)
Enum: "ESTATE" "LEISURE" "PLOT" "RESIDENTIAL" "OTHER" "SUBLEASE" "SHARED_APARTMENT" "COMMERCIAL_PROPERTY"

Describes the high-level type of the realty. Possible values are:

  • ESTATE is a large area of land that can include buildings.
  • LEISURE is a cottage, apartment, or a house that is meant for vacationing.
  • PLOT is a piece of land without habitable buildings.
  • RESIDENTIAL is an apartment which is meant for permanent living.
  • OTHER is most likely a storage or a parking place.
  • SUBLEASE is an apartment given for sublease by an existing tenant.
  • SHARED_APARTMENT is a private room within a shared apartment.
  • COMMERCIAL_PROPERTY is a commercial property.
required
object (RealtyOverview)

Realty details

object (PropertyOverview)

Property details

object (ResidentialPropertyOverview)

Residential property details

object (PlotOverview)

Plot details

Responses

Request samples

Content type
application/json
{
  • "realtyId": "ddc25849-7bc7-43c0-9c3b-602bc30f7086",
  • "realtyStatusCode": "DRAFT",
  • "realty": {
    },
  • "property": {
    },
  • "residentialProperty": {
    },
  • "plot": {
    }
}

Response samples

Content type
application/json
{
  • "errorCode": "BAD_REQUEST_PARAMETERS",
  • "message": "Invalid request parameters",
  • "description": "Request parameters are missing or have invalid type.",
  • "errors": [
    ]
}

Delete a residential property.

Deletes the information of the residential property whose id is given as a path variable. Note that a residential property can be deleted only if its status is: DRAFT.

Authorizations:
bearerAuth
path Parameters
realtyId
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique realty identifier in UUID format.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "errorCode": "BAD_REQUEST_PARAMETERS",
  • "message": "Invalid request parameters",
  • "description": "Request parameters are missing or have invalid type.",
  • "errors": [
    ]
}

Estate Property

Estate Property API allows you to create, fetch, update and delete estate properties.

Create an estate property

You can create a estate property with the required details.

Authorizations:
bearerAuth
header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

Estate property.

categoryCode
required
string (RealtyCategoryCode)
Enum: "SALE" "RENTAL"

Describes if the realty is sold or rented. Possible values are:

  • SALE. Realty is for sale.
  • RENTAL. Realty is for rent.
subcategoryCode
required
string (RealtySubcategoryCodeProperty)
Value: "PROPERTY"

Describes that the realty is a property.

propertyTypeCode
required
string (RealtyPropertyTypeCode)
Enum: "ESTATE" "LEISURE" "PLOT" "RESIDENTIAL" "OTHER" "SUBLEASE" "SHARED_APARTMENT" "COMMERCIAL_PROPERTY"

Describes the high-level type of the realty. Possible values are:

  • ESTATE is a large area of land that can include buildings.
  • LEISURE is a cottage, apartment, or a house that is meant for vacationing.
  • PLOT is a piece of land without habitable buildings.
  • RESIDENTIAL is an apartment which is meant for permanent living.
  • OTHER is most likely a storage or a parking place.
  • SUBLEASE is an apartment given for sublease by an existing tenant.
  • SHARED_APARTMENT is a private room within a shared apartment.
  • COMMERCIAL_PROPERTY is a commercial property.
required
object (RealtyOverview)

Realty details

object (PropertyOverview)

Property details

object (ResidentialPropertyOverview)

Residential property details

object (EstateOverview)

Estate details

object (PlotOverview)

Plot details

creationTime
string <date-time> (CreationTime)

Creation time of the realty in the ISO 8601 format. If the value is not provided, the time will be automatically generated upon creating the realty.

Responses

Request samples

Content type
application/json
{
  • "categoryCode": "SALE",
  • "subcategoryCode": "PROPERTY",
  • "propertyTypeCode": "ESTATE",
  • "realty": {
    },
  • "property": {
    },
  • "estate": {
    },
  • "plot": {
    }
}

Response samples

Content type
application/json
{
  • "realtyId": "ddc25849-7bc7-43c0-9c3b-602dc80f7036"
}

Fetch an estate property

Fetch details for a specified estate.

Authorizations:
bearerAuth
path Parameters
realtyId
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique realty identifier in UUID format.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "realtyId": "ddc25849-7bc7-43c0-9c3b-602dc80f7036",
  • "realtyTypeCode": "ESTATE_PROPERTY",
  • "realtyStatusCode": "DRAFT",
  • "categoryCode": "SALE",
  • "subcategoryCode": "PROPERTY",
  • "propertyTypeCode": "ESTATE",
  • "realty": {
    },
  • "property": {
    },
  • "estate": {
    },
  • "plot": {
    },
  • "creationTime": "2021-10-13T11:08:31Z",
  • "modificationTime": "2021-10-14T11:41:02Z"
}

Update an estate property

You can update the details for an existing estate property.

Authorizations:
bearerAuth
path Parameters
realtyId
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique realty identifier in UUID format.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

Estate property.

realtyId
required
string <uuid> (RealtyId) ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Unique identifier for the realty.

realtyStatusCode
required
string (RealtyStatusCode)
Enum: "DRAFT" "FOR_SALE" "SOLD" "RESERVED" "UNSOLD" "REJECTED" "FOR_RENT" "RENTED" "UNRENTED"

Realty status. The status defines what actions can be performed for the realty.

propertyTypeCode
string (RealtyPropertyTypeCode)
Enum: "ESTATE" "LEISURE" "PLOT" "RESIDENTIAL" "OTHER" "SUBLEASE" "SHARED_APARTMENT" "COMMERCIAL_PROPERTY"

Describes the high-level type of the realty. Possible values are:

  • ESTATE is a large area of land that can include buildings.
  • LEISURE is a cottage, apartment, or a house that is meant for vacationing.
  • PLOT is a piece of land without habitable buildings.
  • RESIDENTIAL is an apartment which is meant for permanent living.
  • OTHER is most likely a storage or a parking place.
  • SUBLEASE is an apartment given for sublease by an existing tenant.
  • SHARED_APARTMENT is a private room within a shared apartment.
  • COMMERCIAL_PROPERTY is a commercial property.
required
object (RealtyOverview)

Realty details

object (PropertyOverview)

Property details

object (ResidentialPropertyOverview)

Residential property details

object (EstateOverview)

Estate details

object (PlotOverview)

Plot details

Responses

Request samples

Content type
application/json
{
  • "realtyId": "ddc25849-7bc7-43c0-9c3b-602dc80f7036",
  • "realtyStatusCode": "DRAFT",
  • "realty": {
    },
  • "property": {
    },
  • "estate": {
    },
  • "plot": {
    }
}

Response samples

Content type
application/json
{
  • "errorCode": "BAD_REQUEST_PARAMETERS",
  • "message": "Invalid request parameters",
  • "description": "Request parameters are missing or have invalid type.",
  • "errors": [
    ]
}

Delete an estate property.

Deletes the information of the estate property whose id is given as a path variable. Note that a estate property can be deleted only if its status is: DRAFT.

Authorizations:
bearerAuth
path Parameters
realtyId
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique realty identifier in UUID format.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "errorCode": "BAD_REQUEST_PARAMETERS",
  • "message": "Invalid request parameters",
  • "description": "Request parameters are missing or have invalid type.",
  • "errors": [
    ]
}

Other Property

Other Property API allows you to create, fetch, update and delete plot or other properties.

Create a plot or other property

You can create a plot or any other than estate or residential property with the required details using this endpoint.

Authorizations:
bearerAuth
header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

Other or plot property data.

categoryCode
required
string (RealtyCategoryCode)
Enum: "SALE" "RENTAL"

Describes if the realty is sold or rented. Possible values are:

  • SALE. Realty is for sale.
  • RENTAL. Realty is for rent.
subcategoryCode
required
string (RealtySubcategoryCodeProperty)
Value: "PROPERTY"

Describes that the realty is a property.

propertyTypeCode
required
string (RealtyPropertyTypeCode)
Enum: "ESTATE" "LEISURE" "PLOT" "RESIDENTIAL" "OTHER" "SUBLEASE" "SHARED_APARTMENT" "COMMERCIAL_PROPERTY"

Describes the high-level type of the realty. Possible values are:

  • ESTATE is a large area of land that can include buildings.
  • LEISURE is a cottage, apartment, or a house that is meant for vacationing.
  • PLOT is a piece of land without habitable buildings.
  • RESIDENTIAL is an apartment which is meant for permanent living.
  • OTHER is most likely a storage or a parking place.
  • SUBLEASE is an apartment given for sublease by an existing tenant.
  • SHARED_APARTMENT is a private room within a shared apartment.
  • COMMERCIAL_PROPERTY is a commercial property.
required
object (RealtyOverview)

Realty details

object (PropertyOverview)

Property details

object (PlotOverview)

Plot details

creationTime
string <date-time> (CreationTime)

Creation time of the realty in the ISO 8601 format. If the value is not provided, the time will be automatically generated upon creating the realty.

Responses

Request samples

Content type
application/json
{
  • "categoryCode": "SALE",
  • "subcategoryCode": "PROPERTY",
  • "propertyTypeCode": "PLOT",
  • "realty": {
    },
  • "property": {
    },
  • "plot": {
    }
}

Response samples

Content type
application/json
{
  • "realtyId": "ddc25849-7bc7-43c0-9c3b-602cb03f7806"
}

Fetch a plot or other property

Fetch details for a specified plot or any other than estate or residential property using this endpoint.

Authorizations:
bearerAuth
path Parameters
realtyId
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique realty identifier in UUID format.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "realtyId": "ddc25849-7bc7-43c0-9c3b-602cb03f7806",
  • "realtyTypeCode": "OTHER_PROPERTY",
  • "realtyStatusCode": "DRAFT",
  • "categoryCode": "SALE",
  • "subcategoryCode": "PROPERTY",
  • "propertyTypeCode": "PLOT",
  • "realty": {
    },
  • "property": {
    },
  • "plot": {
    },
  • "creationTime": "2021-10-13T09:54:12Z",
  • "modificationTime": "2021-10-14T18:32:02Z"
}

Update a plot or other property

You can update the details for an existing plot or any other than estate or residential property using this endpoint.

Authorizations:
bearerAuth
path Parameters
realtyId
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique realty identifier in UUID format.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

Plot or other property data.

realtyId
required
string <uuid> (RealtyId) ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Unique identifier for the realty.

realtyStatusCode
required
string (RealtyStatusCode)
Enum: "DRAFT" "FOR_SALE" "SOLD" "RESERVED" "UNSOLD" "REJECTED" "FOR_RENT" "RENTED" "UNRENTED"

Realty status. The status defines what actions can be performed for the realty.

propertyTypeCode
string (RealtyPropertyTypeCode)
Enum: "ESTATE" "LEISURE" "PLOT" "RESIDENTIAL" "OTHER" "SUBLEASE" "SHARED_APARTMENT" "COMMERCIAL_PROPERTY"

Describes the high-level type of the realty. Possible values are:

  • ESTATE is a large area of land that can include buildings.
  • LEISURE is a cottage, apartment, or a house that is meant for vacationing.
  • PLOT is a piece of land without habitable buildings.
  • RESIDENTIAL is an apartment which is meant for permanent living.
  • OTHER is most likely a storage or a parking place.
  • SUBLEASE is an apartment given for sublease by an existing tenant.
  • SHARED_APARTMENT is a private room within a shared apartment.
  • COMMERCIAL_PROPERTY is a commercial property.
required
object (RealtyOverview)

Realty details

object (PropertyOverview)

Property details

object (PlotOverview)

Plot details

Responses

Request samples

Content type
application/json
{
  • "realtyId": "ddc25849-7bc7-43c0-9c3b-602cb03f7806",
  • "realtyStatusCode": "DRAFT",
  • "realty": {
    },
  • "property": {
    },
  • "plot": {
    }
}

Response samples

Content type
application/json
{
  • "errorCode": "BAD_REQUEST_PARAMETERS",
  • "message": "Invalid request parameters",
  • "description": "Request parameters are missing or have invalid type.",
  • "errors": [
    ]
}

Delete a plot or other property

Deletes the information of the plot or any other than estate or residential property whose id is given as a path variable using this endpoint. Note that a plot property can be deleted only if its status is: DRAFT.

Authorizations:
bearerAuth
path Parameters
realtyId
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique realty identifier in UUID format.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "errorCode": "BAD_REQUEST_PARAMETERS",
  • "message": "Invalid request parameters",
  • "description": "Request parameters are missing or have invalid type.",
  • "errors": [
    ]
}

Commercial Property

Commercial Property API allows you to create, fetch, update and delete commercial properties.

Create a commercial property

You can create a commercial property with the required details.

Authorizations:
bearerAuth
header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

Details for a commercial property.

categoryCode
required
string (RealtyCategoryCode)
Enum: "SALE" "RENTAL"

Describes if the realty is sold or rented. Possible values are:

  • SALE. Realty is for sale.
  • RENTAL. Realty is for rent.
subcategoryCode
required
string (RealtySubcategoryCode)
Enum: "SHARE" "PROPERTY"

Describes if the realty is a share of the limited liability housing company or a property.

  • SHARE. Realty is a share of the limited liability housing company.
  • PROPERTY. Realty is a property.
propertyTypeCode
required
string (RealtyPropertyTypeCode)
Enum: "ESTATE" "LEISURE" "PLOT" "RESIDENTIAL" "OTHER" "SUBLEASE" "SHARED_APARTMENT" "COMMERCIAL_PROPERTY"

Describes the high-level type of the realty. Possible values are:

  • ESTATE is a large area of land that can include buildings.
  • LEISURE is a cottage, apartment, or a house that is meant for vacationing.
  • PLOT is a piece of land without habitable buildings.
  • RESIDENTIAL is an apartment which is meant for permanent living.
  • OTHER is most likely a storage or a parking place.
  • SUBLEASE is an apartment given for sublease by an existing tenant.
  • SHARED_APARTMENT is a private room within a shared apartment.
  • COMMERCIAL_PROPERTY is a commercial property.
required
object (RealtyOverview)

Realty details

object (CommercialPropertyOverview)

Contains details about the commercial property.

object (HousingCompany)

Contains the information of the housing company whose shares are sold.

object (HousingCompanyCharges)

Specifies the charges that must be paid by the share holder.

object (PropertyOverview)

Property details

object (PlotOverview)

Plot details

creationTime
string <date-time> (CreationTime)

Creation time of the realty in the ISO 8601 format. If the value is not provided, the time will be automatically generated upon creating the realty.

Responses

Request samples

Content type
application/json
{
  • "categoryCode": "SALE",
  • "subcategoryCode": "SHARE",
  • "propertyTypeCode": "COMMERCIAL_PROPERTY",
  • "realty": {
    },
  • "commercialProperty": {
    }
}

Response samples

Content type
application/json
{
  • "realtyId": "9b907eb3-e868-412b-a3ab-bfccc584317e"
}

Fetch a commercial property

Fetch details for a specified commercial property using this endpoint.

Authorizations:
bearerAuth
path Parameters
realtyId
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique realty identifier in UUID format.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "realtyId": "7d5da3a9-e8a6-4b3e-be8c-f92d8b19b20e",
  • "realtyTypeCode": "COMMERCIAL_PROPERTY",
  • "realtyStatusCode": "DRAFT",
  • "categoryCode": "SALE",
  • "subcategoryCode": "SHARE",
  • "propertyTypeCode": "COMMERCIAL_PROPERTY",
  • "realty": {
    },
  • "commercialProperty": {
    },
  • "creationTime": "2022-10-13T11:08:31Z",
  • "modificationTime": "2022-10-14T11:41:02Z"
}

Update a commercial property

You can update the details for an existing commercial property using this endpoint.

Authorizations:
bearerAuth
path Parameters
realtyId
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique realty identifier in UUID format.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

Commercial property.

realtyId
required
string <uuid> (RealtyId) ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Unique identifier for the realty.

realtyStatusCode
required
string (RealtyStatusCode)
Enum: "DRAFT" "FOR_SALE" "SOLD" "RESERVED" "UNSOLD" "REJECTED" "FOR_RENT" "RENTED" "UNRENTED"

Realty status. The status defines what actions can be performed for the realty.

propertyTypeCode
string (RealtyPropertyTypeCode)
Enum: "ESTATE" "LEISURE" "PLOT" "RESIDENTIAL" "OTHER" "SUBLEASE" "SHARED_APARTMENT" "COMMERCIAL_PROPERTY"

Describes the high-level type of the realty. Possible values are:

  • ESTATE is a large area of land that can include buildings.
  • LEISURE is a cottage, apartment, or a house that is meant for vacationing.
  • PLOT is a piece of land without habitable buildings.
  • RESIDENTIAL is an apartment which is meant for permanent living.
  • OTHER is most likely a storage or a parking place.
  • SUBLEASE is an apartment given for sublease by an existing tenant.
  • SHARED_APARTMENT is a private room within a shared apartment.
  • COMMERCIAL_PROPERTY is a commercial property.
required
object (RealtyOverview)

Realty details

object (CommercialPropertyOverview)

Contains details about the commercial property.

object (HousingCompany)

Contains the information of the housing company whose shares are sold.

object (HousingCompanyCharges)

Specifies the charges that must be paid by the share holder.

object (PropertyOverview)

Property details

object (PlotOverview)

Plot details

Responses

Request samples

Content type
application/json
{
  • "realtyId": "7d5da3a9-e8a6-4b3e-be8c-f92d8b19b20e",
  • "realtyStatusCode": "DRAFT",
  • "propertyTypeCode": "COMMERCIAL_PROPERTY",
  • "realty": {
    },
  • "commercialProperty": {
    }
}

Response samples

Content type
application/json
{
  • "errorCode": "BAD_REQUEST_PARAMETERS",
  • "message": "Invalid request parameters",
  • "description": "Request parameters are missing or have invalid type.",
  • "errors": [
    ]
}

Delete a commercial property

Deletes the commercial property whose id is given as a path variable using this endpoint. Note that a commercial property can be deleted only if its status is: DRAFT.

Authorizations:
bearerAuth
path Parameters
realtyId
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique realty identifier in UUID format.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "errorCode": "BAD_REQUEST_PARAMETERS",
  • "message": "Invalid request parameters",
  • "description": "Request parameters are missing or have invalid type.",
  • "errors": [
    ]
}

Showing

Showing API allows you to create, fetch, update and delete showings.

Create a showing

You can create a showing with the required details. If isShowingHeld is true, parties will be locked and cant be modified anymore.

Authorizations:
bearerAuth
header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

Showing data.

realtyId
required
string <uuid> (RealtyId) ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Unique identifier for the realty.

object (AgentReference)

Identification information for an agent.

Array of objects (ShowingParty)

List of parties participating in the showing.

showingTypeCode
required
string (ShowingTypeCode)
Enum: "PRIVATE" "PUBLIC"

Describes the type of showing. Possible values are:

  • PRIVATE the showing is held privately to a certain potential customer.
  • PUBLIC the showing is held publicly to all interested customers.
date
required
string <date> (Date)

Date in the ISO 8601 format.

startTime
required
string <date-time> (DateTime)

Date and time in the ISO 8601 format.

endTime
required
string <date-time> (DateTime)

Date and time in the ISO 8601 format.

isFirstShowing
boolean

Indicates whether this is the first showing of the realty.

isRemoteShowing
boolean

Indicates whether this showing is arranged remotely.

remoteShowingUrl
string

Address of a video conferencing service used to carry out the remote showing. Using this link the customers can participate in the showing.

Array of objects (TranslatedText)

An array which contains the different translations.

isShowingHeld
boolean

Indicates whether this showing is already held. If the showing is held, parties and isShowingHeld can't be changed.

numberOfVisitors
integer <int32>

Number of visitors in the held showing.

notesFromShowing
string

Notes from the showing for reporting purposes.

visitorContacts
Array of strings <uuid> (ContactId)

List of visitor contacts from the showing.

Responses

Request samples

Content type
application/json
{
  • "realtyId": "ddc25849-7bc7-43c0-9c3b-602cb03f7806",
  • "agent": {
    },
  • "showingTypeCode": "PUBLIC",
  • "date": "2021-09-19",
  • "startTime": "2021-09-19T14:15:00Z",
  • "endTime": "2021-09-19T14:45:00Z",
  • "isFirstShowing": false,
  • "isRemoteShowing": true,
  • "remoteShowingUrl": "https://www.some-streaming-video-service.com/123",
  • "description": [
    ],
  • "isShowingHeld": false
}

Response samples

Content type
application/json
{
  • "showingId": "95906d17-c84e-13a3-8aba-4646fafdedab"
}

Search showings

Search with list of showing identifiers or agent or realty identifier to get a list of showings. Without query parameters, all showings the user has viewing rights to are returned.

Authorizations:
bearerAuth
query Parameters
showingId
Array of strings <uuid>
Example: showingId=212114ec-819e-483c-a8e0-f82289ac6e19

Search with unique showing identifiers in UUID format to get a list of showings.

realtyId
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: realtyId=ddc25849-7bc7-43c0-9c3b-602cb03f7806

Search with unique realty identifier in UUID format to get a list of the realty's showings.

agentId
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: agentId=5d2a6d47-da73-4b11-8940-27cffabb6de5

Search with unique agent identifier in UUID format to get a list of the agent's showings.

partyId
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: partyId=5d2a6d47-da73-4b11-8940-27cffabb6de5

Search with unique party identifier in UUID format to get a list of the party's showings.

isShowingHeld
boolean

Search with the boolean flag to get a list of unheld or held showings.

modifiedAfter
string <date-time> (DateTime)
Example: modifiedAfter=2022-12-31T13:00:00Z

Search with modifiedAfter dateTime in ISO 8601 format to get a list of showings which have been modified after the specified date.

startIndex
integer <int32> >= 0
Default: 0

Paginate returned data starting from this index inclusive. Index starts from 0.

size
integer <int32> [ 0 .. 100 ]
Default: 20
Example: size=20

Paginate returned data with this size.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Update a showing.

Updates the information of the showing whose id is given as a path variable. If isShowingHeld is true, parties will be locked and cant be modified anymore.

Authorizations:
bearerAuth
path Parameters
showingId
required
string <uuid> (ShowingId) ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 47927fe2-f24c-40ea-8257-09dafae264c7

Unique identifier for the showing.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

Showing data.

showingId
required
string <uuid> (ShowingId) ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Unique identifier for the showing.

required
object (ShowingOverviewWrite)

Showing details

Responses

Request samples

Content type
application/json
{
  • "showingId": "47927fe2-f24c-40ea-8257-09dafae264c7",
  • "showing": {
    }
}

Response samples

Content type
application/json
{
  • "errorCode": "BAD_REQUEST_PARAMETERS",
  • "message": "Invalid request parameters",
  • "description": "Request parameters are missing or have invalid type.",
  • "errors": [
    ]
}

Delete a showing.

Deletes the information of the showing whose id is given as a path variable. A showing can only be deleted before starting time defined in property startTime.

Authorizations:
bearerAuth
path Parameters
showingId
required
string <uuid> (ShowingId) ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 47927fe2-f24c-40ea-8257-09dafae264c7

Unique identifier for the showing.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "errorCode": "BAD_REQUEST_PARAMETERS",
  • "message": "Invalid request parameters",
  • "description": "Request parameters are missing or have invalid type.",
  • "errors": [
    ]
}

Transferred Realties

Transferred Realties API allows you to fetch, search and partially update realties, which have been transferred to Etuovi.com or Vuokraovi.com from other systems for publishing. These realties originate from other source systems and are transferred via integration to Etuovi or Vuokraovi where they are fetched to Ovi PRO from.

Fetch details for a specified transferred realty

Search with unique supplier assigned identifier to get a specific realty, which is transferred via integration to Etuovi or Vuokraovi.

Authorizations:
bearerAuth
path Parameters
supplierAssignedId
required
string
Example: abc_11223344

Identifier assigned for the realty by another system.

  • With Etuovi, schemeId ETUOVI_ANNOUNCEMENT_ID should be used.
  • With Vuokraovi, schemeId VUOKRAOVI_ANNOUNCEMENT_ID should be used.
query Parameters
schemeId
required
string
Example: schemeId=ETUOVI_ANNOUNCEMENT_ID

Identifies the source system and type of the supplierAssignedId.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "realtyId": "ddc25849-7bc7-43c0-9c3b-602cb03f7806",
  • "friendlyId": "82949574",
  • "supplierAssignedIdentifiers": [
    ],
  • "integrationSourceSystem": "ABC",
  • "realtyTypeCode": "RESIDENTIAL_SHARE",
  • "realtyStatusCode": "FOR_SALE",
  • "categoryCode": "SALE",
  • "subcategoryCode": "SHARE",
  • "propertyTypeCode": "RESIDENTIAL",
  • "residentialTypeCode": "APARTMENT_HOUSE",
  • "ownershipTypeCode": "OWN",
  • "title": [
    ],
  • "description": [
    ],
  • "address": {
    },
  • "newBuilding": "NO",
  • "agencyOfficeId": "212114ec-819e-483c-a8e0-f82289ac6e19",
  • "apartmentArea": {
    },
  • "constructionYear": 2019,
  • "nextShowing": {
    },
  • "sellingPrice": 200000,
  • "debtFreePrice": 239000,
  • "startingPriceAmount": 115000,
  • "auctionAllowed": true,
  • "currencyCode": "EUR",
  • "notifyIfPriceChanged": "NOT_KNOWN",
  • "availability": {
    },
  • "featuredImageUrl": "//d9zbdvy232i1i.cloudfront.net/{imageParameters}/eomqa1media/ovi/realty/images/ddc25849-7bc7-43c0-9c3b-602cb03f7806/001cd0a905922e7d87bb62de57fddfb8/ORIGINAL.jpeg",
  • "creationTime": "2021-08-31T09:20:11Z",
  • "modificationTime": "2021-08-31T11:42:02Z",
  • "responsibleAgent": {
    },
  • "apartmentRoomCountCode": "3H",
  • "realtyTags": [ ]
}

Search transferred realties

Search realties, which are transferred via integration to Etuovi or Vuokraovi.

Authorizations:
bearerAuth
query Parameters
agencyOfficeId
Array of strings <uuid>
Example: agencyOfficeId=212114ec-819e-483c-a8e0-f82289ac6e19

Search with unique agency office identifiers in UUID format to get a list of realties that belong to certain offices.

realtyCategoryCode
string
Default: "SALE"
Enum: "SALE" "RENTAL"
Example: realtyCategoryCode=SALE

Search with realty category code to get a list of realties with specified category.

realtyPropertyTypeCode
string (RealtyPropertyTypeCode)
Enum: "ESTATE" "LEISURE" "PLOT" "RESIDENTIAL" "OTHER" "SUBLEASE" "SHARED_APARTMENT" "COMMERCIAL_PROPERTY"
Example: realtyPropertyTypeCode=RESIDENTIAL

Search with property type code to get a list of realties with specified property type.

freeTextSearch
string
Example: freeTextSearch=Satakunnankatu

Search with free text to match realty information with the given search text.

startIndex
integer <int32> >= 0
Default: 0
Example: startIndex=20

Paginate returned data starting from this index inclusive. Index 0 represents the first realty.

endIndex
integer <int32> >= 0

Paginate returned data ending to this index inclusive. Default value is startIndex + 29. endIndex must fullfill the following conditions:

      * `endIndex >= startIndex`
      * `endIndex - startIndex < 100`
  example: 39
sort
string
Example: sort=price|asc

Realty search results sorting parameter is a combinations of field identifier and direction {field_identifier}|{asc|desc}.

Sort direction can be:

  • asc results are sorted in ascending order
  • desc results are sorted in descending order

Sort field identifier can be:

  • price results are sorted according to sellingPrice.
  • rent results are sorted according to monthlyRent.
  • nextShowing results are sorted according to next showing start time from nextShowing. Future showings are sorted first, past showings and no showings last.
  • modified results are sorted according to modificationTime.
header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "realties": [
    ],
  • "totalCount": 2
}

Create a transferred realty update

You can update a subset of fields of a transferred realty. Instead of sending the full resource, you can send the updated fields only. The possible fields are:

    * `notifyIfPriceChanged` specifies if the price changes are highlighted on Etuovi.com
    * `location` identifies the geolocation of the realty as part of `address`
Authorizations:
bearerAuth
header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

List of updated fields with new values.

required
object (SupplierAssignedIdentifier)
object

Contains the updated fields of the transferred realty with the new values.

Responses

Request samples

Content type
application/json
{
  • "supplierAssignedIdentifier": {
    },
  • "update": {
    }
}

Response samples

Content type
application/json
{
  • "supplierAssignedIdentifier": {
    }
}

Diary Events

Diary Events API allows fetching event history of given realty.

Get diary events for realty

Returns ealty's diary events.

Authorizations:
bearerAuth
path Parameters
realtyId
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique realty identifier in UUID format.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "realtyId": "535b22ca-f837-4a98-a2fb-05484468d798",
  • "realtyTypeCode": "OTHER_SHARE",
  • "categoryCode": "SALE",
  • "creationTime": "2024-01-12T09:20:11Z",
  • "initialPricing": {
    },
  • "pricingChanges": [
    ],
  • "statusChanges": [
    ]
}

Notes

Notes API allows you to create, fetch, update and delete notes.

Create a new note

Create a new note. One realty can have maximum 20 notes.

Authorizations:
bearerAuth
header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

Request body contains details of the note to be created.

note
required
string [ 1 .. 500 ] characters

The content of the note

realtyId
required
string <uuid>

The realty id related to the note.

Responses

Request samples

Content type
application/json
{
  • "note": "This is a note.",
  • "realtyId": "123e4567-e89b-12d3-a456-426655440000"
}

Response samples

Content type
application/json
{
  • "noteId": "c6d2288d-2ecb-448a-aef3-fd5144920e0b"
}

Search notes

Search notes with specified parameters.

Authorizations:
bearerAuth
query Parameters
realtyId
required
string <uuid>

Identifier of the realty for which notes are searched.

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "totalCount": 1,
  • "notes": [
    ]
}

Update a note

Update a note.

Authorizations:
bearerAuth
path Parameters
noteId
required
string <uuid>
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

Identifier of the note

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

Request body contains details of the note to be updated.

note
required
string [ 1 .. 500 ] characters

The content of the note

Responses

Request samples

Content type
application/json
{
  • "note": "This is a note."
}

Response samples

Content type
application/json
{
  • "errorCode": "BAD_REQUEST_PARAMETERS",
  • "message": "Invalid request parameters",
  • "description": "Request parameters are missing or have invalid type.",
  • "errors": [
    ]
}

Delete a note

Delete a note.

Authorizations:
bearerAuth
path Parameters
noteId
required
string <uuid>
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

Identifier of the note

header Parameters
Request-ID
required
string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "errorCode": "BAD_REQUEST_PARAMETERS",
  • "message": "Invalid request parameters",
  • "description": "Request parameters are missing or have invalid type.",
  • "errors": [
    ]
}