Adlead - Documentation

# Plans 2D des lots

# Lister les plans d'un lot

Permet de récupérer la liste des plans 2D PDF existants pour un lot

# Requête HTTP

GET https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/lots/{lotId}/files

# Paramètres d'URL

Nom de la clé Description
{tenantKey} Clé de l'espace client - Détails
{programId} ID du programme
{lotId} ID du lot

# curl

curl --location --request GET 'https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/lots/{lotId}/files' \
    --header 'Accept: application/json' \
    --header 'X-API-Key: VOTRE_CLE_API'

# Body de réponse

DETAILS 
{
    "success": true,
    "message": null,
    "data": [
        {
            "id": 20,
            "name": "A500.pdf",
            "type": "pdf",
            "category": "plan",
            "file_url": "https://.../A500.pdf",
            "thumbnail_url": null,
            "updated_at": "2023-04-27T16:36:57.000000Z"
        }
    ]
}

# Transférer un plan PDF

Permet d'upload un plan PDF et de l'associer au lot.

# Requête HTTP

POST https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/lots/{lotId}/files

# Paramètres d'URL

Nom de la clé Description
{tenantKey} Clé de l'espace client - Détails
{programId} ID du programme
{lotId} ID du lot

# Body Schema

multipart/form-data

Champ Type Description
file string binary Fichier

# Supprimer un plan PDF

Permet de supprimer un plan PDF.

# Requête HTTP

DELETE https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/lots/{lotId}/files/{lotFileId}

# Paramètres d'URL

Nom de la clé Description
{tenantKey} Clé de l'espace client - Détails
{programId} ID du programme
{lotId} ID du lot
{lotFileId} ID du plan PDF

# curl

curl --location --request DELETE 'https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/lots/{lotId}/files/{lotFileId}' \
    --header 'Accept: application/json' \
    --header 'Content-Type: application/json' \
    --header 'Content-Length: ###' \
    --header 'X-API-Key: VOTRE_CLE_API' \

← Options →