API changelog

Changes to requests, responses, allowed values and error codes of the SQUAKE API, newest first, with a short note on what each one means for your integration.

AddedDeprecated

Green Travel Pledge is now Green Travel Data

The Rail Delivery Group renamed the train methodology. Send GREEN-TRAVEL-DATA from now on. GREEN-TRAVEL-PLEDGE is still accepted and calculates the same way. See Green Travel Pledge Is Now Green Travel Data for details.

Changes
+
items[train].methodology value GREEN-TRAVEL-DATA
!
items[train].methodology value GREEN-TRAVEL-PLEDGE, still accepted
~
items[train].origin and destination must be CRS codes of GB National Rail stations, such as KGX
~
Error code green_travel_pledge_emission_not_found is now green_travel_data_emission_not_found
Changed

One status vocabulary for travel data trips

Trip status is no longer echoed as sent. SQUAKE maps whatever wording the source uses onto five values, and the trip's dates decide the value where they can.

Changes
~
status in responses is one of planned, confirmed, in_progress, completed, canceled or null
~
status in requests is still free text, mapped on ingestion; common wordings such as booked and cancelled are recognised
Added

Invitations endpoints

Invite users to one of your sub-clients and read an invitation back. Re-inviting the same email address for the same sub-client is safe and sends the email again.

Changes
+
POST /v2/invitations and GET /v2/invitations/{id}
+
Error code client_not_invitable (403) when client_id isn't one of your sub-clients

On this page