Partenaires toolimo

L'objectif est de permettre à nos partenaires de recuperer la liste des rapports et services immobiliers disponibles au téléchargement.

Point de terminaison

La ressource /report/{reference} sur le verbe GET.

Clef	Type	Requis	description
reference	string	oui	Numéro du dossier

L'authentification se fait par jeton, l'en-tête suivante est requise:

header	valeur
X-AUTH-TOKEN	votre token partenaire

L'API envoie automatiquement le code de statut HTTP approprié au client:

• 400 pour les erreurs attendues
• 500 pour les imprévues.

Il fournit également une description de l'erreur dans le format d'erreur Hydra ou dans le format décrit dans le RFC 7807.

Voici un exemple d'une erreur levée lors d'une demande non authorisée

{
    "@context": "/contexts/Error",
    "@type": "Error",
    "hydra:title": "An error occurred",
    "hydra:description": "Access Denied, you have no permissions to access the resource"
}

Format du retour

En cas de succés l'API retournera un code HTTP 200

{
    "@context": "/contexts/Reports",
    "@type": "Reports",
    "@id": "/report/5355",
    "reports": [
        {
            "type": "diagnostics",
            "label": "Diagnostics",
            "link": "https://toolimo.cloud/dl/reports-....12193277.pdf"
        },
        {
            "type": "updating",
            "label": "Réactualisation",
            "link": "https://toolimo.cloud/dl/reports-...4047391362-pdf"
        },
        {
            "type": "asbestos",
            "label": "Amiante",
            "link": "https://toolimo.cloud/dl/reports-...02584598.pdf"
        },
        {
            "type": "dryRot",
            "label": "Mérule",
            "link": "https://toolimo.cloud/dl/reports-02584598.pdf"
        }
    ],
    "estate_services": [
        {
            "label": "Matterport",
            "link": "https://toolimo.cloud/dl/es/03ae7176-4000-46ca-a517-57510e1c352a"
        },
        {
            "label": "15 photographies",
            "link": "https://toolimo.cloud/dl/es/2d4220de-dd52-4671-8573-969597fd3d77"
        }
    ]
}