API ChouetteCopro

URL de base

https://app.chouettecopro.com/api/v1

L'API ChouetteCopro est une API REST basée sur le standard JSON:API. Cela permet de bénéficier d'une documentation exhaustive, d'un écosystème de clients compatibles et de répondre aux problématiques usuelles comme la pagination, le tri, le cache ou les réponses partielles.

Elle utilise des fonctionnalités HTTP classiques comme les codes d'erreurs HTTP, l'authentification avec Basic Auth et les verbes HTTP.

Les données renvoyées sont au format JSON.

Authentification

Exemple de requête

curl "https://app.chouettecopro.com/api/v1/condominia"
  -u 5687c0fd-42f4-4dbe-8ad3-608b6b93f7ac:

curl utilise l'option -u pour indiquer l'identifiant Basic Auth. L'ajout de : empêche curl de demander un mot de passe

La clé API indiquée est une clé factice. Pour tester avec votre compte, utilisez votre propre clé API.

L'authentification se fait en indiquant la clé API du compte utilisateur dans les requêtes API. Les droits d'accès correspondent à ceux de l'utilisateur sur l'application ChouetteCopro. Cette clé est secrète, veillez à ne pas la rendre accessible publiquement (code source versionné, code client d'un site web public...).

L'authentification se fait via la méthode HTTP Basic Auth. Il faut indiquer la clé API dans le champ username. Le mot de passe n'est pas nécessaire.

JSON:API

Données liées

Exemple de requête

curl "https://app.chouettecopro.com/api/v1/tickets/1234?include=comments,pictures,author"
  -u <api_key>

JSON:API permet de récupérer des informations liées à la ressource en cours dans la même requête. Il est par exemple possible pour un ticket donné de récupérer également ses commentaires, ses ordres de service et son auteur.

Le paramètre include permet d'indiquer les données souhaitées dans une chaîne séparée par des virgules.

La section Données liées de chaque ressource recense les données qu'il est possible de récupérer.

Pour plus d'informations, consulter la documentation de include de JSON:API.

Relations

Exemple de relations

{
    "data": {
        "id": "1234",
        "type": "tickets",
        "links": {
            "self": "https://app.chouettecopro.com/api/v1/tickets/1234"
        },
        "attributes": {
            "body": "La gâche électrique de la porte du bâtiment 1 ne fonctionne plus",
            "entrance": "Bat 1 RDC dans le hall",
            "closed": false,
            "created_at": "2018-10-10T14:39:31.946+02:00",
            "updated_at": "2018-10-16T12:45:41.336+02:00"
        },
        "relationships": {
            "condominium": {
                "links": {
                    "self": "https://app.chouettecopro.com/api/v1/tickets/1234/relationships/condominium",
                    "related": "https://app.chouettecopro.com/api/v1/tickets/1234/condominium"
                }
            },
            "category": {
                "links": {
                    "self": "https://app.chouettecopro.com/api/v1/tickets/1234/relationships/category",
                    "related": "https://app.chouettecopro.com/api/v1/tickets/1234/category"
                }
            },
            "author": {
                "links": {
                    "self": "https://app.chouettecopro.com/api/v1/tickets/1234/relationships/author",
                    "related": "https://app.chouettecopro.com/api/v1/tickets/1234/author"
                },
                "data": {
                    "type": "users",
                    "id": "123"
                }
            },
            "comments": {
                "links": {
                    "self": "https://app.chouettecopro.com/api/v1/tickets/1234/relationships/comments",
                    "related": "https://app.chouettecopro.com/api/v1/tickets/1234/comments"
                },
                "data": [
                    {
                        "type": "comments",
                        "id": "12341"
                    },
                    {
                        "type": "comments",
                        "id": "12342"
                    },
                    {
                        "type": "comments",
                        "id": "12343"
                    }
                ]
            },
            {...}
        }
    },
    "included": [...]
}

JSON:API permet d'indiquer quelles sont les ressources liées à une ressource. Chaque ressource liée est listée dans un objet relationships. Cet objet peut contenir les objets suivants : links, data, meta.

• links contient les liens vers la relation elle-même (clé self) et vers les données de la ressource (clé related)
• data contient les [données d'identification des ressources liées]((https://jsonapi.org/format/#document-resource-identifier-objects) si elles sont demandées grâce au paramètre include (les données des ressources seront dans ce cas dans l'objet included présent dans data au même niveau que relationships) :
  • null dans le cas d'une liaison to-one vide
  • un tableau vide [] dans le cas d'une liaison to-many vide
  • un objet d'identification de ressource dans le cas d'une liaison to-one
  • un tableau d'objets d'identification de ressource dans le cas d'une liaison to-many

Pour plus d'informations, consulter la documentation Relationships de JSON:API

Copropriétés

Les copropriétés regroupent des habitants, des membres du conseil syndical et sont administrées par des gestionnaires membres du syndic. Une copropriété comporte des signalements déclarés par les utilisateurs, ainsi que des catégories pour organiser ces signalements.

L'objet copropriété

Attributs

Nom	Description
short_title	Le nom et l'adresse

Données liées

• categories : les catégories de signalement de la copropriété
• tickets : les signalements de la copropriété
• service_orders : les ordres de service de la copropriété
• pictures : les images de la copropriété
• picture : l'image principale de la copropriété

Liste des copropriétés

GET /api/v1/condominia

Exemple de requête

curl "https://app.chouettecopro.com/api/v1/condominia"
  -u {api_key}

Exemple de réponse

{
    "data": [
        {
            "id": "123",
            "type": "condominia",
            "links": {
                "self": "https://app.chouettecopro.com/api/v1/condominia/123"
            },
            "attributes": {
                "short_title": "Résidence Jean Moulin (75001 Paris)"
            },
            "relationships": {...}
        },
        {...}
    ]
}

Renvoie la liste des copropriétés auxquelles l'utilisateur a accès.

Arguments en query string

Nom	Description
include	La liste des données liées à récupérer

Retour

Un objet avec une propriété data contenant un tableau de copropriétés.

Détail d'une copropriété

GET /api/v1/condominia/{id}

Exemple de requête

curl "https://app.chouettecopro.com/api/v1/condominia/123"
  -u {api_key}

Exemple de réponse

{
    "data": {
        "id": "123",
        "type": "condominia",
        "links": {
            "self": "https://app.chouettecopro.com/api/v1/condominia/123"
        },
        "attributes": {
            "short_title": "Résidence Jean Moulin (75001 Paris)"
        },
        "relationships": {...}
    }
}

Renvoie les informations de la copropriété.

Arguments de l'URL

Nom	Description
id	L'identifiant de la copropriété

Arguments en query string

Nom	Description
include	La liste des données liées à récupérer

Retour

Un objet avec une propriété data contenant l'objet copropriété.

Signalements

Les signalements sont déclarés par les utilisateurs pour informer d'un dysfonctionnement, suggérer une amélioration ou proposer un service. Un signalement concerne une catégorie (parties communes, espaces verts, messages entre voisins...). Il comporte un message et éventuellement des photos. Il peut également concerner une entrée spécifique et avoir des dates d'intervention prévues.

L'objet signalement

Attributs

Nom	Description
body	Le message du signalement
author_signature	Le nom de l'auteur, avec son numéro d'appartement si c'est un habitant ou son entreprise si c'est un technicien
entrance	Le nom ou numéro de l'entrée d'immeuble
closed	true si le signalement est fermé, false s'il est ouvert
planned_intervention_dates	La liste des dates d'intervention prévues
created_at	La date de création du signalement
updated_at	La date de dernière mise à jour du signalement

Données liées

• condominium : la copropriété dans laquelle a été déclaré le signalement
• category : la catégorie du signalement
• comments : les commentaires sur le signalement
• service_orders : les ordres de service affectés au signalement
• pictures : les images du signalement
• picture : l'image principale du signalement

Liste des signalements

GET /api/v1/condominia/{condominium_id}/tickets

Exemple de requête

curl "https://app.chouettecopro.com/api/v1/condominia/123/tickets"
  -u {api_key}

Exemple de réponse

{
    "data": [
        {
            "id": "1234",
            "type": "tickets",
            "links": {
                "self": "https://app.chouettecopro.com/api/v1/tickets/1234"
            },
            "attributes": {
                "body": "La gâche électrique de la porte du bâtiment 1 ne fonctionne plus",
                "author_signature": "Jean Dupont, appt no A1",
                "entrance": "Bat 1 RDC dans le hall",
                "closed": false,
                "planned_intervention_dates": [
                    "2018-10-18"
                ],
                "created_at": "2018-10-10T14:39:31.946+02:00",
                "updated_at": "2018-10-16T12:45:41.336+02:00"
            },
            "relationships": {
                "condominium": {
                    "links": {
                        "self": "https://app.chouettecopro.com/api/v1/tickets/1234/relationships/condominium",
                        "related": "https://app.chouettecopro.com/api/v1/tickets/1234/condominium"
                    }
                },
                "category": {
                    "links": {
                        "self": "https://app.chouettecopro.com/api/v1/tickets/1234/relationships/category",
                        "related": "https://app.chouettecopro.com/api/v1/tickets/1234/category"
                    }
                },
                "author": {
                    "links": {
                        "self": "https://app.chouettecopro.com/api/v1/tickets/1234/relationships/author",
                        "related": "https://app.chouettecopro.com/api/v1/tickets/1234/author"
                    }
                },
                "comments": {
                    "links": {
                        "self": "https://app.chouettecopro.com/api/v1/tickets/1234/relationships/comments",
                        "related": "https://app.chouettecopro.com/api/v1/tickets/1234/comments"
                    }
                },
                "service_orders": {
                    "links": {
                        "self": "https://app.chouettecopro.com/api/v1/tickets/1234/relationships/service-orders",
                        "related": "https://app.chouettecopro.com/api/v1/tickets/1234/service-orders"
                    }
                },
                "planned_intervention_dates": {
                    "links": {
                        "self": "https://app.chouettecopro.com/api/v1/tickets/1234/relationships/planned-intervention-dates",
                        "related": "https://app.chouettecopro.com/api/v1/tickets/1234/planned-intervention-dates"
                    }
                },
                "pictures": {
                    "links": {
                        "self": "https://app.chouettecopro.com/api/v1/tickets/1234/relationships/pictures",
                        "related": "https://app.chouettecopro.com/api/v1/tickets/1234/pictures"
                    }
                },
                "picture": {
                    "links": {
                        "self": "https://app.chouettecopro.com/api/v1/tickets/1234/relationships/picture",
                        "related": "https://app.chouettecopro.com/api/v1/tickets/1234/picture"
                    }
                }
            }
        },
        {...}
    ]
}

Renvoie la liste des signalements de la copropriété donnée.

Arguments de l'URL

Nom	Description
condominium_id	L'identifiant de la copropriété

Arguments en query string

Nom	Description
include	La liste des données liées à récupérer
filter	Un tableau de champs sur lesquels filtrer la liste. Valeurs possibles : closed.
> filter[closed]	true (ou 1) pour ne récupérer que les signalement fermés. Valeur par défaut : false (ou 0).

Retour

Un objet avec une propriété data contenant un tableau de signalements.

Détail d'un signalement

GET /api/v1/tickets/{id}

Exemple de requête

curl "https://app.chouettecopro.com/api/v1/tickets/1234"
  -u {api_key}

Exemple de réponse

{
    "data": {
        "id": "1234",
        "type": "tickets",
        "links": {
            "self": "https://app.chouettecopro.com/api/v1/tickets/1234"
        },
        "attributes": {
            "body": "La gâche électrique de la porte du bâtiment 1 ne fonctionne plus",
            "author_signature": "Jean Dupont, appt no A1",
            "entrance": "Bat 1 RDC dans le hall",
            "closed": false,
            "planned_intervention_dates": [
                "2018-10-18"
            ],
            "created_at": "2018-10-10T14:39:31.946+02:00",
            "updated_at": "2018-10-16T12:45:41.336+02:00"
        },
        "relationships": {...}
    }
}

Renvoie les informations du signalement.

Arguments de l'URL

Nom	Description
id	L'identifiant du signalement

Arguments en query string

Nom	Description
include	La liste des données liées à récupérer

Retour

Un objet avec une propriété data contenant l'objet signalement.

Catégories de signalement

Les catégories de signalement regroupent les signalements selon leur domaine ou emplacement : parties communes, espaces verts, messages entre voisins...

L'objet catégorie de signalement

Attributs

Nom	Description
name	Le nom de la catégorie

Données liées

• tickets : les signalements de la catégorie

Liste des catégories de signalement

GET /api/v1/condominia/{condominium_id}/categories

Exemple de requête

curl "https://app.chouettecopro.com/api/v1/condominia/123/categories"
  -u {api_key}

Exemple de réponse

{
    "data": [
        {
            "id": "1234",
            "type": "categories",
            "links": {
                "self": "https://app.chouettecopro.com/api/v1/categories/1234"
            },
            "attributes": {
                "name": "Accès (portes, portail, interphone, digicode)"
            },
            "relationships": {...}
        },
        {
            "id": "5678",
            "type": "categories",
            "links": {
                "self": "https://app.chouettecopro.com/api/v1/categories/5678"
            },
            "attributes": {
                "name": "Ascenseur"
            },
            "relationships": {...}
        },
        {...}
    ]
}

Arguments de l'URL

Nom	Description
condominium_id	L'identifiant de la copropriété

Arguments en query string

Nom	Description
include	La liste des données liées à récupérer

Retour

Un objet avec une propriété data contenant un tableau de catégories de signalement.

Détail d'une catégorie de signalement

GET /api/v1/categories/{id}

Exemple de requête

curl "https://app.chouettecopro.com/api/v1/categories/1234"
  -u {api_key}

Exemple de réponse

{
    "data": {
        "id": "1234",
        "type": "categories",
        "links": {
            "self": "https://app.chouettecopro.com/api/v1/categories/1234"
        },
        "attributes": {
            "name": "Accès (portes, portail, interphone, digicode)"
        },
        "relationships": {...}
    }
}

Renvoie les informations de la catégorie de signalement.

Arguments de l'URL

Nom	Description
id	L'identifiant de la catégorie de signalement

Arguments en query string

Nom	Description
include	La liste des données liées à récupérer

Retour

Un objet avec une propriété data contenant l'objet catégorie de signalement.

Commentaires

Les commentaires sont postés par les utilisateurs sur les signalements. Le syndic peut ainsi informer les habitants de la résolution d'un incident et les habitants peuvent y apporter des précisions.

L'objet commentaire

Attributs

Nom	Description
body	Le message du commentaire
author_signature	Le nom de l'auteur, avec son numéro d'appartement si c'est un habitant ou son entreprise si c'est un technicien
created_at	La date de création du commentaire
updated_at	La date de dernière mise à jour du commentaire

Données liées

• pictures : les images du commentaire
• picture : l'image principale du commentaire

Ordres de service

Les ordres de service sont envoyés par les gestionnaires du syndic aux prestataires pour demander une intervention dans la copropriété.

L'objet ordre de service

Attributs

Nom	Description
body	Le message de l'ordre de service
reference	La référence de l'ordre de service
requested_timeframe_label	Le délai d'intervention souhaité
contractor_name	Le nom du prestataire à qui est affecté l'ordre de service
creator_name	Le nom du gestionnaire ayant demandé l'ordre de service
created_at	La date de création du signalement
updated_at	La date de dernière mise à jour du signalement

Données liées

• attachments : les documents de l'ordre de service
• attachment : le document principal de l'ordre de service

Liste des ordres de service

GET /api/v1/condominia/{condominium_id}/service-orders

Exemple de requête

curl "https://app.chouettecopro.com/api/v1/condominia/123/service-orders"
  -u {api_key}

Exemple de réponse

{
    "data": [
        {
            "id": "1234",
            "type": "service_orders",
            "links": {
                "self": "https://app.chouettecopro.com/api/v1/service-orders/123"
            },
            "attributes": {
                "body": "LE PRESENT ORDRE DE SERVICE EST DONNEE AVEC OBLIGATION POUR L’ENTREPRISE OU LE PRESTATAIRE DE RESPECTER LES DISPOSITIONS DE LA LOI DU 31/12/1993 N° 93 1418 (et décrets suivants), et d’informer le maître d’ouvrage de l’éventuelle nécessité de missionner un COORDINATEUR DE SECURITE.\r\n\r\nDESIGNATION DES TRAVAUX : SELON LE DEVIS N°1234 DE 100,00 € TTC",
                "reference": "1234/1/2/A",
                "requested_timeframe_label": "Dans les 24 heures",
                "contractor_name": "SARL PLOMBIER",
                "creator_name": "Jean Durand de l'agence Mon Agence",
                "created_at": "2018-10-17T16:07:12.930+02:00",
                "updated_at": "2018-10-17T16:07:12.930+02:00"
            },
            "relationships": {...}
        }
    ]
}

Arguments de l'URL

Nom	Description
condominium_id	L'identifiant de la copropriété

Arguments en query string

Nom	Description
include	La liste des données liées à récupérer

Retour

Un objet avec une propriété data contenant un tableau d'ordres de service.

Détail d'un ordre de service

GET /api/v1/service-orders/{id}

Exemple de requête

curl "https://app.chouettecopro.com/api/v1/service-orders/1234"
  -u {api_key}

Exemple de réponse

{
    "data": {
        "id": "1234",
        "type": "service_orders",
        "links": {
            "self": "https://app.chouettecopro.com/api/v1/service-orders/1234"
        },
        "attributes": {
            "body": "LE PRESENT ORDRE DE SERVICE EST DONNEE AVEC OBLIGATION POUR L’ENTREPRISE OU LE PRESTATAIRE DE RESPECTER LES DISPOSITIONS DE LA LOI DU 31/12/1993 N° 93 1418 (et décrets suivants), et d’informer le maître d’ouvrage de l’éventuelle nécessité de missionner un COORDINATEUR DE SECURITE.\r\n\r\nDESIGNATION DES TRAVAUX : SELON LE DEVIS N°1234 DE 100,00 € TTC",
            "reference": "1234/1/2/A",
            "requested_timeframe_label": "Dans les 24 heures",
            "contractor_name": "SARL PLOMBIER",
            "creator_name": "Jean Durand de l'agence Mon Agence",
            "created_at": "2018-10-17T16:07:12.930+02:00",
            "updated_at": "2018-10-17T16:07:12.930+02:00"
        },
        "relationships": {...}
    }
}

Renvoie les informations de l'ordre de service

Arguments de l'URL

Nom	Description
id	L'identifiant de l'ordre de service

Arguments en query string

Nom	Description
include	La liste des données liées à récupérer

Retour

Un objet avec une propriété data contenant l'objet ordre de service.

Infos immeuble

Les infos immeubles permettent de communiquer des informations à l'ensemble des habitants d'une copropriété. Elles peuvent être épinglées en tête de liste et avoir des documents ou images associés.

L'objet info immeuble

Attributs

Nom	Description
title	Le titre de l'info immeuble
body	Le message de l'info immeuble
author_signature	Le nom de l'auteur, avec son numéro d'appartement si c'est un habitant
entrance	Le nom ou numéro de l'entrée d'immeuble
pinned	true si l'info immeuble est épinglée, false sinon
created_at	La date de création de l'info immeuble

Données liées

• condominium : la copropriété dans laquelle a été publiée l'info immeuble
• attachments : les documents de l'info immeuble
• attachment : le document principal de l'info immeuble
• pictures : les images de l'info immeuble
• picture : l'image principale de l'info immeuble

Liste des infos immeubles

GET /api/v1/condominia/{condominium_id}/notes

Exemple de requête

curl "https://app.chouettecopro.com/api/v1/condominia/123/notes"
  -u {api_key}

Exemple de réponse

{
    "data": [
        {
            "id": "123",
            "type": "notes",
            "links": {
                "self": "https://app.chouettecopro.com/api/v1/notes/123"
            },
            "attributes": {
                "title": "Numéros utiles",
                "body": "<p>Veuillez trouver ci-dessous la liste des num&eacute;ros utiles pour notre r&eacute;sidence :<br />\r\n- Contrats d&rsquo;entretien :</p>\r\n\r\n<p><em><strong>- Jean Dupont (entretien r&eacute;sidence)&nbsp;&nbsp; 01 02 03 04 05</strong></em><br />\r\n<strong>o (D&eacute;pannage ascenseur 24H/24) Soci&eacute;t&eacute; ASCENSEUR : 09 02 03 04 05</strong></p>\r\n",
                "author_signature": "Édouard Durand, appt no C1",
                "entrance": "Domaine Marie",
                "pinned": true,
                "created_at": "2018-10-10T14:53:17.763+02:00"
            },
            "relationships": {...}
        },
        {
            "id": "456",
            "type": "notes",
            "links": {
                "self": "https://app.chouettecopro.com/api/v1/notes/456"
            },
            "attributes": {
                "title": "INFOS suite à problème installation compteur électrique",
                "body": "<p>Bonjour</p>\r\n\r\n<p>La soci&eacute;t&eacute; qui fait les installations des compteurs électriques est la soci&eacute;t&eacute; COMPTEURS ELECTRIQUES<br />\r\nhttp://www.example.com/</p>\r\n\r\n<p>le num&eacute;ro &agrave; contacter pour tout probl&egrave;me suite &agrave; l&#39;installation est le 0800 001 002<br />\r\n",
                "author_signature": "Édouard Durand, appt no C1",
                "entrance": "Tous",
                "pinned": false,
                "created_at": "2018-10-17T10:55:58.224+02:00"
            },
            "relationships": {...}
        }
    ]
}

Renvoie la liste des infos immeuble d'une copropriété.

Arguments de l'URL

Nom	Description
condominium_id	L'identifiant de la copropriété

Arguments en query string

Nom	Description
include	La liste des données liées à récupérer

Retour

Un objet avec une propriété data contenant un tableau d'infos immeuble.

Détail d'une info immeuble

GET /api/v1/notes/{id}

Exemple de requête

curl "https://app.chouettecopro.com/api/v1/notes/1234"
  -u {api_key}

Exemple de réponse

{
    "data": {
        "id": "123",
        "type": "notes",
        "links": {
            "self": "https://app.chouettecopro.com/api/v1/notes/123"
        },
          "attributes": {
              "title": "Numéros utiles",
              "body": "<p>Veuillez trouver ci-dessous la liste des num&eacute;ros utiles pour notre r&eacute;sidence :<br />\r\n- Contrats d&rsquo;entretien :</p>\r\n\r\n<p><em><strong>- Jean Dupont (entretien r&eacute;sidence)&nbsp;&nbsp; 01 02 03 04 05</strong></em><br />\r\n<strong>o (D&eacute;pannage ascenseur 24H/24) Soci&eacute;t&eacute; ASCENSEUR : 09 02 03 04 05</strong></p>\r\n",
              "author_signature": "Édouard Durand, appt no C1",
              "entrance": "Domaine Marie",
              "pinned": true,
              "created_at": "2018-10-10T14:53:17.763+02:00"
          },
        "relationships": {...}
    }
}

Renvoie les informations de l'info immeuble

Arguments de l'URL

Nom	Description
id	L'identifiant de l'info immeuble

Arguments en query string

Nom	Description
include	La liste des données liées à récupérer

Retour

Un objet avec une propriété data contenant l'info immeuble.

Images

Exemple d'image

{
    "id": "1234",
    "type": "pictures",
    "links": {
        "self": "https://app.chouettecopro.com/api/v1/pictures/1234"
    },
    "attributes": {
        "thumb_url": "https://app.chouettecopro.com/media/W1siZiIsIjIwMTgvMTAvMjIvNmZsODQ4eGExdV9JTUdfMjAxODEwMTJfV0EwMDIxLmpwZyJdLFsicCIsImVuY29kZSIsImpwZyIsIi1xdWFsaXR5IDM1IC1hdXRvLW9yaWVudCJdLFsicCIsInRodW1iIiwiMTI4eDEyOCMiXV0/image.jpg?sha=7fed508bdd2ed3fd",
        "small_url": "https://app.chouettecopro.com/media/W1siZiIsIjIwMTgvMTAvMjIvNmZsODQ4eGExdV9JTUdfMjAxODEwMTJfV0EwMDIxLmpwZyJdLFsicCIsImVuY29kZSIsImpwZyIsIi1xdWFsaXR5IDcwIC1hdXRvLW9yaWVudCJdLFsicCIsInRodW1iIiwiMzIweCJdXQ/image.jpg?sha=cc9289fd209c5232",
        "small_cropped_landscape_url": "https://app.chouettecopro.com/media/W1siZiIsIjIwMTgvMTAvMjIvNmZsODQ4eGExdV9JTUdfMjAxODEwMTJfV0EwMDIxLmpwZyJdLFsicCIsImVuY29kZSIsImpwZyIsIi1xdWFsaXR5IDcwIC1hdXRvLW9yaWVudCJdLFsicCIsInRodW1iIiwiMzIweDE4MCMiXV0/image.jpg?sha=dbdee55f45e88345",
        "medium_cropped_landscape_url": "https://app.chouettecopro.com/media/W1siZiIsIjIwMTgvMTAvMjIvNmZsODQ4eGExdV9JTUdfMjAxODEwMTJfV0EwMDIxLmpwZyJdLFsicCIsImVuY29kZSIsImpwZyIsIi1xdWFsaXR5IDcwIC1hdXRvLW9yaWVudCJdLFsicCIsInRodW1iIiwiNDgweDI3MCMiXV0/image.jpg?sha=bc1c5859b26dfd6c",
        "medium_url": "https://app.chouettecopro.com/media/W1siZiIsIjIwMTgvMTAvMjIvNmZsODQ4eGExdV9JTUdfMjAxODEwMTJfV0EwMDIxLmpwZyJdLFsicCIsImVuY29kZSIsImpwZyIsIi1xdWFsaXR5IDcwIC1hdXRvLW9yaWVudCJdLFsicCIsInRodW1iIiwiNDgweCJdXQ/image.jpg?sha=623fbde211bfa7d1",
        "large_url": "https://app.chouettecopro.com/media/W1siZiIsIjIwMTgvMTAvMjIvNmZsODQ4eGExdV9JTUdfMjAxODEwMTJfV0EwMDIxLmpwZyJdLFsicCIsImVuY29kZSIsImpwZyIsIi1xdWFsaXR5IDcwIC1hdXRvLW9yaWVudCJdLFsicCIsInRodW1iIiwiNzIweCJdXQ/image.jpg?sha=5398db713987789c"
    }
}

Les images sont ajoutées aux signalements ou aux commentaires par les utilisateurs.

L'objet image

Attributs

Nom	Description
thumb_url	L'URL de l'image en 128x128 pixels, recadrée au centre
small_url	La référence de l'ordre de service
small_cropped_landscape_url	Le délai d'intervention souhaité
medium_cropped_landscape_url	Le nom du prestataire à qui est affecté l'ordre de service
medium_url	Le nom du gestionnaire ayant demandé l'ordre de service
large_url	La date de création du signalement

Documents

Exemple de document

{
    "id": "1234",
    "type": "attachments",
    "links": {
        "self": "https://app.chouettecopro.com/api/v1/attachments/1234"
    },
    "attributes": {
        "url": "https://app.chouettecopro.com/media/W1siZiIsIjIwMTgvMTAvMTcvNTR3MnhtNjZhNl85Mjg2XzQyXzAwMV9FLnBkZiJdXQ/os.pdf?sha=8b12227fdd21d940"
    }
}

Les documents sont attachés aux ordres de service par les gestionnaires, à destination des prestataires.

L'objet document

Attributs

Nom	Description
url	l'URL du document

Erreurs

L'API ChouetteCopro utilise les codes d'erreur HTTP standards. Les codes 2xx indiquent un succès. Les codes 4xx indiquent une erreur dans la requête, par exemple un paramètre manquant ou une clé API non reconnue. Les codes 5xx indiquent une erreur sur les serveurs de ChouetteCopro.

Code d'erreur	Description
400	Bad Request - Requête invalide
401	Unauthorized - La clé API n'est pas reconnue
403	Forbidden - L'utilisateur désigné par la clé API n'a pas accès à la ressource demandée
404	Not Found - La ressource demandée n'existe pas
500, 503	Internal Server Error, Service Unavailable - Une erreur s'est produite sur les serveurs de ChouetteCopro