Commentaire sur une opération

Il est possible de publier des commentaires sur une opération (intervention, réserve, devis)

Qu'est-ce qu'un commentaire ?

Un commentaire est un log d'une opération. Il vous permet d'ajouter des informations complémentaires ou modifier des informations sur une opération sans en changer l'état (statut et événement).
Il est partagé à l'ensemble des parties prenantes de l'opération.
Lors de l'ajout d'un commentaire, intentPlatform génère une notification (webhook, mail).

Il est possible de publier un commentaire lors des statuts open, pending, hold d'une intervention et du statut open pour un devis et une réserve.
Pour l'instant, il n'est pas possible de publier un commentaire lorsque l'intervention est en statut closed ou denied
Il n'est pas possible de créer une opération en commençant par un commentaire.

Modalités d'envoi

Un commentaire est un log d'une opération. Vous devez transmettre les valeurs obligatoires d'une opération.

Status et event possible

{
    "status": "open", "pending", "hold",
    "event": "commented"
}

Exemple

Publication d'un commentaire sur une intervention et ajout de 2 tags (ref_interne et niveau)

POST  https://apisandbox.hubintent.com/api/operations/v2/interventions/logs 
{
    "reference": "inter_1A",
    "description": "Ici mon commentaire",
    "contractReference": "contract_intent",
    "status": "open",
    "event": "commented",
    "eventDate": "2023-06-30T10:00:00",
    "logDate": "2023-06-30T10:10:00",
    "serviceCode": "P902",
    "location": {
        "assetReference": "LOGEMENT_003"
    },
    "tags": {
        "ref_interne": "BI-009",
        "niveau": "moyen"
    },
    "workType": "corrective"
}

Rendu visuel


https://slite.com/api/files/tHmMwW2WV6wjwE/capture%20d%E2%80%99e%CC%81cran%202023-06-30%20a%CC%80%2015.52.12.png?apiToken=eyJhbGciOiJIUzI1NiIsImtpZCI6IjIwMjMtMDUtMDQifQ.eyJzY29wZSI6Im5vdGUtZXhwb3J0IiwibmlkIjoiUTIyM1NyUnJpbkhPemsiLCJpYXQiOjE3MjkwOTIwNzQsImlzcyI6Imh0dHBzOi8vc2xpdGUuY29tIiwianRpIjoiSTM2VXdsdmdyWTJndU4iLCJleHAiOjE3MzE2ODQwNzR9.xF-BjBVjj_86hUEMn8Z5RhvzO9GTbMweyisFFgfob6w

https://slite.com/api/files/R81AGHeAwTtWt0/capture%20d%E2%80%99e%CC%81cran%202023-06-30%20a%CC%80%2015.52.21.png?apiToken=eyJhbGciOiJIUzI1NiIsImtpZCI6IjIwMjMtMDUtMDQifQ.eyJzY29wZSI6Im5vdGUtZXhwb3J0IiwibmlkIjoiUTIyM1NyUnJpbkhPemsiLCJpYXQiOjE3MjkwOTIwNzQsImlzcyI6Imh0dHBzOi8vc2xpdGUuY29tIiwianRpIjoiSTM2VXdsdmdyWTJndU4iLCJleHAiOjE3MzE2ODQwNzR9.xF-BjBVjj_86hUEMn8Z5RhvzO9GTbMweyisFFgfob6w

API

{
    "_links": {
        "self": {
            "href": "https://apisandbox.hubintent.com/api/operations/v2/operations/inter_1A?contractReference=contract_intent"
        },
        "documents:list": {
            "href": "https://apisandbox.hubintent.com/api/documents/v1/documents?elementType=intervention&elementReference=inter_1A"
        }
    },
    "reference": "inter_1A",
    "description": "Plus de chauffage dans le logement. Le locataire indique une température de 16°C",
    "criticalLevel": 3,
    "issuer": {
        "entity": {
            "id": "5cb73d0d7c73a343dbb69dfb",
            "label": "intenttest sandbox",
            "logoUrl": "https://image.freepik.com/free-vector/abstract-real-estate-logo_1032-116.jpg"
        },
        "user": {
            "id": "c561e0cb-3c46-4255-a5aa-901f3bb72587",
            "type": "client",
            "name": "Intent"
        }
    },
    "tags": {
        "ref_interne": "BI-009",
        "niveau": "moyen"
    },
    "contract": {
        "reference": "contract_intent",
        "label": "Contrat",
        "topic": "Multi technique",
        "entities": [
            {
                "id": "5cb73d0d7c73a343dbb69dfb",
                "label": "intenttest sandbox",
                "logoUrl": "https://image.freepik.com/free-vector/abstract-real-estate-logo_1032-116.jpg"
            },
            {
                "id": "63da7bb4574c950974f5075a",
                "label": "Gestionnaire test",
                "logoUrl": "https://sandbox.hubintent.com/intent/entities/logos/f20e5c12-b584-4a2d-873c-bf470c90ea22.png"
            }
        ]
    },
    "type": "intervention",
    "service": {
        "code": "P902",
        "originalCode": "P902"
    },
    "workType": "corrective",
    "status": "open",
    "event": "acknowledged",
    "eventDate": "2020-06-30T10:45:23+02:00",
    "logDate": "2020-06-30T10:45:26+02:00",
    "eventHistory": [
        "acknowledged",
        "commented"
    ],
    "location": {
        "assetReference": "LOGEMENT_003",
        "address": {
            "way": "165 AVENUE DE BRETAGNE",
            "city": "LILLE",
            "zip": "59000",
            "country": "FRANCE"
        },
        "owner": {
            "id": "63da7bb4574c950974f5075a",
            "label": "Gestionnaire test",
            "entityRoles": [
                {
                    "name": "assetOwner"
                },
                {
                    "name": "client"
                }
            ],
            "logoUrl": "https://sandbox.hubintent.com/intent/entities/logos/f20e5c12-b584-4a2d-873c-bf470c90ea22.png"
        }
    },
    "contacts": [
        "BEGIN:VCARD\n\nVERSION:3\r\nFN;CHARSET=UTF-8:Pierre DUPONT\r\nN;CHARSET=UTF-8:DUPONT;Pierre\r\nTEL;TYPE=WORK,VOICE:0734220902\r\nTEL;TYPE=HOME,VOICE:0685874445\r\nADR;TYPE=WORK:165 Avenue de Bretagne;59000;LILLE;France\r\nROLE;CHARSET=UTF-8:Locataire\r\nEMAIL;CHARSET=UTF-8;TYPE=WORK,INTERNET:p.dupont@internet.fr\r\nEND:VCARD"
    ],
    "logs": [
        {
            "issuer": {
                "entity": {
                    "id": "5cb73d0d7c73a343dbb69dfb",
                    "label": "intenttest sandbox",
                    "logoUrl": "https://image.freepik.com/free-vector/abstract-real-estate-logo_1032-116.jpg"
                },
                "user": {
                    "id": "c561e0cb-3c46-4255-a5aa-901f3bb72587",
                    "type": "client",
                    "name": "Intent"
                }
            },
            "reference": "inter_1A",
            "description": "Plus de chauffage dans le logement. Le locataire indique une température de 16°C",
            "contractReference": "contract_intent",
            "contacts": [
                "BEGIN:VCARD\n\nVERSION:3\r\nFN;CHARSET=UTF-8:Pierre DUPONT\r\nN;CHARSET=UTF-8:DUPONT;Pierre\r\nTEL;TYPE=WORK,VOICE:0734220902\r\nTEL;TYPE=HOME,VOICE:0685874445\r\nADR;TYPE=WORK:165 Avenue de Bretagne;59000;LILLE;France\r\nROLE;CHARSET=UTF-8:Locataire\r\nEMAIL;CHARSET=UTF-8;TYPE=WORK,INTERNET:p.dupont@internet.fr\r\nEND:VCARD"
            ],
            "creationDate": "2023-06-30T15:51:20+02:00",
            "type": "intervention",
            "serviceCode": "P902",
            "workType": "corrective",
            "status": "open",
            "event": "acknowledged",
            "eventDate": "2020-06-30T10:45:23+02:00",
            "logDate": "2020-06-30T10:45:26+02:00",
            "location": {
                "assetReference": "LOGEMENT_003",
                "address": {
                    "way": "165 AVENUE DE BRETAGNE",
                    "city": "LILLE",
                    "zip": "59000",
                    "country": "FRANCE"
                },
                "assetLabel": "RdC, Porte 03",
                "assetOwner": "gestionnairetest.intent",
                "assetAlgoliaId": "63da7bef67745806345c6588"
            },
            "equipmentWorkingOrder": "not_operational",
            "visitAttempt": 1,
            "criticalLevel": 3
        },
        {
            "issuer": {
                "entity": {
                    "id": "63da7bb4574c950974f5075a",
                    "label": "Gestionnaire test",
                    "logoUrl": "https://sandbox.hubintent.com/intent/entities/logos/f20e5c12-b584-4a2d-873c-bf470c90ea22.png"
                },
                "user": {
                    "id": "a0b3485a-acf8-4625-a838-f7f3c94c5822",
                    "type": "client",
                    "name": "Paramétrage intent"
                }
            },
            "reference": "inter_1A",
            "description": "Ici mon commentaire",
            "tags": {
                "ref_interne": "BI-009",
                "niveau": "moyen"
            },
            "contractReference": "contract_intent",
            "creationDate": "2023-06-30T15:51:54+02:00",
            "type": "intervention",
            "serviceCode": "P902",
            "workType": "corrective",
            "status": "open",
            "event": "commented",
            "eventDate": "2023-06-30T10:00:00+02:00",
            "logDate": "2023-06-30T10:10:00+02:00",
            "location": {
                "assetReference": "LOGEMENT_003",
                "address": {
                    "way": "165 AVENUE DE BRETAGNE",
                    "city": "LILLE",
                    "zip": "59000",
                    "country": "FRANCE"
                },
                "assetLabel": "RdC, Porte 03",
                "assetOwner": "gestionnairetest.intent",
                "assetAlgoliaId": "63da7bef67745806345c6588"
            }
        }
    ],
    "creationDate": "2023-06-30T15:51:20+02:00",
    "lastUpdateDate": "2023-06-30T15:51:54+02:00"
}