Departureboard
Tool for the departureboard API.
- Base URL:
https://api.departureboard.io/api/v2.0 - Auth:
bearer(pass your key via theapiKeyinput)
Operations
getarrivalsanddeparturesbycrs— GET /getArrivalsAndDeparturesByCRS/{CRS} — getArrivalsAndDeparturesByCRS is used to get a list of services arriving to and departing from a UK train station by the CRS (Computer Reservation System) code. This will typically return a list of train services, but will also return any replacement bus or ferry services that are in place.getarrivalsbycrs— GET /getArrivalsByCRS/{CRS} — getArrivalsByCRS is used to get a list of services arriving to a UK train station by the CRS (Computer Reservation System) code. This will typically return a list of train services, but will also return any replacement bus or ferry services that are in place.getdeparturesbycrs— GET /getDeparturesByCRS/{CRS} — getDeparturesByCRS is used to get a list of services departing from a UK train station by the CRS (Computer Reservation System) code. This will typically return a list of train services, but will also return any replacement bus or ferry services that are in place.getfastestdeparturesbycrs— GET /getFastestDeparturesByCRS/{CRS} — getFastestDeparturesByCRS is used to get the fastest next service running between two stations. Multiple destinations can be specified. This will typically return a single train service, but will also return a replacement bus or ferry service if in place.getnextdeparturesbycrs— GET /getNextDeparturesByCRS/{CRS} — getNextDeparturesByCRS is used to get the next service running between two stations. Multiple destinations can be specified. This will typically return a single train service, but will also return a replacement bus or ferry service if in place. This will return the next departures for each of the filterList stations specified. It may not return the fastest next service. To get the fastest next service use the getFastestDeparturesByCRS endpoint.getservicedetailsbyid— GET /getServiceDetailsByID/{serviceID} — getServiceDetailsByID is used to get information on a service, by the Service ID. This will typically return a train service, but will also return a bus and ferry services. The Service ID must be provided in the serviceIDUrlSafe format that is provided in the response for Arrival and Departure Boards. A service ID is specific to a station, and can only be looked up for a short time after a train/bus/ferry arrives at, or departs from a station. This is a National Rail limitation.
Inputs
apiKey— your departureboard API keyoperation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: getarrivalsanddeparturesbycrs
apiKey: <your key>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
apiKey |
string | yes | — | DEPRECATED — bind an API Key credential to the task with credentialName instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change. |
operation |
string | yes | — | One of: getarrivalsanddeparturesbycrs, getarrivalsbycrs, getdeparturesbycrs, getfastestdeparturesbycrs, getnextdeparturesbycrs, getservicedetailsbyid |
CRS |
string | no | — | Path parameter CRS (required by some operations). |
serviceID |
string | no | — | Path parameter serviceID (required by some operations). |
query |
string | no | — | Optional query params as a JSON object string, e.g. {"limit": 10}. |