Real Time Journey Planner: Difference between revisions
PeterHicks (talk | contribs) Change to passive voice |
|||
Line 1: | Line 1: | ||
== About == | == About == | ||
The Real Time Journey Planning (RTJP) service allows users to request journey and fare information from National Rail Enquiries' Online Journey Planner (OJP) service. This API provides the same journey planning functionality as found on the National Rail Enquiries website, including all of the advanced options. It also allows users to have additional options not available via the website, such as the ability to request journeys only (i.e. without fares) or to journey plan for earlier in the day. | |||
== Accessing the RTJP API == | == Accessing the RTJP API == | ||
OJP data feeds are made available under formal licence, requiring signature by both parties. To request a licence, please complete a licence request form and return it to | OJP data feeds are made available under formal licence, requiring signature by both parties. To request a licence, please complete a licence request form and return it to the licensing team at [mailto:nationalraildatafeeds@raildeliverygroup.com nationalraildatafeeds@raildeliverygroup.com]. | ||
When licensing the RTJP Webservice to 3rd parties | When licensing the RTJP Webservice to 3rd parties, RDG are obliged to include a licence condition stating that the RTJP Webservice must not be used in conjunction with ticket retailing capability on websites. This condition is imposed by the terms of their usage of a third party service. | ||
== OJP Usage Charges == | == OJP Usage Charges == | ||
The RTJP Webservice is charged on a transactional basis, with the rate being determined on a cost recovery basis. This means that | The RTJP Webservice is charged on a transactional basis, with the rate being determined on a cost recovery basis. This means that costs are passed on for usage of a third party journey planning service, without adding any additional charges. | ||
== Timetable Groups == | == Timetable Groups == |
Revision as of 21:37, 4 September 2018
About
The Real Time Journey Planning (RTJP) service allows users to request journey and fare information from National Rail Enquiries' Online Journey Planner (OJP) service. This API provides the same journey planning functionality as found on the National Rail Enquiries website, including all of the advanced options. It also allows users to have additional options not available via the website, such as the ability to request journeys only (i.e. without fares) or to journey plan for earlier in the day.
Accessing the RTJP API
OJP data feeds are made available under formal licence, requiring signature by both parties. To request a licence, please complete a licence request form and return it to the licensing team at nationalraildatafeeds@raildeliverygroup.com.
When licensing the RTJP Webservice to 3rd parties, RDG are obliged to include a licence condition stating that the RTJP Webservice must not be used in conjunction with ticket retailing capability on websites. This condition is imposed by the terms of their usage of a third party service.
OJP Usage Charges
The RTJP Webservice is charged on a transactional basis, with the rate being determined on a cost recovery basis. This means that costs are passed on for usage of a third party journey planning service, without adding any additional charges.
Timetable Groups
The third party journey planning service used by NRE includes the concept of timetable groups. Timetable groups are essentially aliases for multiple locations, allowing a single 'All Stations' group location to be used to submit multiple 'member' locations for journey planning purposes. For example, Coulsdon (All stations) timetable groups can be used to request journeys to/from Coulsdon South OR Coulsdon Town.
It is worth noting that as timetable groups are essentially just a shortcut to specifying multiple locations for journey planning purposes, they are completely independent and unrelated to fare groups (which may relate to tickets associated to the results of journey planning). Timetable groups may exist where there is no fare group equivalent (such as the Coulsdon example quoted above) or there may be a timetable group which shares a name with a fare group (e.g. London or Birmingham) but they may contain different member locations.
Timetable Groups
Group_id | Group_name | Group_id | Group_name | Group_id | Group_name | ||
---|---|---|---|---|---|---|---|
2 | Acton (All stations) | 3 | Allerton (All stations) | 4 | Ardrossan (All stations) | ||
5 | Ayr (All stations) | 6 | Barnes (All stations) | 7 | Barry (All stations) | ||
8 | Battersea (All stations) | 9 | Beckenham (All stations) | 10 | Bedford (All stations) | ||
11 | Bicester (All stations) | 12 | Birkenhead (All stations) | 13 | Birmingham (All stations) | ||
14 | Blackpool (All stations) | 15 | Bloxwich (All stations) | 16 | Bootle (All stations) | ||
17 | Bradford (All stations) | 18 | Brighton (All stations) | 19 | Bromborough (All stations) | ||
20 | Bromley (All stations) | 21 | Brondesbury (All stations) | 22 | Brundall (All stations) | ||
23 | Burscough (All stations) | 24 | Burnley (All stations) | 25 | Byfleet (All stations) | ||
26 | Canterbury (All stations) | 32 | Cardiff (All stations) | 33 | Catford (All stations) | ||
34 | Chessington (All stations) | 35 | Clapham (All stations) | 36 | Coatbridge (All stations) | ||
37 | Colchester (All stations) | 38 | Croydon (All stations) | 64 | Dorchester (All stations) | ||
65 | Dorking (All stations) | 66 | Dudley (All stations) | 67 | Dulwich (All stations) | ||
68 | Dumbarton (All stations) | 69 | Ealing (All stations) | 70 | Edenbridge (All stations) | ||
71 | Enfield (All stations) | 72 | Epsom (All stations) | 73 | Ewell (All stations) | ||
74 | Exeter (All stations) | 75 | Falkirk (All stations) | 76 | Falmouth (All stations) | ||
77 | Farnborough (All stations) | 78 | Folkestone (All stations) | 79 | Gainsborough (All stations) | ||
81 | Glasgow (All stations) | 82 | Greenford (All stations) | 83 | Greenock (All stations) | ||
84 | Grimsby (All stations) | 85 | Guildford (All stations) | 86 | Hackney (All stations) | ||
87 | Hamilton (All stations) | 88 | Hampstead (All stations) | 89 | Harlow (All stations) | ||
90 | Harringay (All stations) | 91 | Harrow (All stations) | 92 | Harwich (All stations) | ||
93 | Hawarden (All stations) | 94 | Heath (All stations) | 95 | Helensburgh (All stations) | ||
96 | Hertford (All stations) | 97 | Hillington (All stations) | 98 | Hyde (All stations) | ||
99 | Kentish Town (All stations) | 100 | Kenton (All stations) | 101 | Kiveton (All stations) | ||
102 | Kew (All stations) | 103 | Lelant (All stations) | 104 | Leyton (All stations) | ||
105 | Lichfield (All stations) | 106 | Liverpool (All stations) | 107 | Livingston (All stations) | ||
108 | Llanwrst (All stations) | 109 | Lymington (All stations) | 110 | Lympstone (All stations) | ||
111 | Maesteg (All stations) | 112 | Maidstone (All stations) | 113 | Malling (All stations) | ||
114 | Malvern (All stations) | 115 | Manchester (All stations) | 116 | Mansfield (All stations) | ||
117 | Matlock (All stations) | 118 | Newark (All stations) | 119 | Newbury (All stations) | ||
120 | New Cross (All stations) | 121 | Newhaven (All stations) | 122 | New Mills (All stations) | ||
123 | Norwood (All stations) | 124 | Oldham (All stations) | 125 | Oulton Broad (All stations) | ||
126 | Paisley (All stations) | 127 | Peckham (All stations) | 128 | Pembroke (All stations) | ||
129 | Penge (All stations) | 130 | Pevensey (All stations) | 131 | Pollokshaws (All stations) | ||
132 | Pollokshields (All stations) | 133 | Pontefract (All stations) | 134 | Portsmouth (All stations) | ||
135 | Prestwick (All stations) | 136 | Purley (All stations) | 137 | Reading (All stations) | ||
138 | Redcar (All stations) | 139 | Reddish (All stations) | 140 | Rugeley (All stations) | ||
141 | Ruislip (All stations) | 142 | Runcorn (All stations) | 143 | Ryde (All stations) | ||
144 | St Albans (All stations) | 145 | St Budeaux (All stations) | 146 | St Helens (All stations) | ||
147 | St Leonards (All stations) | 148 | Salford (All stations) | 150 | Smethwick (All stations) | ||
151 | Southampton (All stations) | 152 | Southend (All stations) | 153 | Stansted (All stations) | ||
154 | Stourbridge (All stations) | 155 | Streatham (All stations) | 156 | Sudbury (All stations) | ||
157 | Sutton (All stations) | 158 | Sydenham (All stations) | 159 | Thorne (All stations) | ||
160 | Tilbury (All stations) | 161 | Tottenham (All stations) | 162 | Trefforest (All stations) | ||
163 | Tyndrum (All stations) | 164 | Wakefield (All stations) | 165 | Wallasey (All stations) | ||
166 | Walthamstow (All stations) | 167 | Wandsworth (All stations) | 168 | Warrington (All stations) | ||
169 | Watford (All stations) | 170 | Welwyn (All stations) | 171 | Wembley (All stations) | ||
172 | Whyteleafe (All stations) | 173 | Wigan (All stations) | 174 | Wimbledon (All stations) | ||
175 | Windsor And Eton (All stations) | 176 | Winnersh (All stations) | 177 | Woolwich (All stations) | ||
178 | Worcester (All stations) | 179 | Worthing (All stations) | 180 | Wrexham (All stations) | ||
181 | Yeovil (All stations) | 182 | London (All stations) | 183 | Carlton (All stations) | ||
184 | Darlington (All stations) | 187 | Walton (All stations) | 191 | Bristol (All stations) | ||
193 | Heathrow (All stations) | 198 | Birmingham International (All stations) | 338 | London Zone 1 (All stations) | ||
340 | Buxton (All stations) | 342 | Southport (All stations) | 344 | Stratford-Upon-Avon (All stations) | ||
345 | Workington (All stations) | 350 | Luton (All stations) | 351 | Redditch (All stations) | ||
358 | Whitby (All stations) | 368 | Southease (All stations) | 371 | Tadworth (All stations) | ||
375 | Winchelsea (All stations) | 376 | Bishopstone (All stations) | 377 | Eridge (All stations) | ||
382 | Leigh (All stations) | 383 | Preston Park (All stations) | 384 | London Road (All stations) | ||
386 | Ashford International (All stations) | 398 | Dublin (All stations) | 399 | Rhoose (All stations) | ||
400 | Cardiff International Airport (All stations) | 401 | Belfast (All stations) | 403 | Dunfermline (All stations) | ||
405 | Heathrow T123 (All stations) | 406 | Heathrow Terminal 1 (All stations) | 407 | Heathrow Terminal 2 (All stations) | ||
408 | Heathrow Terminal 3 (All stations) | 409 | Heathrow Terminal 4 (All stations) | 411 | Kings Cross St Pancras (All stations) | ||
412 | Marple (All stations) | 413 | West_Hampstead (All stations) | 414 | London Zone U12 (All stations) | ||
415 | Corby (All stations) | 418 | Heathrow Terminal 5 (All stations) | 419 | Heathrow Rail (All stations) | ||
420 | Heathrow Bus (All stations) | 422 | London Zone U123 (All stations) | 423 | London Zone U1234 (All stations) | ||
424 | London Zone U12345 (All stations) | 425 | London Zone U123456 (All stations) | 426 | Heathrow T123 No Underground (All stations) | ||
427 | Heathrow Terminal 1 No Underground (All stations) | 428 | Heathrow Terminal 2 No Underground (All stations) | 429 | Heathrow Terminal 3 No Underground (All stations) | ||
430 | Heathrow Terminal 4 No Underground (All stations) | 431 | Heathrow Terminal 5 No Underground (All stations) | 432 | Coulsdon (All stations) | ||
433 | Birmingham No Bsw (All stations) |
Group Members
Group_id | Member_CRS | Group_id | Member_CRS | Group_id | Member_CRS | Group_id | Member_CRS | Group_id | Member_CRS | ||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2 | ACC | 2 | AML | 2 | SAT | 3 | LPY | 3 | WSA | ||||
4 | ADN | 4 | ADS | 4 | ASB | 5 | AYR | 5 | NOA | ||||
6 | BNI | 6 | BNS | 7 | BRY | 7 | BYD | 7 | BYI | ||||
8 | BAK | 8 | QRB | 9 | BEC | 9 | BKJ | 9 | NBC | ||||
10 | BDM | 10 | BSJ | 11 | BCS | 11 | BIT | 12 | BKC | ||||
12 | BKN | 12 | BKP | 12 | BKQ | 13 | BHM | 13 | BMO | ||||
13 | BSW | 14 | BPB | 14 | BPN | 14 | BPS | 15 | BLX | ||||
15 | BWN | 16 | BNW | 16 | BOT | 17 | BDI | 17 | BDQ | ||||
18 | BTN | 18 | LRB | 19 | BMR | 19 | BOM | 20 | BMN | ||||
20 | BMS | 21 | BSP | 21 | BSY | 22 | BDA | 22 | BGA | ||||
23 | BCB | 23 | BCJ | 24 | BNC | 24 | BUB | 24 | BYM | ||||
25 | BFN | 25 | WBY | 26 | CBE | 26 | CBW | 32 | CDB | ||||
32 | CDF | 32 | CDQ | 33 | CFB | 33 | CTF | 34 | CSN | ||||
34 | CSS | 35 | CLJ | 35 | CLP | 36 | CBC | 36 | CBS | ||||
37 | CET | 37 | COL | 38 | ECR | 38 | SCY | 38 | WCY | ||||
64 | DCH | 64 | DCW | 65 | DKG | 65 | DKT | 65 | DPD | ||||
66 | DDP | 66 | SAD | 67 | EDW | 67 | NDL | 67 | WDU | ||||
68 | DBC | 68 | DBE | 69 | EAL | 69 | WEA | 70 | EBR | ||||
70 | EBT | 71 | ENC | 71 | ENF | 71 | ENL | 72 | EPD | ||||
72 | EPS | 73 | EWE | 73 | EWW | 74 | EXC | 74 | EXD | ||||
74 | EXT | 75 | FKG | 75 | FKK | 76 | FAL | 76 | FMT | ||||
77 | FNB | 77 | FNN | 78 | FKC | 78 | FKW | 79 | GBL | ||||
79 | GNB | 81 | GLC | 81 | GLQ | 82 | GFD | 82 | SGN | ||||
83 | GKC | 83 | GKW | 84 | GMB | 84 | GMD | 85 | GLD | ||||
85 | LRD | 86 | HAC | 86 | HKC | 86 | HKW | 87 | HNC | ||||
87 | HNW | 88 | HDH | 88 | SOH | 88 | WHD | 88 | WHP | ||||
89 | HWM | 89 | HWN | 90 | HGY | 90 | HRY | 91 | HOH | ||||
91 | HRW | 91 | SDH | 91 | SUD | 92 | HPQ | 92 | HWC | ||||
93 | HWB | 93 | HWD | 94 | HHL | 94 | HLL | 95 | HLC | ||||
95 | HLU | 96 | HFE | 96 | HFN | 97 | HLE | 97 | HLW | ||||
98 | HYC | 98 | HYT | 98 | NWN | 99 | KTN | 99 | KTW | ||||
100 | KNT | 100 | SOK | 101 | KIV | 101 | KVP | 102 | KWB | ||||
102 | KWG | 103 | LEL | 103 | LTS | 104 | LEM | 104 | LER | ||||
105 | LIC | 105 | LTV | 106 | LIV | 106 | LVC | 106 | LVJ | ||||
106 | MRF | 107 | LSN | 107 | LVG | 108 | LWR | 108 | NLR | ||||
109 | LYP | 109 | LYT | 110 | LYC | 110 | LYM | 111 | MEW | ||||
111 | MST | 112 | MDB | 112 | MDE | 112 | MDW | 113 | EML | ||||
113 | WMA | 114 | GMV | 114 | MVL | 115 | MAN | 115 | MCO | ||||
115 | MCV | 116 | MFT | 116 | MSW | 117 | MAT | 117 | MTB | ||||
118 | NCT | 118 | NNG | 119 | NBY | 119 | NRC | 120 | NWX | ||||
120 | NXG | 121 | NVH | 121 | NVN | 122 | NMC | 122 | NMN | ||||
123 | NWD | 123 | WNW | 124 | OLM | 125 | OUN | 125 | OUS | ||||
126 | PCN | 126 | PYG | 126 | PYJ | 127 | PMR | 127 | QRP | ||||
128 | PMB | 128 | PMD | 129 | PNE | 129 | PNW | 130 | PEB | ||||
130 | PEV | 131 | PWE | 131 | PWW | 132 | PLE | 132 | PLW | ||||
133 | PFM | 133 | PFR | 133 | POT | 134 | FTN | 134 | PMH | ||||
134 | PMS | 135 | PRA | 135 | PTW | 136 | PUO | 136 | PUR | ||||
137 | RDG | 137 | RDW | 138 | RBS | 138 | RCC | 138 | RCE | ||||
139 | RDN | 139 | RDS | 140 | RGL | 140 | RGT | 141 | SRU | ||||
141 | WRU | 142 | RUE | 142 | RUN | 143 | RYD | 143 | RYP | ||||
143 | RYR | 143 | XRD | 144 | SAA | 144 | SAC | 145 | SBF | ||||
145 | SBV | 146 | SHJ | 146 | SNH | 147 | SLQ | 147 | WLD | ||||
148 | SFD | 148 | SLD | 150 | SGB | 150 | SMR | 151 | SOA | ||||
151 | SOU | 152 | SOC | 152 | SOV | 153 | SSD | 153 | SST | ||||
154 | SBJ | 154 | SBT | 155 | SRC | 155 | SRH | 155 | STE | ||||
156 | SDH | 156 | SUD | 157 | SUC | 157 | SUO | 157 | WSU | ||||
158 | LSY | 158 | SYD | 158 | SYH | 159 | TNN | 159 | TNS | ||||
160 | ETL | 160 | TBR | 160 | TIL | 161 | STO | 161 | SVS | ||||
161 | TOM | 162 | TRE | 162 | TRF | 163 | TYL | 163 | UTY | ||||
164 | WKF | 164 | WKK | 165 | WLG | 165 | WLV | 166 | SJS | ||||
166 | WHC | 166 | WMW | 166 | WST | 167 | WNT | 167 | WSW | ||||
167 | WWR | 168 | WAC | 168 | WBQ | 169 | WFH | 169 | WFJ | ||||
169 | WFN | 170 | WGC | 170 | WLW | 171 | NWB | 171 | WCX | ||||
171 | WMB | 172 | WHS | 172 | WHY | 173 | WGN | 173 | WGW | ||||
174 | WBO | 174 | WIM | 175 | WNC | 175 | WNR | 176 | WNS | ||||
176 | WTI | 177 | WWA | 177 | WWD | 178 | WOF | 178 | WOS | ||||
179 | EWR | 179 | WRH | 179 | WWO | 180 | WRX | 180 | WXC | ||||
181 | YVJ | 181 | YVP | 182 | BFR | 182 | CHX | 182 | CST | ||||
182 | CTK | 182 | EUS | 182 | FST | 182 | KGX | 182 | LBG | ||||
182 | LST | 182 | MOG | 182 | MYB | 182 | PAD | 182 | STP | ||||
182 | VIC | 182 | WAE | 182 | WAT | 183 | CTO | 183 | NET | ||||
184 | DAR | 184 | NRD | 187 | RIL | 187 | WAO | 191 | BPW | ||||
191 | BRI | 193 | HAF | 193 | HTR | 193 | HWA | 193 | HWE | ||||
193 | HWF | 193 | HWV | 193 | HXX | 193 | ZHJ | 198 | BHI | ||||
338 | BFR | 338 | CHX | 338 | CST | 338 | EUS | 338 | FST | ||||
338 | KGX | 338 | LBG | 338 | LST | 338 | MYB | 338 | PAD | ||||
338 | STP | 338 | VIC | 338 | WAT | 340 | BUX | 342 | SOP | ||||
344 | SAV | 345 | WKG | 350 | LTN | 350 | LUT | 351 | RDC | ||||
358 | WTB | 358 | WTZ | 368 | SEE | 368 | SEZ | 371 | TAD | ||||
371 | TTA | 375 | WSE | 376 | BIP | 377 | ERB | 377 | ERI | ||||
382 | LFL | 382 | LIH | 383 | PPR | 383 | PRP | 384 | LRB | ||||
384 | LRR | 386 | AFK | 386 | ASI | 398 | DBP | 398 | DCL | ||||
398 | DFP | 398 | DHT | 399 | RIA | 399 | XCF | 400 | RIA | ||||
400 | XCF | 401 | BFA | 401 | BFC | 403 | DFE | 403 | DFL | ||||
405 | HTR | 405 | HWA | 405 | HWE | 405 | HXX | 405 | ZHJ | ||||
406 | HTR | 406 | HXX | 406 | ZHJ | 407 | HTR | 407 | HWA | ||||
407 | HXX | 407 | ZHJ | 408 | HTR | 408 | HWE | 408 | HXX | ||||
408 | ZHJ | 409 | HAF | 409 | HWF | 409 | ZHJ | 411 | KGX | ||||
411 | STP | 412 | MPL | 412 | RSH | 413 | WHD | 413 | WHP | ||||
414 | BFR | 414 | CHX | 414 | CST | 414 | EUS | 414 | FST | ||||
414 | KGX | 414 | LBG | 414 | LST | 414 | MYB | 414 | PAD | ||||
414 | STP | 414 | VIC | 414 | WAT | 415 | CBZ | 415 | COR | ||||
418 | HWV | 418 | HWX | 419 | HAF | 419 | HWV | 419 | HXX | ||||
420 | HTR | 420 | HWA | 420 | HWE | 420 | HWF | 420 | HWX | ||||
422 | BFR | 422 | CHX | 422 | CST | 422 | EUS | 422 | FST | ||||
422 | KGX | 422 | LBG | 422 | LST | 422 | MYB | 422 | PAD | ||||
422 | STP | 422 | VIC | 422 | WAT | 423 | BFR | 423 | CHX | ||||
423 | CST | 423 | EUS | 423 | FST | 423 | KGX | 423 | LBG | ||||
423 | LST | 423 | MYB | 423 | PAD | 423 | STP | 423 | VIC | ||||
423 | WAT | 424 | BFR | 424 | CHX | 424 | CST | 424 | EUS | ||||
424 | FST | 424 | KGX | 424 | LBG | 424 | LST | 424 | MYB | ||||
424 | PAD | 424 | STP | 424 | VIC | 424 | WAT | 425 | BFR | ||||
425 | CHX | 425 | CST | 425 | EUS | 425 | FST | 425 | KGX | ||||
425 | LBG | 425 | LST | 425 | MYB | 425 | PAD | 425 | STP | ||||
425 | VIC | 425 | WAT | 426 | HTR | 426 | HWA | 426 | HWE | ||||
426 | HXX | 427 | HTR | 427 | HXX | 428 | HTR | 428 | HWA | ||||
428 | HXX | 429 | HTR | 429 | HWE | 429 | HXX | 430 | HAF | ||||
430 | HWF | 431 | HWV | 431 | HWX | 432 | CDN | 432 | CDS | ||||
433 | BHM | 433 | BMO |