Trainings

Ce endpoint est dédié aux formations de Cards.

Listing des formation

GET https://api.cards-microlearning.com/v1/trainings

Récupération d'une liste de formation.

Cette liste peut être filtrée et est paginée.

Entête (Headers)

Nom	Valeur
Content-Type	application/json
Authorization	Bearer <token API>
X-Tenant	<Identifiant de votre espace (Tenant)>

Paramètre de l'url

Nom	Type	Description	Valeurs
paginate	Nombre entier	Nombre d'élément dans la liste par page	Défaut : 100 Max : 500
filters	Tableau Json	Permet de filtrer sur des champs de la formation, comme : groups_id groups_name is_public is_rating status Chaque entrée dans le tableau correspond à un filtre "AND". Chaque entrée doit avoir 2 clés : type values La clé "values" peut être une chaine ou un tableau de valeurs (filtre "OR"). Format : [ { "type": "groups_name", "values":"RPS" }, { "type": "groups_name", "values":["vol","sin"] }, { "type": "groups_id", "values":"9c445054-c2f0-46c4-b784-ae6ea4c3ebbe" } ]

Réponse

200

{
  "data": [
    {
      "id": "string",
      "title": "string",
      "description": "string",
      "status": "string",
      "image": "string",
      "public_url": "string",
      "category": "string",
      "groups": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "date_start": "datetime",
      "date_end": "datetime",
      "created_at": "datetime",
      "updated_at": "datetime"
    },
    {
      (...)
    }
  ],
  "links": {
    "first": "https://api.cards-microlearning.com/v1/trainings?page=1",
    "last": "https://api.cards-microlearning.com/v1/trainings?page=7",
    "prev": null,
    "next": "https://api.cards-microlearning.com/v1/trainings?page=2"
  },
  "meta": {
    "current_page": int,
    "from": int,
    "last_page": int,
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "https://api.cards-microlearning.com/v1/trainings?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": "https://api.cards-microlearning.com/v1/trainings?page=2",
        "label": "2",
        "active": false
      },
      {
        "url": null,
        "label": "...",
        "active": false
      },
      {
        "url": "https://api.cards-microlearning.com/v1/trainings?page=6",
        "label": "6",
        "active": false
      },
      {
        "url": "https://api.cards-microlearning.com/v1/trainings?page=7",
        "label": "Next »",
        "active": false
      }
    ],
    "path": "https://api.cards-microlearning.com/v1/trainings",
    "per_page": int,
    "to": int,
    "total": int
  }
}

401

{
  "message": "Unauthenticated."
}

403

{
  "message": "Incorrect domain"
}

Récupérer une formation par son identifiant

GET /trainings/<id_training>

Récupérer les information d'une seule formation.

Entête (Headers)

Name	Value
Content-Type	application/json
Authorization	Bearer <token>
X-Tenant	<Identifiant de votre espace (Tenant)>

Réponse

200

{
  "data": {
    {
      "id": "string",
      "title": "string",
      "description": "string",
      "status": "string",
      "image": "string",
      "public_url": "string",
      "category": "string",
      "groups": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "date_start": "datetime",
      "date_end": "datetime",
      "created_at": "datetime",
      "updated_at": "datetime"
    }
  }
}

401

{
  "message": "Unauthenticated."
}

403

{
  "message": "Incorrect domain"
}

404

{
  "message": "Training doesn't exist",
  "type": "trainings"
}