Equipment
Estates

Attach equipment to an estate (nested route)

Links an existing catalogue equipment to the estate, with an optional quantity, description and recorded condition.

post/places/{place_id}/estates/{estate_id}/equipment

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/places/{place_id}/estates/{estate_id}/equipment
  • Auth: HTTP bearer

Path parameters

place_idstring uuid required
estate_idstring uuid required

Request body

equipment_idstring uuid required
descriptionstring nullable
quantityinteger nullable
condition_status'EXCELLENT' | 'GOOD' | 'FAIR' | 'POOR' | 'DAMAGED' | 'NEEDS_REPAIR' | 'BROKEN' | 'MISSING'

Condition status for equipment (used in État des Lieux)

condition_notesstring nullable

Response

Equipment attached

equipment_idstring uuid nullable
entity_idstring uuid nullable
entity_type'place' | 'estate' | 'room' nullable
created_atstring date-time nullable
updated_atstring date-time nullable
descriptionstring nullable
quantityinteger nullable
condition_status'EXCELLENT' | 'GOOD' | 'FAIR' | 'POOR' | 'DAMAGED' | 'NEEDS_REPAIR' | 'BROKEN' | 'MISSING'

Condition status for equipment (used in État des Lieux)

condition_notesstring nullable

Free-text notes about the equipment condition

Changes

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