From 0f320c046d91ef3afbe98297f34b67d9d890d001 Mon Sep 17 00:00:00 2001 From: jpsingleton Date: Mon, 27 Jul 2015 10:37:40 +0100 Subject: [PATCH] Update documentation for next and fastest boards and expand parameter --- src/Huxley/index.html | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/src/Huxley/index.html b/src/Huxley/index.html index acbc325..d9a9f75 100644 --- a/src/Huxley/index.html +++ b/src/Huxley/index.html @@ -83,13 +83,19 @@

API Endpoints

Station Boards

URL Format

- The URL format is {board}/{CRS|StationName}/{filterType}/{filterCRS|StationName}/{numRows} or {board}/{CRS|StationName}/{numRows} where only board and CRS (or a station name) are required. + The URL format is {board}/{CRS|StationName}/{filterType}/{filterCRS|StationName}/{numRows} or {board}/{CRS|StationName}/{numRows} (arrivals/departures only) where only board and CRS (or a station name) are required. The filter type can be either to or from (case is not important).

A station name can be used in place of CRS codes if the name matches only one station (or matches one exactly) but case is not important. See the CRS section below for more information.

+

+ For all boards you can add an expand=true parameter to embed all service details into the board response. +

+

+ /all/{CRS|StationName}?accessToken={Your GUID token}&expand=true +

Examples: