General
How do I request access to this API?
Access requests are handled through https://tui-air-links.com. Raise a request there and the AOPS Tech team will provision credentials for your application.
How does authentication work?
The API uses OAuth 2.0 Client Credentials. You exchange a client ID and secret for an access token, then send that token as a Bearer token on every request. See the Technical Information page for token URLs and example requests.
Are there any rate limits?
There are no rate limits enforced on this API today.
How fresh is the data?
Roster data is refreshed from the TUI crew tracking system approximately every five minutes. The API response reflects information that is roughly five minutes behind the live source.
Are there any notable constraints?
This API is for back-office use only. It is not intended for crew-facing applications, because it returns both published and unpublished duties.
Parameters
What does the owner parameter mean?
owner identifies the airline the roster is applicable for. Valid values are JAF, TFL, TUI, and BAL. Note that BLX and TOM are both grouped under BAL.
What does activityType filter on?
activityType lets you filter duties by category. The main codes are F (Flying), V (Vacancy), P (Proceeding, transport or hotel), R (Request), C (Check), T (Training), N (Non-Flying Activity), S (Simulator), and I (Meta-Roles). You can pass multiple values to include more than one category.
What does dutySheetVersionLatest do?
On the duty sheet endpoints, dutySheetVersionLatest switches between the initial duty sheet (Duty Sheet 0, the default) and the most recently published duty sheet version for the requested period.
What does responseFile do?
responseFile is a boolean. When set to true, the results are written to a file instead of being returned directly in the response body, and you get a link to retrieve them. See the Responses section below for details.
Responses
What happens with large responses?
If the result set is large, or if you explicitly set responseFile to true, the API stores the response in a file and returns a link to download it instead of the raw JSON body. See the Technical Information page for the size threshold and how long the download link stays valid.
What format are responses in?
All responses are JSON. Date and time fields use ISO 8601 format, and fields with no applicable value are omitted rather than returned as empty strings or "N/A".
Support
Who owns this API?
This API is owned and maintained by the AOPS Tech (airtech-integration) team.
How do I request a change?
Raise your request through https://tui-air-links.com so it can be triaged
