Ferries Data Structure

The structure of the API specification follows a standard. This document intends to explain every aspect of this structure and their fields.

The integration will have the following methods:

Method Input Output Required Description
Avail AvailabilityRQ AvailabilityRS Yes Makes a availability call
Valuation ValuationRQ ValuationRS Yes Makes a pre-booking
Reservation ReservationRQ ReservationRS Yes Makes a booking
Routes RoutesRQ RoutesRS Yes Gets a static routes list
RetrieveReservation RetrieveReservation RQ RetrieveReservation RS No Gets the details of a single booking
RetrieveReservation List RetrieveReservation ListRQ RetrieveReservation ListRS No Gets a list of bookings
Cancelation CancellationRQ CancellationRS No Cancels a booking

Each request sent to the service url requires a node called rqXML . Inside this node travels the current method’s Input object.

The data structure will always have common elements in all objects and the specific objects related to the operation

Data structure content:

  1. Common-Elements
  2. Valuation
  3. Avail
  4. Valuation
  5. Reservation
  6. Routes
  7. RetrieveReservation
  8. RetrieveReservationList
  9. Cancellation
  10. Errors