reservations-eapi icon

reservations-eapi

(0 reviews)

home

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

NOTE: for version 2 and above of this API
- the domain of the Reservations API is different to that of v1.
- the client_id and User-Agent headers are mandatory, whereas they were optional in v1
- when there is a request body (e.g. POST request), the Content-Type header is mandatory and must be set to application/json
- if specified, the x-correlation-cust-id header must be less than 100 characters


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).

(1) subject to limits specified in RDG Standard RSPS5210


Security

The client_id, user-agent and content-type headers mentioned above have been added to v2 and above to improve security.
- failure to specify the correct client_id will result in a 401 Unauthorised error
- failure to specify a user-agent header will result in a 400 Invalid schema error
- failure to specify the content-type as application/json, when required, will result in a 415 Unsupported Media Type error
Note: the user-agent value should include the name of system making the request and its version number (e.g. RDGRuntime/7.41.2)

The 100 character limit on x-correlation-cust-ids as also been added to improve security.
- specifying an x-correlation-cust-id header with more than 100 characters will result in a 400 Invalid schema error

As shown in the examples, a Bearer token obtained from the RDG IAM API must always be sent in requests as the Authorization header.
- failure to specify a valid Bearer token will result in a 401 Unauthorised error


Last update: 14-Nov-2025 09:56 ASSIST API Documentation Maintenance: 'reservations-eapi', Version 'v2', Page 'Home', Revision 'G'.

To request updates to this text please contact Neil Barkham.


Reviews