Skip to content

Parcs

Permet de récupérer les parcs (équipements/solutions logicielles) associés à une société.

Récupérer les parcs

GET /v1/parc

Retourne la liste des parcs d'une société avec le type, le statut, le nombre d'utilisateurs, le contrat de maintenance, la solution et les éditeurs/intégrateurs associés.

Headers

NomTypeRequisDescription
x-access-tokenStringouiClé API

Paramètres query

NomTypeRequisDescription
idCompanyint|int[]conditionnelIdentifiant(s) de la société
idParcint|int[]conditionnelIdentifiant(s) du parc
sirenString|String[]conditionnelNuméro(s) SIREN

TIP

Au moins un paramètre est obligatoire.

Réponses

200 — OK
json
{
    "success": true,
    "parameters": {
        "idAccount": "string|null",
        "idCompany": "int[]|null",
        "siren": "string[]|null",
        "idParc": "int[]|null"
    },
    "parcList": [
        {
            "idParc": "int",
            "idCompany": "int",
            "idParcType": "int|null",
            "idParcStatus": "int|null",
            "idParcNumberOfUser": "int|null",
            "yearDebut": "int|null",
            "idParcMaintenanceContract": "int|null",
            "idSolution": "int|null",
            "idCompanyIntegrator": "int|null",
            "idCompanyEditor": "int|null",
            "idUser": "int|null",
            "created": "datetime",
            "modified": "datetime",
            "solutionUnknown": "bool|null",
            "createdByScript": "bool",
            "idDomain": "int|null",
            "note": "float|null",
            "fromOther": "bool|null",
            "fromLBL": "bool|null",
            "parcType": {
                "idParcType": "int",
                "title": "string"
            },
            "parcSatus": {
                "idParcStatus": "int",
                "title": "string"
            },
            "parcNumberOfUsers": {
                "idNumberOfUsers": "int",
                "title": "string"
            },
            "parcMaintenanceContract": {
                "idParcMaintenanceContract": "int",
                "title": "string"
            },
            "solution": {
                "idSolution": "int",
                "idCompanyEditor": "int|null",
                "obsoleteYear": "int|null",
                "idSolutionVersion": "int|null",
                "modified": "datetime",
                "isActive": "bool",
                "name": "string|null"
            },
            "companyIntegrator": "object|null",
            "companyEditor": "object|null"
        }
    ]
}

Notes :

  • ⚠️ La clé du statut imbriqué est bien parcSatus (sans le second « t ») — c'est le nom réellement retourné par l'API.
  • parcType, parcSatus, parcNumberOfUsers, parcMaintenanceContract et solution valent null si l'information n'est pas renseignée.
  • companyIntegrator et companyEditor sont des objets société partiels : seuls idCompany et name sont renseignés, les autres champs sont null.
400 — Bad Request
json
{
    "success": false,
    "message": "Paramètre idCompany, siren ou idParc nécessaire",
    "parameters": {}
}
401 — Unauthorized
json
{
    "success": false,
    "code": "401",
    "message": "Clé API invalide"
}
403 — Forbidden
json
{
    "success": false,
    "code": 403,
    "message": "L'abonnement n'a pas accès à ces données",
    "parameters": {}
}

Coefficy — API externe