Places

Create place

post/places

Request

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

Request body

namestring required
type_idstring uuid required
country_idstring uuid required
owner_idstring uuid required
countrystring required
address_complementstring nullable
street_numberstring nullable
street_namestring required
localitystring nullable
postal_codestring required
citystring required
postal_boxstring nullable
latitudenumber nullable
longitudenumber nullable
descriptionstring nullable
digicodestring nullable
number_of_floorinteger nullable
place_categorystring required
legal_regimestring required
construction_datestring date-time nullable
renovation_datestring date-time nullable

Response

Created

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.