openactive / open-booking-api

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

Opportunity data dereferencing and feed retention policies #139

Open nickevansuk opened 4 years ago

nickevansuk commented 4 years ago

138 also raises the issue of how retention of opportunities in the Open Feeds works with the Order feed. The Open Booking API makes the assumption that all Orders in the Orders feed can be dereferenced from the opportunity feeds, however this only works in the items are not deleted from the opportunity feeds.

The Open Booking API should recommend that Brokers maintain a record of the Opportunity after it has occurred along with the Invoice, and do not rely on dereferencing it from the open feeds after the opportunity has occurred (as the opportunity might not be retained by the booking system in perpetuity).

This is likely a safer assumption than mandating any specific type of retention strategy for the Booking System, especially given the burden of record is on the Broker regarding previous bookings.

nathansalter commented 4 years ago

I think a reasonable recommendation for feeds is to keep the Order in the feed until the actual booking(s) have taken place. Once this has passed, there wouldn't be much use for a consumer to require this information as the chance for cancellation/amendments has already passed. Unless we move to a full customer-oriented approach, I can't see a reason why once the Consumer has determined the order has passed through and it can no longer be actioned why it can't be dropped from the feed.

Maybe it would make sense to add a property in the feed which explicitly says when the Order will no longer appear in the feed?