FairePlace Property Management API

Estate Diagnostics

Endpointhttps://api.faireplace.com/api

Estate diagnostic documents management (lead, asbestos, electrical, gas, risk assessment, co-ownership rules).

Diagnostics are attached to a property (estate) and can be automatically linked to lease annexes via the POST /leases/{lease_id}/annexes/attach-mandatory endpoint.

Only one active diagnostic per type per estate is allowed. Creating a new diagnostic of the same type automatically deactivates the previous one.

List diagnostics for an estate

GET

https://api.faireplace.com/api

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

Retrieves all active diagnostics for a specific property (estate)

List diagnostics for an estate › path Parameters

place_id

string · uuid · required

Place ID

estate_id

string · uuid · required

Estate (property) ID

List diagnostics for an estate › Responses

Active diagnostics for the estate retrieved successfully

object[]

Estate diagnostic document (lead, asbestos, electrical, gas, risk assessment, co-ownership rules)

id

string · uuid · required

Unique identifier of the diagnostic

Example: 550e8400-e29b-41d4-a716-446655440000

estate_id

string · uuid · required

Property (estate) ID this diagnostic belongs to

Example: 550e8400-e29b-41d4-a716-446655440001

diagnostic_type

string · enum · required

Type of estate diagnostic

Enum values:

DIAGNOSTIC_PLOMB

DIAGNOSTIC_AMIANTE

DIAGNOSTIC_ELECTRICITE

DIAGNOSTIC_GAZ

ETAT_RISQUES

REGLEMENT_COPROPRIETE

CUSTOM

Example: DIAGNOSTIC_PLOMB

media_id

string · uuid · required

Media ID of the uploaded diagnostic PDF document

Example: 550e8400-e29b-41d4-a716-446655440010

name

string · maxLength: 255 · required

Name/title of the diagnostic

Example: CREP - Lead Diagnosis

is_active

boolean · required

Whether this diagnostic is currently active

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null · maxLength: 1000

Optional description or notes

Example: Lead diagnosis for apartment 3B

performed_at

string | null · date

Date when the diagnostic was performed

Example: 2024-06-15

expires_at

string | null · date

Expiry date of the diagnostic

Example: 2030-06-15

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

curl --request GET \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/diagnostics

shell

Example Responses

[
  {
    "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"
  }
]

json

application/json

Create an estate diagnostic

POST

https://api.faireplace.com/api

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

Creates a new diagnostic for a property.

If an active diagnostic of the same type already exists for this estate, the previous one is automatically deactivated.

Create an estate diagnostic › path Parameters

place_id

string · uuid · required

Place ID

estate_id

string · uuid · required

Estate (property) ID

Create an estate diagnostic › Request Body

Data for creating a new estate diagnostic

estate_id

string · uuid · required

Property (estate) ID this diagnostic belongs to

Example: 550e8400-e29b-41d4-a716-446655440001

diagnostic_type

string · enum · required

Type of estate diagnostic

Enum values:

DIAGNOSTIC_PLOMB

DIAGNOSTIC_AMIANTE

DIAGNOSTIC_ELECTRICITE

DIAGNOSTIC_GAZ

ETAT_RISQUES

REGLEMENT_COPROPRIETE

CUSTOM

Example: DIAGNOSTIC_PLOMB

media_id

string · uuid · required

Media ID of the uploaded diagnostic PDF document

Example: 550e8400-e29b-41d4-a716-446655440010

name

string · minLength: 1 · maxLength: 255 · required

Name/title of the diagnostic

Example: CREP - Lead Diagnosis

description

string | null · maxLength: 1000

Optional description or notes

Example: Lead diagnosis for apartment 3B

performed_at

string | null · date

Date when the diagnostic was performed

Example: 2024-06-15

expires_at

string | null · date

Expiry date of the diagnostic

Example: 2030-06-15

Create an estate diagnostic › Responses

Estate diagnostic created successfully

Estate diagnostic document (lead, asbestos, electrical, gas, risk assessment, co-ownership rules)

id

string · uuid · required

Unique identifier of the diagnostic

Example: 550e8400-e29b-41d4-a716-446655440000

estate_id

string · uuid · required

Property (estate) ID this diagnostic belongs to

Example: 550e8400-e29b-41d4-a716-446655440001

diagnostic_type

string · enum · required

Type of estate diagnostic

Enum values:

DIAGNOSTIC_PLOMB

DIAGNOSTIC_AMIANTE

DIAGNOSTIC_ELECTRICITE

DIAGNOSTIC_GAZ

ETAT_RISQUES

REGLEMENT_COPROPRIETE

CUSTOM

Example: DIAGNOSTIC_PLOMB

media_id

string · uuid · required

Media ID of the uploaded diagnostic PDF document

Example: 550e8400-e29b-41d4-a716-446655440010

name

string · maxLength: 255 · required

Name/title of the diagnostic

Example: CREP - Lead Diagnosis

is_active

boolean · required

Whether this diagnostic is currently active

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null · maxLength: 1000

Optional description or notes

Example: Lead diagnosis for apartment 3B

performed_at

string | null · date

Date when the diagnostic was performed

Example: 2024-06-15

expires_at

string | null · date

Expiry date of the diagnostic

Example: 2030-06-15

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

curl --request POST \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/diagnostics \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
}
'

shell

Example Request Body

{
  "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"
}

json

Example Responses

{
  "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"
}

json

application/json

Get estate diagnostic by ID

GET

https://api.faireplace.com/api

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

Retrieves a specific estate diagnostic by its unique identifier

Get estate diagnostic by ID › path Parameters

place_id

string · uuid · required

Place ID

estate_id

string · uuid · required

Estate (property) ID

diagnostic_id

string · uuid · required

Diagnostic ID

Get estate diagnostic by ID › Responses

Estate diagnostic retrieved successfully

Estate diagnostic document (lead, asbestos, electrical, gas, risk assessment, co-ownership rules)

id

string · uuid · required

Unique identifier of the diagnostic

Example: 550e8400-e29b-41d4-a716-446655440000

estate_id

string · uuid · required

Property (estate) ID this diagnostic belongs to

Example: 550e8400-e29b-41d4-a716-446655440001

diagnostic_type

string · enum · required

Type of estate diagnostic

Enum values:

DIAGNOSTIC_PLOMB

DIAGNOSTIC_AMIANTE

DIAGNOSTIC_ELECTRICITE

DIAGNOSTIC_GAZ

ETAT_RISQUES

REGLEMENT_COPROPRIETE

CUSTOM

Example: DIAGNOSTIC_PLOMB

media_id

string · uuid · required

Media ID of the uploaded diagnostic PDF document

Example: 550e8400-e29b-41d4-a716-446655440010

name

string · maxLength: 255 · required

Name/title of the diagnostic

Example: CREP - Lead Diagnosis

is_active

boolean · required

Whether this diagnostic is currently active

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null · maxLength: 1000

Optional description or notes

Example: Lead diagnosis for apartment 3B

performed_at

string | null · date

Date when the diagnostic was performed

Example: 2024-06-15

expires_at

string | null · date

Expiry date of the diagnostic

Example: 2030-06-15

GET/places/{place_id}/estates/{estate_id}/diagnostics/{diagnostic_id}

curl --request GET \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/diagnostics/:diagnostic_id

shell

Example Responses

{
  "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"
}

json

application/json

Update estate diagnostic

PUT

https://api.faireplace.com/api

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

Updates an existing estate diagnostic

Update estate diagnostic › path Parameters

place_id

string · uuid · required

Place ID

estate_id

string · uuid · required

Estate (property) ID

diagnostic_id

string · uuid · required

Diagnostic ID

Update estate diagnostic › Request Body

Data for updating an existing estate diagnostic. All fields are optional. Only provided fields will be updated.

media_id

string | null · uuid

Media ID of the uploaded diagnostic PDF document

Example: 550e8400-e29b-41d4-a716-446655440010

name

string | null · minLength: 1 · maxLength: 255

Name/title of the diagnostic

Example: CREP - Lead Diagnosis (updated)

description

string | null · maxLength: 1000

Optional description or notes

Example: Updated lead diagnosis

performed_at

string | null · date

Date when the diagnostic was performed

Example: 2024-06-15

expires_at

string | null · date

Expiry date of the diagnostic

Example: 2030-06-15

is_active

boolean | null

Whether this diagnostic is currently active

Example: true

Update estate diagnostic › Responses

Estate diagnostic updated successfully

Estate diagnostic document (lead, asbestos, electrical, gas, risk assessment, co-ownership rules)

id

string · uuid · required

Unique identifier of the diagnostic

Example: 550e8400-e29b-41d4-a716-446655440000

estate_id

string · uuid · required

Property (estate) ID this diagnostic belongs to

Example: 550e8400-e29b-41d4-a716-446655440001

diagnostic_type

string · enum · required

Type of estate diagnostic

Enum values:

DIAGNOSTIC_PLOMB

DIAGNOSTIC_AMIANTE

DIAGNOSTIC_ELECTRICITE

DIAGNOSTIC_GAZ

ETAT_RISQUES

REGLEMENT_COPROPRIETE

CUSTOM

Example: DIAGNOSTIC_PLOMB

media_id

string · uuid · required

Media ID of the uploaded diagnostic PDF document

Example: 550e8400-e29b-41d4-a716-446655440010

name

string · maxLength: 255 · required

Name/title of the diagnostic

Example: CREP - Lead Diagnosis

is_active

boolean · required

Whether this diagnostic is currently active

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null · maxLength: 1000

Optional description or notes

Example: Lead diagnosis for apartment 3B

performed_at

string | null · date

Date when the diagnostic was performed

Example: 2024-06-15

expires_at

string | null · date

Expiry date of the diagnostic

Example: 2030-06-15

PUT/places/{place_id}/estates/{estate_id}/diagnostics/{diagnostic_id}

curl --request PUT \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/diagnostics/:diagnostic_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "media_id": "550e8400-e29b-41d4-a716-446655440010",
  "name": "CREP - Lead Diagnosis (updated)",
  "description": "Updated lead diagnosis",
  "performed_at": "2024-06-15",
  "expires_at": "2030-06-15",
  "is_active": true
}
'

shell

Example Request Body

{
  "media_id": "550e8400-e29b-41d4-a716-446655440010",
  "name": "CREP - Lead Diagnosis (updated)",
  "description": "Updated lead diagnosis",
  "performed_at": "2024-06-15",
  "expires_at": "2030-06-15",
  "is_active": true
}

json

Example Responses

{
  "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"
}

json

application/json

Delete estate diagnostic

DELETE

https://api.faireplace.com/api

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

Soft-deletes an estate diagnostic by deactivating it (sets is_active to false)

Delete estate diagnostic › path Parameters

place_id

string · uuid · required

Place ID

estate_id

string · uuid · required

Estate (property) ID

diagnostic_id

string · uuid · required

Diagnostic ID

Delete estate diagnostic › Responses

Estate diagnostic deleted (deactivated) successfully

No data returned

DELETE/places/{place_id}/estates/{estate_id}/diagnostics/{diagnostic_id}

curl --request DELETE \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/diagnostics/:diagnostic_id

shell

Example Responses

No example specified for this content type

Energy Diagnosis Services

FairePlace Property Management API

Estate Diagnostics

Endpointhttps://api.faireplace.com/api

Estate diagnostic documents management (lead, asbestos, electrical, gas, risk assessment, co-ownership rules).

Diagnostics are attached to a property (estate) and can be automatically linked to lease annexes via the POST /leases/{lease_id}/annexes/attach-mandatory endpoint.

Only one active diagnostic per type per estate is allowed. Creating a new diagnostic of the same type automatically deactivates the previous one.

List diagnostics for an estate

GET

https://api.faireplace.com/api

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

Retrieves all active diagnostics for a specific property (estate)

List diagnostics for an estate › path Parameters

place_id

string · uuid · required

Place ID

estate_id

string · uuid · required

Estate (property) ID

List diagnostics for an estate › Responses

Active diagnostics for the estate retrieved successfully

object[]

Estate diagnostic document (lead, asbestos, electrical, gas, risk assessment, co-ownership rules)

id

string · uuid · required

Unique identifier of the diagnostic

Example: 550e8400-e29b-41d4-a716-446655440000

estate_id

string · uuid · required

Property (estate) ID this diagnostic belongs to

Example: 550e8400-e29b-41d4-a716-446655440001

diagnostic_type

string · enum · required

Type of estate diagnostic

Enum values:

DIAGNOSTIC_PLOMB

DIAGNOSTIC_AMIANTE

DIAGNOSTIC_ELECTRICITE

DIAGNOSTIC_GAZ

ETAT_RISQUES

REGLEMENT_COPROPRIETE

CUSTOM

Example: DIAGNOSTIC_PLOMB

media_id

string · uuid · required

Media ID of the uploaded diagnostic PDF document

Example: 550e8400-e29b-41d4-a716-446655440010

name

string · maxLength: 255 · required

Name/title of the diagnostic

Example: CREP - Lead Diagnosis

is_active

boolean · required

Whether this diagnostic is currently active

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null · maxLength: 1000

Optional description or notes

Example: Lead diagnosis for apartment 3B

performed_at

string | null · date

Date when the diagnostic was performed

Example: 2024-06-15

expires_at

string | null · date

Expiry date of the diagnostic

Example: 2030-06-15

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

curl --request GET \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/diagnostics

shell

Example Responses

[
  {
    "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"
  }
]

json

application/json

Create an estate diagnostic

POST

https://api.faireplace.com/api

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

Creates a new diagnostic for a property.

If an active diagnostic of the same type already exists for this estate, the previous one is automatically deactivated.

Create an estate diagnostic › path Parameters

place_id

string · uuid · required

Place ID

estate_id

string · uuid · required

Estate (property) ID

Create an estate diagnostic › Request Body

Data for creating a new estate diagnostic

estate_id

string · uuid · required

Property (estate) ID this diagnostic belongs to

Example: 550e8400-e29b-41d4-a716-446655440001

diagnostic_type

string · enum · required

Type of estate diagnostic

Enum values:

DIAGNOSTIC_PLOMB

DIAGNOSTIC_AMIANTE

DIAGNOSTIC_ELECTRICITE

DIAGNOSTIC_GAZ

ETAT_RISQUES

REGLEMENT_COPROPRIETE

CUSTOM

Example: DIAGNOSTIC_PLOMB

media_id

string · uuid · required

Media ID of the uploaded diagnostic PDF document

Example: 550e8400-e29b-41d4-a716-446655440010

name

string · minLength: 1 · maxLength: 255 · required

Name/title of the diagnostic

Example: CREP - Lead Diagnosis

description

string | null · maxLength: 1000

Optional description or notes

Example: Lead diagnosis for apartment 3B

performed_at

string | null · date

Date when the diagnostic was performed

Example: 2024-06-15

expires_at

string | null · date

Expiry date of the diagnostic

Example: 2030-06-15

Create an estate diagnostic › Responses

Estate diagnostic created successfully

Estate diagnostic document (lead, asbestos, electrical, gas, risk assessment, co-ownership rules)

id

string · uuid · required

Unique identifier of the diagnostic

Example: 550e8400-e29b-41d4-a716-446655440000

estate_id

string · uuid · required

Property (estate) ID this diagnostic belongs to

Example: 550e8400-e29b-41d4-a716-446655440001

diagnostic_type

string · enum · required

Type of estate diagnostic

Enum values:

DIAGNOSTIC_PLOMB

DIAGNOSTIC_AMIANTE

DIAGNOSTIC_ELECTRICITE

DIAGNOSTIC_GAZ

ETAT_RISQUES

REGLEMENT_COPROPRIETE

CUSTOM

Example: DIAGNOSTIC_PLOMB

media_id

string · uuid · required

Media ID of the uploaded diagnostic PDF document

Example: 550e8400-e29b-41d4-a716-446655440010

name

string · maxLength: 255 · required

Name/title of the diagnostic

Example: CREP - Lead Diagnosis

is_active

boolean · required

Whether this diagnostic is currently active

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null · maxLength: 1000

Optional description or notes

Example: Lead diagnosis for apartment 3B

performed_at

string | null · date

Date when the diagnostic was performed

Example: 2024-06-15

expires_at

string | null · date

Expiry date of the diagnostic

Example: 2030-06-15

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

curl --request POST \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/diagnostics \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
}
'

shell

Example Request Body

{
  "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"
}

json

Example Responses

{
  "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"
}

json

application/json

Get estate diagnostic by ID

GET

https://api.faireplace.com/api

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

Retrieves a specific estate diagnostic by its unique identifier

Get estate diagnostic by ID › path Parameters

place_id

string · uuid · required

Place ID

estate_id

string · uuid · required

Estate (property) ID

diagnostic_id

string · uuid · required

Diagnostic ID

Get estate diagnostic by ID › Responses

Estate diagnostic retrieved successfully

Estate diagnostic document (lead, asbestos, electrical, gas, risk assessment, co-ownership rules)

id

string · uuid · required

Unique identifier of the diagnostic

Example: 550e8400-e29b-41d4-a716-446655440000

estate_id

string · uuid · required

Property (estate) ID this diagnostic belongs to

Example: 550e8400-e29b-41d4-a716-446655440001

diagnostic_type

string · enum · required

Type of estate diagnostic

Enum values:

DIAGNOSTIC_PLOMB

DIAGNOSTIC_AMIANTE

DIAGNOSTIC_ELECTRICITE

DIAGNOSTIC_GAZ

ETAT_RISQUES

REGLEMENT_COPROPRIETE

CUSTOM

Example: DIAGNOSTIC_PLOMB

media_id

string · uuid · required

Media ID of the uploaded diagnostic PDF document

Example: 550e8400-e29b-41d4-a716-446655440010

name

string · maxLength: 255 · required

Name/title of the diagnostic

Example: CREP - Lead Diagnosis

is_active

boolean · required

Whether this diagnostic is currently active

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null · maxLength: 1000

Optional description or notes

Example: Lead diagnosis for apartment 3B

performed_at

string | null · date

Date when the diagnostic was performed

Example: 2024-06-15

expires_at

string | null · date

Expiry date of the diagnostic

Example: 2030-06-15

GET/places/{place_id}/estates/{estate_id}/diagnostics/{diagnostic_id}

curl --request GET \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/diagnostics/:diagnostic_id

shell

Example Responses

{
  "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"
}

json

application/json

Update estate diagnostic

PUT

https://api.faireplace.com/api

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

Updates an existing estate diagnostic

Update estate diagnostic › path Parameters

place_id

string · uuid · required

Place ID

estate_id

string · uuid · required

Estate (property) ID

diagnostic_id

string · uuid · required

Diagnostic ID

Update estate diagnostic › Request Body

Data for updating an existing estate diagnostic. All fields are optional. Only provided fields will be updated.

media_id

string | null · uuid

Media ID of the uploaded diagnostic PDF document

Example: 550e8400-e29b-41d4-a716-446655440010

name

string | null · minLength: 1 · maxLength: 255

Name/title of the diagnostic

Example: CREP - Lead Diagnosis (updated)

description

string | null · maxLength: 1000

Optional description or notes

Example: Updated lead diagnosis

performed_at

string | null · date

Date when the diagnostic was performed

Example: 2024-06-15

expires_at

string | null · date

Expiry date of the diagnostic

Example: 2030-06-15

is_active

boolean | null

Whether this diagnostic is currently active

Example: true

Update estate diagnostic › Responses

Estate diagnostic updated successfully

Estate diagnostic document (lead, asbestos, electrical, gas, risk assessment, co-ownership rules)

id

string · uuid · required

Unique identifier of the diagnostic

Example: 550e8400-e29b-41d4-a716-446655440000

estate_id

string · uuid · required

Property (estate) ID this diagnostic belongs to

Example: 550e8400-e29b-41d4-a716-446655440001

diagnostic_type

string · enum · required

Type of estate diagnostic

Enum values:

DIAGNOSTIC_PLOMB

DIAGNOSTIC_AMIANTE

DIAGNOSTIC_ELECTRICITE

DIAGNOSTIC_GAZ

ETAT_RISQUES

REGLEMENT_COPROPRIETE

CUSTOM

Example: DIAGNOSTIC_PLOMB

media_id

string · uuid · required

Media ID of the uploaded diagnostic PDF document

Example: 550e8400-e29b-41d4-a716-446655440010

name

string · maxLength: 255 · required

Name/title of the diagnostic

Example: CREP - Lead Diagnosis

is_active

boolean · required

Whether this diagnostic is currently active

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null · maxLength: 1000

Optional description or notes

Example: Lead diagnosis for apartment 3B

performed_at

string | null · date

Date when the diagnostic was performed

Example: 2024-06-15

expires_at

string | null · date

Expiry date of the diagnostic

Example: 2030-06-15

PUT/places/{place_id}/estates/{estate_id}/diagnostics/{diagnostic_id}

curl --request PUT \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/diagnostics/:diagnostic_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "media_id": "550e8400-e29b-41d4-a716-446655440010",
  "name": "CREP - Lead Diagnosis (updated)",
  "description": "Updated lead diagnosis",
  "performed_at": "2024-06-15",
  "expires_at": "2030-06-15",
  "is_active": true
}
'

shell

Example Request Body

{
  "media_id": "550e8400-e29b-41d4-a716-446655440010",
  "name": "CREP - Lead Diagnosis (updated)",
  "description": "Updated lead diagnosis",
  "performed_at": "2024-06-15",
  "expires_at": "2030-06-15",
  "is_active": true
}

json

Example Responses

{
  "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"
}

json

application/json

Delete estate diagnostic

DELETE

https://api.faireplace.com/api

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

Soft-deletes an estate diagnostic by deactivating it (sets is_active to false)

Delete estate diagnostic › path Parameters

place_id

string · uuid · required

Place ID

estate_id

string · uuid · required

Estate (property) ID

diagnostic_id

string · uuid · required

Diagnostic ID

Delete estate diagnostic › Responses

Estate diagnostic deleted (deactivated) successfully

No data returned

DELETE/places/{place_id}/estates/{estate_id}/diagnostics/{diagnostic_id}

curl --request DELETE \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/diagnostics/:diagnostic_id

shell

Example Responses

No example specified for this content type

Energy Diagnosis Services