Places

Update place

put/places/{id}

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/places/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Request body

namestring nullable
countrystring nullable
address_complementstring nullable

Address complement.

Update behavior:

  • Field absent: the existing value is preserved
  • null: the value is removed (set to NULL in the database)
  • String: the value is updated
street_numberstring nullable

Street number.

Update behavior:

  • Field absent: the existing value is preserved
  • null: the value is removed (set to NULL in the database)
  • String: the value is updated
street_namestring nullable
localitystring nullable

Locality.

Update behavior:

  • Field absent: the existing value is preserved
  • null: the value is removed (set to NULL in the database)
  • String: the value is updated
postal_codestring nullable
citystring nullable
postal_boxstring nullable

Postal box.

Update behavior:

  • Field absent: the existing value is preserved
  • null: the value is removed (set to NULL in the database)
  • String: the value is updated
latitudenumber nullable

GPS latitude.

Update behavior:

  • Field absent: the existing value is preserved
  • null: the value is removed (set to NULL in the database)
  • Number: the value is updated
longitudenumber nullable

GPS longitude.

Update behavior:

  • Field absent: the existing value is preserved
  • null: the value is removed (set to NULL in the database)
  • Number: the value is updated
descriptionstring nullable
type_idstring uuid nullable
country_idstring uuid nullable
digicodestring nullable
number_of_floorinteger nullable
place_category'Individual' | 'Collective'

Place category (individual or collective)

legal_regime'MonoPropriete' | 'Copropriete'

Legal regime of the place

renovation_datestring date-time nullable

Example request

{
  "place_category": "Collective",
  "legal_regime": "Copropriete"
}

Response

OK

idstring uuid nullable
namestring nullable
countrystring nullable
address_complementstring nullable
street_numberstring nullable
street_namestring nullable
localitystring nullable
postal_codestring nullable
citystring nullable
postal_boxstring nullable
latitudenumber nullable
longitudenumber nullable
descriptionstring nullable
type_idstring uuid nullable
country_idstring uuid nullable
digicodestring nullable
number_of_floorinteger nullable
owner_idstring uuid nullable
previous_owner_idstring uuid nullable
construction_datestring date-time nullable
renovation_datestring date-time nullable
place_category'Individual' | 'Collective'

Place category (individual or collective)

legal_regime'MonoPropriete' | 'Copropriete'

Legal regime of the place

created_atstring date-time nullable
updated_atstring date-time nullable

Example response

{
  "place_category": "Collective",
  "legal_regime": "Copropriete"
}

Changes

No recorded changes to this operation across all 1 revision of this API.