Commentaires

Permet de récupérer les commentaires associés à une société.

Récupérer les commentaires

GET /v1/comment

Retourne la liste des commentaires filtrés par société, utilisateur, type ou période.

Headers

Nom	Type	Requis	Description
x-access-token	String	oui	Clé API

Paramètres query

Nom	Type	Requis	Description
idCompany	int	conditionnel	Identifiant de la société. Obligatoire si siren et polling ne sont pas renseignés
siren	String	conditionnel	Numéro SIREN. Obligatoire si idCompany et polling ne sont pas renseignés
polling	int	conditionnel	Commentaires créés/modifiés dans les X dernières minutes (min. 15). Obligatoire si idCompany et siren ne sont pas renseignés
idUser	int|int[]	non	Filtrer par utilisateur(s)
idCommentType	int|int[]	non	Filtrer par type(s) de commentaire
minCommentDate	datetime	non	Date de début de la période
maxCommentDate	datetime	non	Date de fin de la période

TIP

Au moins un des paramètres idCompany, siren ou polling est obligatoire.

Réponses

200 — OK

{
    "success": true,
    "code": "200",
    "message": "OK",
    "parameters": {
        "idCompany": "int|null",
        "siren": "string|null",
        "polling": "int|null"
    },
    "result": {
        "commentList": [
            {
                "idComment": "int",
                "idCommentType": "int",
                "commentDate": "datetime",
                "idUser": "int",
                "idCompany": "int",
                "comment": "string",
                "created": "datetime",
                "modified": "datetime"
            }
        ]
    }
}

400 — Bad Request

{
    "success": false,
    "code": "400",
    "message": "Paramètre incorrect"
}

Retourné si aucun paramètre obligatoire n'est fourni.

401 — Unauthorized

{
    "success": false,
    "code": "401",
    "message": "Clé API invalide"
}

403 — Forbidden

{
    "success": false,
    "code": "403",
    "message": "Accès refusé"
}