reservations-eapi icon

reservations-eapi

2.0.x
(0 reviews)

There will be three main categories of Reservation resources, supported by reference data:

  1. Query availability
  2. Make or amend a booking
  3. Retrieve coach details
  4. Reference data

Each of these categories may contain one or more resources as determined by the requirements and underlying RARS platform capabilities.

Currently only the availability endpoint has a v2 variant. Other endpoints will be added as and when their v2 variant gets released

Query Availability
  • /v2/availability

This resource allows consumers to request availability of products on services. The availability resource allows consumers to request availability for one more products against one or more journeys(1) to determine whether they are available and to retrieve the tariff codes needed to make a booking. This API also allows users to optionally specify a priority sequence for products, which has the effect of limiting the response to only the highest priority available product(s).

NOTE:

  • the domain for v2 of the Availability API is different to that of v1.
  • the client_id header is now mandatory, whereas it was optional in v1
  • a user-agent header is now mandatory, whereas it was not required in v1

(1) subject to limits specified in RDG Standards, such as RSPS5210 and RSPS1022

Security

The client_id and user-agent headers mentioned above have been added to v2 as mandatory headers to improve security.

  • failure to specify the correct client_id will result in an unauthorised error
  • failure to specify a user-agent header will result in a schema failure error
  • the user-agent value should include the name of system making the request and its version number (e.g. RDGRuntime/7.41.2)

As shown in the examples, a Bearer token obtained from the RDG IAM API must always be sent as the Authorization header.

  • failure to specify a valid Bearer token will result in an unauthorised error

Last update: 18-Oct-2024 21:25 ASSIST API Documentation Maintenance: 'reservations-eapi', Version 'v2', Page 'Home', Revision 'E'.

To request updates to this text please contact Neil Barkham.

Reviews