Interface role
Booking is an interface that enables the creation, modification and retrieval of bookings, including details of conflicts between different bookings within the ASM Support System by External Users. The interface allows for continuous updates in real time of Booking information among authorised ASM Support Systems/External Users in order to enhance cross border coordination based on the most recent information.
The interface also enables booking of airspace structures across national borders; airspace users are able to book foreign airspace using their local ASM Support System. The process of a foreign booking follows the ASM process defined in dedicated LoAs between States.
The creation and modification of bookings is supported through the provision of ‘Actions’ by the interface. The Actions describe the allowed modifications that a user may take on a specific booking. Actions are subject to change based on the state of a booking and the current time.
Figure 18 in Section 2.4.6.1 provides an overview of the Booking interface
Information Exchange Flow
Figure 19 in Section 2.4.6.2 depicts the Booking interface information exchange flow
Interface Functions
The interface performs the following functions:
- Creating a Booking introduces a new Booking into the ASM Support System to be approved to be incorporated into the plan.
- Updating a Booking updates an existing Booking in the ASM Support System potentially as a result of a CDM process or simply to update the plan to reflect changes to planned activities.
- Requesting Booking List allows access to the Booking information from within the ASM Support System to allow for CDM processes.
- Requesting Actions allows access to the Actions that can performed by the actor. Identifying where they may contribute to the CDM process within the ASM Support System and which Airspace Reservation they can update to better inform the plan.
- Requesting History allows access to the history of all actions that have been performed on a Booking.
ASM-INTF-ARES-010: ASMtoASM Service shall be supported by the Booking interface to manage the reservations
ASM-INTF-ARES-020: The Booking interface shall implement synchronous Request-Reply application message exchange pattern.
ASM-INTF-ARES-030: The Booking interface shall support the following operations:
- createBooking,
- updateBooking,
- queryBookingList
- queryActionList
- queryBookingHistoryList
Operations
This operation is intended to introduce a new booking in the ASM Support System in response to a request from an External User. As a result, the new booking is either created in the local ASM Support System and the External User is notified, or the booking is not created and an appropriate error message is transmitted to the External User.
Associated messages
ASM-INTF-ARES-040: The createBooking operation shall receive and process the BookingCreationRequest message from an External User.
ASM-INTF-ARES-050: The createBooking operation shall validate the BookingCreationRequest message against the following criteria which must be met:
- All mandatory data for the BookingCreationRequest message are provided
- The booking ID must be null/not set
- The start date and time of all AirspaceReservations must be in the future
- The end date and time of an AirspaceReservation must be after its start date and time
- The External User must have permission to book the airspace structures as defined by the ActivityData.
- The entire booked period must be within the life time of all booked airspace structures
- The booked flight levels must be within or equal to the flight level bounds of the airspace structures
- The booked lower flight level of an airspace structure must be below the booked upper flight level of the airspace structure
- The selected responsible unit must be common to all booked airspace structures as defined by the ActivityData.
ASM-INTF-ARES-060: If the booking is valid, the createBooking operation shall transmit the newly created booking in the BookingReply message to the requesting External User.
ASM-INTF-ARES-070: If the request or the resulting booking is not valid, the createBooking operation shall transmit an appropriate error in the BookingReply message to the requesting External User.
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
This operation is intended to introduce updates to an existing booking in the ASM Support System in response to a request from an External User. As a result, the booking is either updated in the local ASM Support System and the External User is notified, or the booking is not updated and an appropriate error message is transmitted to the External User.
Associated messages
ASM-INTF-ARES-080: The updateBooking operation shall receive and process the BookingUpdateRequest message from an External User.
ASM-INTF-ARES-090: The updateBooking operation shall validate the BookingUpdateRequest message against the following criteria which must be met:
- All mandatory data for the BookingCreationRequest message are provided
- The booking ID must be set
- The lastChangeTime in the booking must match that held by the service
- The start date and time of all AirspaceReservations must be in the future; if the booking is active the start dates and times must match the original start dates and times and the end time should be in the future
- The end date and time of an AirspaceReservation must be after its start date and time
- The External User must have permission to book the airspace structures as defined by the ActivityData
- The entire booked period must be within the life time of all booked airspace structures
- The booked flight levels must be within or equal to the flight level bounds of the airspace structures
- The booked lower flight level of an airspace structure must be below the booked upper flight level of the airspace structure
- The selected responsible unit must be common to all booked airspace structures as defined by the ActivityData
ASM-INTF-ARES-100: If the booking update is valid, the updateBooking operation shall transmit the updated booking in the BookingReply message to the requesting External User.
ASM-INTF-ARES-110: If the request or the resulting updated booking is not valid, the updateBooking operation shall transmit an appropriate error in the BookingReply message to the requesting External User.
ASM-INTF-ARES-120: An updateBookingRequest should be rejected by the service if the user performing the update does not have the appropriate actions matching their update.
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
This operation is intended to introduce a query for the list of bookings in the ASM Support System in response to a request from an External User. As a result, the list of bookings is either transmitted to the External User or not, and an appropriate error message is transmitted to the External User.
Associated messages
ASM-INTF-ARES-130: The queryBookingList operation shall receive and process the FilteredRequest message from an External User.
ASM-INTF-ARES-140: The queryBookingList operation shall validate the FilteredRequest message against the following criteria which must be met:
- All mandatory data for FilteredRequest message are provided
ASM-INTF-ARES-150: If the request is valid, the queryBookingList operation shall transmit the filtered list of bookings in the BookingListReply message to the requesting External User.
ASM-INTF-ARES-160: If the request is not valid, the queryBookingList operation shall transmit an appropriate error in the BookingListReply message to the requesting External User.
ASM-INTF-ARES-170: The queryBookingList operation shall accept any combination of the following filters in the FilteredRequest message:
- ActivityIDFilter
- ChangePeriodFilter
- InterestedIntervalFilter
- AndFilter
ASM-INTF-ARES-180: The queryBookingList operation should accept any combination of the following filters in the FilteredRequest message:
- AirspaceIDFilter
- GeometryFilter
- MissionIDFilter
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
This operation is intended to introduce a query for the list of actions in the ASM Support System in response to a request from an External User. As a result, the list of actions is either transmitted to the External User or not, and an appropriate error message is transmitted to the External User.
Associated messages
ASM-INTF-ARES-190: The queryActionList operation shall receive and process the FilteredRequest message from an External User.
ASM-INTF-ARES-200: The queryActionList operation shall validate the FilteredRequest message against the following criteria which must be met:
- All mandatory data for the FilteredRequest message are provided
ASM-INTF-ARES-210: If the request is valid, the queryActionList operation shall transmit the list of actions in the BookingActionListReply message to the requesting External User.
ASM-INTF-ARES-220: If the request is not valid, the queryActionList operation shall transmit an appropriate error in the BookingActionListReply message to the requesting External User.
ASM-INTF-ARES-230: The queryActionList operation shall accept the following filter in the FilteredRequest:
- ActivityIDFilter
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
This operation is intended to introduce a query for the list of history of actions performed on a booking in the ASM Support System in response to a request from an External User. As a result, the list of history of actions performed on a booking is either transmitted to the External User or not, and an appropriate error message is transmitted to the External User.
Associated messages
ASM-INTF-ARES-240: The queryBookingHistoryList operation shall receive and process the FilteredRequest message from an External User.
ASM-INTF-ARES-250: The queryBookingHistoryList operation shall validate the FilteredRequest message against the following criteria which must be met:
- All mandatory data for the FilteredRequest message are provided
ASM-INTF-ARES-260: If the request is valid, the queryBookingHistoryList operation shall transmit the complete list of history of actions performed on a booking in the BookingHistoryListReply message to the requesting External User.
ASM-INTF-ARES-270: If the request is not valid, the queryBookingHistoryList operation shall transmit an appropriate error in the BookingHistoryListReply message to the requesting External User.
ASM-INTF-ARES-280: The queryBookingHistoryList operation shall accept the following filter in the FilteredRequest message:
- ActivityIDFilter
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
Endpoints
N/A