Lister les modèles de transport

GET

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

Liste, page par page, les modèles de transport du wallet pour un type donné (type obligatoire : Bus, Boat, Train, Air, Generic ou Tram).

À retenir

• Le wallet doit avoir le type de pass TRANSIT activé.

Requête

query parameters

• sortOrder string
  Ordre de tri : `asc` ou `desc`. Par défaut : `desc`.
  enum: asc, descdefault: "desc"
• type string required
  Type de transport (obligatoire) : `Bus`, `Boat`, `Train`, `Air`, `Generic` ou `Tram`.
  enum: Bus, Boat, Train, Air, Generic, Tram
• search string
  Recherche partielle sur l'identifiant du modèle (`_id`).
• sortBy string
  Champ de tri. Par défaut : `createdAt`.
  default: "createdAt"
• limit number
  Nombre de modèles par page, de 1 à 1000. 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