openactive / open-booking-api

Repository for the Open Booking API specification
Other
2 stars 3 forks source link

Opportunity data in the Orders feed #198

Open nickevansuk opened 3 years ago

nickevansuk commented 3 years ago

To resolve issues detailed here for Replacement and Proposal Amendment, both these operations should include the opportunity data in the Orders feed. This ensures that brokers do not need to consume all feeds, and also ensures that brokers that filter only a subset of the data are not caught out.

As a principle of design: all updates to opportunities made after booking must include the associated Opportunity Data in the Orders feed, and must not rely on feed harvesting synchronisation between the Orders feed and opportunity feeds, as this is fragile and fraught with race conditions.

Given the relative frequency of Change of Logistics notifications, and issues around synchronising these between B and the opportunity feeds without a common "modified" timestamp, Change of Logistics should also include Opportunity Data in the Orders feed. This also makes Change of Logistics more robust, as the booking system is making an explicit update to the data, and the broker is then guaranteed to read and deal with the update.