Skip to content

Parcs

Permet de récupérer les parcs (équipements/solutions) 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 contrat de maintenance et les éditeurs/intégrateurs associés.

Headers

NomTypeRequisDescription
x-access-tokenStringouiClé API

Paramètres query

NomTypeRequisDescription
idCompanyintconditionnelIdentifiant de la société
idParcintconditionnelIdentifiant du parc
sirenStringconditionnelNuméro SIREN

TIP

Au moins un paramètre est obligatoire.

Réponses

200 — OK
json
{
    "success": true,
    "code": "200",
    "message": "OK",
    "parameters": {
        "idCompany": "int|null",
        "idParc": "int|null",
        "siren": "string|null"
    },
    "result": {
        "parcList": [
            {
                "idParc": "int",
                "idCompany": "int",
                "idParcType": "int",
                "created": "datetime",
                "modified": "datetime",
                "note": "float|null",
                "parcType": {
                    "idParcType": "int",
                    "title": "string"
                },
                "parcStatus": {
                    "idParcStatus": "int",
                    "title": "string"
                },
                "parcNumberOfUsers": {
                    "idParcNumberOfUsers": "int",
                    "title": "string"
                },
                "parcMaintenanceContract": {
                    "idParcMaintenanceContract": "int",
                    "title": "string"
                },
                "solution": "string|null",
                "companyIntegrator": "object|null",
                "companyEditor": "object|null"
            }
        ]
    }
}
400 — Bad Request
json
{
    "success": false,
    "code": "400",
    "message": "Au moins un paramètre est requis"
}
401 — Unauthorized
json
{
    "success": false,
    "code": "401",
    "message": "Clé API invalide"
}

Coefficy — API externe