Lister les communications

GET

https://api-v2.test.eldowallet.fr/communications

Liste paginée des communications du wallet, filtrables par statut, par plage de dates de début et par recherche texte sur la description.

À retenir

• Statuts : PENDING (en attente de startDate), ACTIVE (en ligne sur la carte de fidélité), INACTIF (désactivée), EXPIRED (endDate dépassée). La mise en ligne à startDate et l'expiration à endDate sont automatiques.

Requête

query parameters

• sortOrder string
  Sens du tri : `ASC` ou `DESC`. Par défaut : `DESC`.
  enum: asc, descdefault: "desc"
• status string
  Filtre par statut : `PENDING`, `ACTIVE`, `INACTIF` ou `EXPIRED`.
  enum: PENDING, ACTIVE, INACTIF, EXPIRED
• startDateStart string
  Ne renvoie que les communications dont `startDate` est postérieure ou égale à cette date (ISO 8601).
• startDateEnd string
  Ne renvoie que les communications dont `startDate` est antérieure ou égale à cette date (ISO 8601).
• search string
  Recherche insensible à la casse dans la `description` ou l'identifiant de la communication.
• sortBy string
  Champ de tri. Par défaut : `createdAt`.
  default: "createdAt"
• limit number
  Nombre d'éléments par page, de 1 à 1 000. Par défaut : `10`.
  default: 10min: 1max: 1000
• page number
  Numéro de page, à partir de 1. Par défaut : `1`.
  default: 1min: 1

header parameters

• x-lang string
  Langue des messages d'erreur et des textes renvoyés : `fr` ou `en`.
  enum: en, frdefault: "en"

Réponses

200

Schéma application/json

• docs object[] required
• totalDocs number required
• limit number required
• page number
• totalPages number required
• pagingCounter number required
• hasPrevPage boolean required
• hasNextPage boolean required
• prevPage number
• nextPage number

401

UNAUTHORIZED

Schéma application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

403

FORBIDDEN

Schéma application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

500

UNKNOWN_ERROR

Schéma application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email