Classes

/classrooms/:id.json

GET https://my.opencomp.fr/api/v1/classrooms/:id.:format?api_key=:api_key

Ce point d'accès vous permet de récupérer une classe.

Path Parameters

Name	Type	Description
id	integer	L'identifiant de la classe à récupérer.
format	string	Le format de données à récupérer en sortie. Peut être json ou xml.

Query Parameters

Name	Type	Description
api_key	string	Votre clé d'API.

200 Classe récupérée avec succès

{
    "id": 109,
    "id_be": 10001455,
    "title": "Classe de d\u00e9mo 2018",
    "year_id": 8,
    "establishment_id": "DEMO1234",
    "created": "2018-08-14T00:00:00+00:00",
    "pupils_count": 25,
    "evaluations_count": 4,
    "license_key": null
}

401 La clé d'API est manquante ou n'existe pas.

{
    "message": "API Key is missing or invalid. Retry with api_key query parameter.",
    "url": "\/api\/v1\/classrooms\/view\/17.json",
    "code": 401
}

403 La clé d'API est valide mais vous n'avez pas la permission d'accéder à la ressource demandée.

{
    "message": "Vous n\u0027\u00eates pas autoris\u00e9 \u00e0 acc\u00e9der \u00e0 cet emplacement.",
    "url": "\/api\/v1\/classrooms\/view\/17.json?api_key=cc9e40009-5644-11e6-bec8-0242ac120004",
    "code": 403
}