Following the launch of our app building competition – Project ‘My Journey’ – we have received a number of requests for additional information about the event. This post attempts to answer as many of those queries as possible. Whilst we are unable to provide an exact response to every question we have been asked, this blog post should provide enough detail to enable you to put together a strong and informed pitch.
Included in this blog post is a breakdown of the technical requirements for the data feed (HSP) along with the terms and conditions of entry to the competition. There is a lot of information in here, so brace yourself!!
The event is aimed specifically at independent developers and technology start-ups that are no larger than Micro Organisations by definition. Registrations from SMEs and large organisations will not be accepted. We have used the EU definition of SME to determine our criteria. To be eligible, your team must not represent an organisation or company with 10 or more employees or a turnover in excess of 2m Euros per annum. The employees of SMEs and large organisations, however, are welcome to apply independently of the company that they work for.
Historical Service Performance (HSP) API
There have been many queries about the HSP API, specifically the schema. Whilst we do not have a finalised schema as yet, I have included below a list of requirements which for the API service. The following requirements should give you an indication of the functionality of the API and the data that can be retrieved from it.
The HSP service will receive data from Darwin via a push port and will contain the last 6 months of push port data when launched.
The HSP interface will support the following request parameters. Request parameters will be mandatory unless indicated otherwise:
- Boarding location as CRS code
- Alighting location as CRS code
- Time Window
- Start time as HH:MM
- End time as HH:MM
- Date Range
- Start date as DD/MM/YYYY
- End Date as DD/MM/YYYY
- Day type, one of:
- Monday to Friday; or
- Saturday; or
- Zero or more Arrival tolerance values (optional)
- Specified as a whole number of minutes.
- Zero or more TOC code filters (optional)
- Specified as standard 2 character timetable TOC codes
- If omitted the response should contain all relevant services, otherwise the response should only contain services which match the specified TOC code filter(s)
The HSP interface will return appropriate error messages for invalid requests, including as a minimum:
- If the boarding location equals the alighting location
- If the end time is not greater than or equal to the start time
- If the end date is not greater than or equal to the start date
The HSP interface will support the following response fields (as a minimum) for each unique service within the requested time window:
- Origin of service
- Destination of service
- Boarding location, including publically Scheduled departure time
- Alighting location, including publically Scheduled arrival time
- Operator of service
- Historic Service Performance metrics for service:
- Number of matched services
- Number of ‘not Right Time’ services
- Right Time Historic Service Performance metric
- For each specified arrival tolerance value:
- Number of ‘disrupted’ services for that tolerance
- Historic Service Performance metric for that tolerance
The HSP interface will:
- conform to the standard JSON format
- be easily scalable to meet changing demand/volume needs
- be highly available and quick to respond (target c. 300ms or less)
- be able to support multiple versions (subject to future CRs)
- have no artificial limit on the number of approved users
- be secured (e.g. username/password or token) to ensure only approved users have access
- enable an encrypted transport protocol (e.g. https)
- provide user guide documentation to define access, content and usage (incl. examples)
- be available in both test and production environments
Additional detail will be provided in the user guide and schema when it is produced, however this will not be until after the competition.
Terms & Conditions of Entry
In final note, the following additional terms and conditions of entry apply to this competition:
The promoter of this competition is Train Information Services Ltd whose registered office is at 200 Aldersgate Street, London, EC1A 4HD.
Employees of ATOC Ltd or their family members or anyone else connected in any way with the competition or helping to set up the competition shall not be permitted to enter the competition.
The competition entry details can be found at https://digitalnationalrail.wordpress.com/. There is no entry fee and no purchase necessary to enter this competition.
The closing date for entry will be Monday 05 October 2015. After this date no further entries to the competition will be permitted. No responsibility can be accepted for entries not received for whatever reason.
The competition is open for registrations from individual developers and start-ups only. SMEs and large corporations will not be permitted under any circumstances.
We reserve the right to cancel or amend the competition and these terms and conditions without notice in the event of a catastrophe, war, civil or military disturbance, act of God or any actual or anticipated breach of any applicable law or regulation or any other event outside of the promoter’s control. Any changes to the competition will be notified to entrants as soon as possible.
The promoter is not responsible for inaccurate details supplied to any entrant by any third party connected with this competition.
Winners will be chosen by a panel of judges appointed by the Promoter and the winner will be notified by email and/or letter within 28 days of the closing date.
The promoter will notify the winner of the terms and condition under which funding will be allocated to build the digital tool.
The promoter’s decision in respect of all matters to do with the competition will be final and no correspondence will be entered into.
By entering this competition, an entrant is indicating his/her agreement to be bound by these terms and conditions.
The competition and these terms and conditions will be governed by English law and any disputes will be subject to the exclusive jurisdiction of the courts of England.
The winner agrees to the use of his/her name and image in any publicity material. Any personal data relating to the winner or any other entrants will be used solely in accordance with current UK data protection legislation and will not be disclosed to a third party without the entrant’s prior consent.
Details about the winning team name will be available 28 days after closing date and will be published online here.
Entry into the competition will be deemed as acceptance of these terms and conditions.
Categories: National Rail Enquiries