Review Logistics Event filter parameter

[aloccid-iata]

Problem statement:

Currently, when retrieving all logistics events of a logistics object, we can apply a set of query parameters to filter the events. However, these query parameters are incomplete and follow inconsistent naming conventions.

Query parameter	Description	Valid values
eventType (optional)	Optional parameter that can be used to filter the logistics events by event type, the values MUST be comma separated	FOH DEP
created_after (optional)	Optional parameter that can be used to filter the logistics events	20190926T075830Z
created_before (optional)	Optional parameter that can be used to filter the the logistics events	20190926T075830Z
occurred_after (optional)	Optional parameter that can be used to filter the the logistics events	20190926T075830Z
occurred_before (optional)	Optional parameter that can be used to filter the the logistics events	20190926T075830Z

Solution:

We suggest here two main changes:

• The usage of kebab case naming convention for all parameters
• The introduction of skip, limit and sort parameters

The final result will be like

Query parameter	Description	Valid values
event-code (optional)	Optional parameter that can be used to filter the logistics events by event type, the values MUST be comma separated	FOH DEP
created-after (optional)	Filters the logistics events to only include those created after the specified timestamp	20190926T075830Z
created-before (optional)	Filters the logistics events to only include those created before the specified timestamp	20190926T075830Z
occurred-after (optional)	Filters the logistics events to only include those that occurred after the specified timestamp	20190926T075830Z
occurred-before (optional)	Filters the logistics events to only include those that occurred before the specified timestamp	20190926T075830Z
sort (optional)	Specifies the sorting order of the logistics events. This parameter expects a timestamp indicating the starting point	ASC-creationDate DESC-creationDate ASC-eventDate DESC-eventDate
limit (optional)	Limits the number of logistics events returned. The value is an integer specifying the maximum number of results	2
skip (optional)	Skips a specified number of logistics events before beginning to return results. This is useful for pagination	5

For the event-code, the search will be executed on the @id property of the event-code object. For this reason, it's important that the @id must contains the code and be designed as valid URI. Example: https://onerecord.iata.org/ns/coreCodeLists#StatusCode_ARR

[aloccid-iata]

Approved by API working group on the 16/09/2024