Estate Diagnostics

List diagnostics for an estate

Retrieves all active diagnostics for a specific property (estate)

get/places/{place_id}/estates/{estate_id}/diagnostics

Request

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

Path parameters

place_idstring uuid required

Place ID

estate_idstring uuid required

Estate (property) ID

Response

Active diagnostics for the estate retrieved successfully

idstring uuid required

Unique identifier of the diagnostic

estate_idstring uuid required

Property (estate) ID this diagnostic belongs to

diagnostic_type'DIAGNOSTIC_PLOMB' | 'DIAGNOSTIC_AMIANTE' | 'DIAGNOSTIC_ELECTRICITE' | 'DIAGNOSTIC_GAZ' | 'ETAT_RISQUES' | 'REGLEMENT_COPROPRIETE' | 'PERMIS_LOUER' | 'CUSTOM' required

Type of estate diagnostic

media_idstring uuid required

Media ID of the uploaded diagnostic PDF document

namestring required

Name/title of the diagnostic

descriptionstring nullable

Optional description or notes

performed_atstring date nullable

Date when the diagnostic was performed

expires_atstring date nullable

Expiry date of the diagnostic

is_activeboolean required

Whether this diagnostic is currently active

created_atstring date-time required

Creation date

updated_atstring date-time required

Last modification date

Example response

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "estate_id": "550e8400-e29b-41d4-a716-446655440001",
    "diagnostic_type": "DIAGNOSTIC_PLOMB",
    "media_id": "550e8400-e29b-41d4-a716-446655440010",
    "name": "CREP - Lead Diagnosis",
    "description": "Lead diagnosis for apartment 3B",
    "performed_at": "2024-06-15",
    "expires_at": "2030-06-15",
    "is_active": true,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

Changes

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