Badges

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

Listing des badges

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

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

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

Entête (Headers)

Name	Value
Content-Type	application/json
Authorization	Bearer <token>
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 paramètre du badge comme : status option_teasing notif 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": "status", "values": ["draft","publish","expire"] }, { "type": "option_teasing", "values": 0 }, { "type": "notif", "values": 1 } ]

Response

200

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "image": "url",
      "emoji": {
        "i": "emoji",
        "n": [
          "string",
        ],
        "r": "string",
        "t": "string",
        "u": "string"
      },
      "created_at": "datetime",
      "updated_at": "datetime"
    },
    {
      (...)
    }
  ],
  "links": {
    "first": "https://api.cards-microlearning.com/v1/badges?page=1",
    "last": "https://api.cards-microlearning.com/v1/badges?page=5",
    "prev": null,
    "next": "https://api.cards-microlearning.com/v1/badges?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/badges?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": "https://api.cards-microlearning.com/v1/badges?page=2",
        "label": "2",
        "active": false
      },
      {
        "url": null,
        "label": "...",
        "active": false
      },
      {
        "url": "https://api.cards-microlearning.com/v1/badges?page=4",
        "label": "4",
        "active": false
      },
      {
        "url": "https://api.cards-microlearning.com/v1/badges?page=5",
        "label": "Next »",
        "active": false
      }      
    ],
    "path": "https://api.cards-microlearning.com/v1/badges",
    "per_page": int,
    "to": int,
    "total": int
  }
}

401

{
  "message": "Unauthenticated."
}

403

{
  "message": "Incorrect domain"
}

Récupérer un badge par son identifiant

GET https://api.cards-microlearning.com/v1/badges/<id_badge>

Récupérer les informations d'un seul badge.

Entête (Headers)

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

Response

200

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "image": "url",
    "emoji": {
      "i": "emoji",
      "n": [
        "string",
      ],
      "r": "string",
      "t": "string",
      "u": "string"
    },
    "created_at": "datetime",
    "updated_at": "datetime"
  }
}

401

{
  "message": "Unauthenticated."
}

403

{
  "message": "Incorrect domain"
}

404

{
  "message": "Badge doesn't exist",
  "type": "badge"
}

Listing des utilisateurs ayant débloqué ce badge

GET https://api.cards-microlearning.com/v1/badges/<id_badge>/users

Récupération d'une liste d'utilisateurs ayant débloqué un badge (via son identifiant).

Cette liste est paginée.

Entête (Headers)

Name	Value
Content-Type	application/json
Authorization	Bearer <token>
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

Response

200

{
  "data": [
    {
      "id": "string",
      "firstname": "string",
      "lastname": "string",
      "email": "string",
      "role": "string",
      "company": "string",
      "phone": "string",
      "source": "string",
      "enable_ranking": bool,
      "lang": "string",
      "info_win": {
        "en": "string",
        "fr": "string"
      }
    },
    {
      (...)
    }
  ],
  "links": {
    "first": "https://api.cards-microlearning.com/v1/badges/<id_badge>/users?page=1",
    "last": "https://api.cards-microlearning.com/v1/badges/<id_badge>/users?page=5",
    "prev": null,
    "next": "https://api.cards-microlearning.com/v1/badges/<id_badge>/users?page=2"
  },
  "meta": {
    "current_page": int,
    "from": int,
    "last_page": int,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "https://api.cards-microlearning.com/v1/badges/<id_badge>/users?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": "https://api.cards-microlearning.com/v1/badges/<id_badge>/users?page=2",
        "label": "2",
        "active": false
      },
      {
        "url": null,
        "label": "...",
        "active": false
      },
      {
        "url": "https://api.cards-microlearning.com/v1/badges/<id_badge>/users?page=4",
        "label": "4",
        "active": false
      },
      {
        "url": "https://api.cards-microlearning.com/v1/badges/<id_badge>/users?page=5",
        "label": "Next &raquo;",
        "active": false
      }      
    ],
    "path": "https://api.cards-microlearning.com/v1/badges/<id_badge>/users",
    "per_page": int,
    "to": int,
    "total": int
  }
}

401

{
  "message": "Unauthenticated."
}

403

{
  "message": "Incorrect domain"
}

404

{
  "message": "Badge doesn't exist",
  "type": "badge"
}