List the passes of a transit

GET

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

Lists, page by page, the passes of a transit template, with filters on status, creation date and search. Each pass includes departureDateTime, arrivalDateTime (format dd-MM-yyyy HH:mm) and the device types it is installed on (devices).

Good to know

• The wallet must have the TRANSIT pass type enabled.

Request

path parameters

• transitId string required
  Transit template ID (`_id`).

query parameters

• sortOrder string
  Accepted, but the list is always sorted by creation date, newest first.
  enum: asc, descdefault: "desc"
• status object
  Filter by status: `active`, `inactive`, `deleted`, `canceled` or `expired`. Repeat the parameter to combine several statuses.
• createdAtStart string
  Only returns passes created on or after this date (ISO 8601).
• search string
  Partial match on first name, last name, email, barcode, or the pass or client ID.
• sortBy string
  Accepted, but the list is always sorted by creation date, newest first.
  default: "createdAt"
• limit number
  Number of passes per page, from 1 to 1000. Default: `10`.
  default: 10min: 1max: 1000
• page number
  Page number, starting at 1. Default: `1`.
  default: 1min: 1

header parameters

• x-lang string
  Language for responses
  enum: en, frdefault: "en"

Responses

200

Schema 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

Schema 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

Schema 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

404

MODEL_NOT_FOUND

Schema 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

Schema 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