Contents x
    Update Real Estate data partially
    • 17 Jan 2024
    • 3 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Update Real Estate data partially

    • Updated on 17 Jan 2024
    • 3 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Patch
    /real-estate/{id}/

    Operation is used to update specific fields in existing Real Estate data.

    Security
    API Key
    Header parameter nameAuthorization

    Token issued for API consumer.

    Path parameters
    id
    integerRequired

    Id of Real Estate to update

    Body parameters

    Real Estate attributes and values to be updated

    Expand All
    object
    Address
    object (Apartment)
    address
    object (Address)Required
    buildingId
    string

    Building id

    city
    string Required

    Building city name

    cityAlt
    string

    Building city name in alternative language

    country
    string

    Building country

    createdBy
    string

    creator

    createdTs
    string (date-time)

    Creation date and time

    district
    string

    Building district

    id
    integer

    Primary key

    location
    string (ewkt)

    Geographical location

    municipality
    string

    Building municipality

    propertyId
    string

    Property number

    province
    string

    Building province

    streetname
    string Required

    Building street name

    streetnameAlt
    string

    Building street name in alternative language

    streetno
    string Required

    Building number

    subdivision
    string

    Building municipality subdivision

    updatedBy
    string

    Last updater

    updatedTs
    string (date-time)

    Last update date time

    usagePurpose
    object (BuildingUsage)

    Building usage purpose

    groupname

    Group name of constant

    Valid values[ "BUILDING_USAGE" ]
    id
    integer Required

    Unique id of constant

    list_url
    string (url) Required

    Url to fetch all contants from this group

    logical_txt
    string Required

    Logical textual value

    txt
    string Required

    Human readable textual representation

    usagePurposeAlt
    object (AddressSecondaryUsage)

    Address usage purpose

    groupname

    Group name of constant

    Valid values[ "KN_ADDR_SPEC" ]
    id
    integer Required

    Unique id of constant

    list_url
    string (url) Required

    Url to fetch all contants from this group

    logical_txt
    string Required

    Logical textual value

    txt
    string Required

    Human readable textual representation

    zipcode
    string

    Building zipcode

    apartmentDivision
    string

    apartment division

    apartmentLetter
    string

    apartment letter

    apartmentNumber
    string

    apartment number

    id
    integer

    Primary key

    originProperty
    string

    apartment original property id

    originalStreetno
    string

    apartment original streen number

    usagePurpose
    object (ApartmentUsage)

    Apartment Usage purpose

    groupname

    Group name of constant

    Valid values[ "APARTMENT_USAGE" ]
    id
    integer Required

    Unique id of constant

    list_url
    string (url) Required

    Url to fetch all contants from this group

    logical_txt
    string Required

    Logical textual value

    txt
    string Required

    Human readable textual representation

    usagePurposeAlt
    object (AddressSecondaryUsage)

    Address usage purpose

    groupname

    Group name of constant

    Valid values[ "KN_ADDR_SPEC" ]
    id
    integer Required

    Unique id of constant

    list_url
    string (url) Required

    Url to fetch all contants from this group

    logical_txt
    string Required

    Logical textual value

    txt
    string Required

    Human readable textual representation

    usageState
    object (ApartmentStatus)

    Apartment status

    groupname

    Group name of constant

    Valid values[ "APARTMENT_STATUS" ]
    id
    integer Required

    Unique id of constant

    list_url
    string (url) Required

    Url to fetch all contants from this group

    logical_txt
    string Required

    Logical textual value

    txt
    string Required

    Human readable textual representation

    basement_area
    integer

    Basement area

    build_date
    string (date)

    Build date

    building_classification
    string

    Building classification

    construction_licence
    integer

    Construction license

    flat_area
    integer

    Flat area

    floor_area
    integer

    Floor area

    floor_number
    integer

    Floor number

    id
    integer

    Primary key

    location
    string (ewkt)

    Geographical location

    owner
    string

    Owner

    real_estate_name
    string

    Real estate name

    real_estate_number
    string

    Real estate number

    total_area
    integer

    Total area

    volume
    integer

    Volume

    Responses
    200

    Object was updated successfully

    Expand All
    object
    Address
    object (Apartment)
    address
    object (Address)
    buildingId
    string

    Building id

    city
    string

    Building city name

    cityAlt
    string

    Building city name in alternative language

    country
    string

    Building country

    createdBy
    string

    creator

    createdTs
    string (date-time)

    Creation date and time

    district
    string

    Building district

    id
    integer

    Primary key

    location
    string (ewkt)

    Geographical location

    municipality
    string

    Building municipality

    propertyId
    string

    Property number

    province
    string

    Building province

    streetname
    string

    Building street name

    streetnameAlt
    string

    Building street name in alternative language

    streetno
    string

    Building number

    subdivision
    string

    Building municipality subdivision

    updatedBy
    string

    Last updater

    updatedTs
    string (date-time)

    Last update date time

    usagePurpose
    object (BuildingUsage)

    Building usage purpose

    groupname

    Group name of constant

    Valid values[ "BUILDING_USAGE" ]
    id
    integer

    Unique id of constant

    list_url
    string (url)

    Url to fetch all contants from this group

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation

    usagePurposeAlt
    object (AddressSecondaryUsage)

    Address usage purpose

    groupname

    Group name of constant

    Valid values[ "KN_ADDR_SPEC" ]
    id
    integer

    Unique id of constant

    list_url
    string (url)

    Url to fetch all contants from this group

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation

    zipcode
    string

    Building zipcode

    apartmentDivision
    string

    apartment division

    apartmentLetter
    string

    apartment letter

    apartmentNumber
    string

    apartment number

    id
    integer

    Primary key

    originProperty
    string

    apartment original property id

    originalStreetno
    string

    apartment original streen number

    usagePurpose
    object (ApartmentUsage)

    Apartment Usage purpose

    groupname

    Group name of constant

    Valid values[ "APARTMENT_USAGE" ]
    id
    integer

    Unique id of constant

    list_url
    string (url)

    Url to fetch all contants from this group

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation

    usagePurposeAlt
    object (AddressSecondaryUsage)

    Address usage purpose

    groupname

    Group name of constant

    Valid values[ "KN_ADDR_SPEC" ]
    id
    integer

    Unique id of constant

    list_url
    string (url)

    Url to fetch all contants from this group

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation

    usageState
    object (ApartmentStatus)

    Apartment status

    groupname

    Group name of constant

    Valid values[ "APARTMENT_STATUS" ]
    id
    integer

    Unique id of constant

    list_url
    string (url)

    Url to fetch all contants from this group

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation

    basement_area
    integer

    Basement area

    build_date
    string (date)

    Build date

    building_classification
    string

    Building classification

    construction_licence
    integer

    Construction license

    flat_area
    integer

    Flat area

    floor_area
    integer

    Floor area

    floor_number
    integer

    Floor number

    id
    integer

    Primary key

    location
    string (ewkt)

    Geographical location

    owner
    string

    Owner

    real_estate_name
    string

    Real estate name

    real_estate_number
    string

    Real estate number

    total_area
    integer

    Total area

    volume
    integer

    Volume

    401

    Authentication credentials are missing or invalid

    {
  "details": "Authentication credentials were not provided"
}
    object
    details
    string

    Detailed description of error

    404

    Object was not found

    {
  "details": "Not found."
}
    object
    details
    string

    Detailed description of error

    Was this article helpful?
    What's Next
    Products
    Company
    Our Mission
    Connect With Us
    Support
    Copyright © Keypro Oy. All Rights Reserved