API documentation

Some of our data is available via a publicly accessible JSON API

Calendar

Read calendar items

Returns a list of calendar items with brief details about each

GET

/calendar/items/?filters

Request parameters

Field	Type	Required	Description
when	string	optional	Filter by time period. Values: past or future
type	string or integer	optional	Filter by item type. Values: (see calendar item types - view)

Response parameters

Field	Type	Description
	object[ ]	Object array
calendar_id	integer	The calendar item ID
start_date	date	Start date
modified	datetime	Time of most recent modification
name	string	Name
uri	string	API URI to get more details

Read calendar item types

Returns a list of calendar item types

GET

View

/calendar/types/

Request parameters

None

Response parameters

Field	Type	Description
	object[ ]	Object array
type	integer	Type ID
typename	string	Type name

Read calendar item

Returns detailed information about a particular item in the calendar

GET

View

/calendar/items/:id

Request parameters

Field	Type	Required	Description
id	integer	required	The calendar item ID

Response parameters

Field	Type	Description
calendar_id	integer	The calendar item ID
name	string	Name
location_name	string	Name of the place
location_lat	number	Location latitude
location_lon	number	Location longitude
location_zoom	integer	OpenStreetMap zoom level
location_marker	bool	Display a marker at the location. false indicates location is only approximate
start_date	date	Start date
start_time	time	Start time
end_date	date	End date
end_time	time	End time
club	string	Name of the organising club
item_type	string	Calendar item type
modified	datetime	Time of most recent modification
description	string	Item description
bof	object	Object containing BOF information
type	string	BOF item type: race or activity
id	integer	BOF item ID
links[ ]	object[ ]	List of hyperlinks (object array)
text	string	Hyperlink text
href	string	Hyperlink URI
type	string	Hyperlink type

Maps

Read map locations

Returns a list of our mapped areas and polygons showing the area

GET

View

/maps/

Request parameters

None

Response parameters

Field	Type	Description
	object[ ]	Object array
area	string	Area name
poly	string	EPSG:3857 (Web Mercator) polygon coordinates. String contains numeric array

British Orienteering

The British Orienteering website has an API, although it is somewhat limited. Unfortunately there is no documentation on the British Orienteering website, so details are being published here with the hope that they are useful to someone. Most of these details come from Paul Frost's post on Nopesport

Fixtures calendar

Returns a list of future fixtures with limited information about each one. It would appear that fixtures greater than one year into the future are not returned

GET

View

http://www.britishorienteering.org.uk/fixturesjson.php?filters

Request parameters

Field	Type	Required	Description
assoc	string	optional	Filter by regional orienteering association
club	string	optional	Filter by orienteering club. Comma separate to use several
level	string	optional	Filter by fixture level. Values: int a b c d act. Comma separate to use several

Other request parameters may exist but due to a complete lack of documentation by British Orienteering they are not known

Response parameters

Field	Type	Description
	object[ ]	Object array
date	date	Date of fixture
title	string	Fixture name
link	string	URI of fixture page on British Orienteering website
venue	string	Fixture location
nearest_town	string	Nearest town
grid_ref	string	OS Grid Reference
club	string	Organising orienteering club
assoc	string	Regional orienteering association
level	string	Fixture level
postcode	string	Fixture postcode
number	string	British Orienteering database ID

Fabian4

Fabian4 does not (yet?) offer an API. These methods fetch the entries list from the Fabian4 website, scrape the page to extract details and return it in JSON format. As a result of the fetching and processing required they are therefore very slow

Race entries

Returns a count of the number of entries, as a total and per course/class

GET

View

/fabian4/entries/:raceid/

GET

View

/fabian4/entries/:raceid/day/:daynumber/

Request parameters

Field	Type	Required	Description
raceid	integer	required	The Fabian4 race ID
daynumber	integer	optional	The day of the competition

Response parameters

Field	Type	Description
total	integer	Total number of entries for all days of a competition
day	string or integer	Either all or The day requested in the URI
entries	integer	Entries for the particular day (or all days if day not specified)
name	string	Name of the race as shown on Fabian4
courses	object	Object containing counts of the entries per course/class
course	integer	Entries on the course/class

Routegadget

Routegadget has a number of API methods available. There is no written documentation from Routegadget UK, but the API PHP source code is available on Github

Read races

This method is a bit pointless - see the read stats method instead

GET

View

http://www.cuoc.routegadget.co.uk/rg2/rg2api.php?type=events

Request parameters

Field	Type	Required	Description
type	string	required	Tell the API what type of information to return (events)

Response parameters

Field	Type	Description
data	object	Root object
events	object[ ]	Object array
id	integer	ID
mapid	integer	ID of map used
suffix	string	ID of map used
format	integer	Format (meaning unknown)
name	string	Name
date	date	Date
club	string	Organising club
type	string	Type (meaning unknown)
locked	bool	Lock status
comment	string	Description
API version	string	Current version of the API

Read stats

Returns a list of races

GET

View

http://www.cuoc.routegadget.co.uk/rg2/rg2api.php?type=stats

Request parameters

Field	Type	Required	Description
type	string	required	Tell the API what type of information to return (stats)

Response parameters

This method returns the same data as the Read races method, as well as some additional data

Field	Type	Description
data	object	Root object
events	object[ ]	Object array
results	integer	Number of results
courses	integer	Number of courses
routes	integer	Number of routes

Read courses

Returns a list of the courses, with control codes and coordinates

GET

View

http://www.cuoc.routegadget.co.uk/rg2/rg2api.php?type=courses&id=:id

Request parameters

Field	Type	Required	Description
type	string	required	Tell the API what type of information to return (courses)
id	integer	required	Race ID

Response parameters

Field	Type	Description
data	object	Root object
courses	object[ ]	Object array
course_id	integer	Course ID
name	string	Course name
codes	string[ ]	String array, containing control codes
xpos	integer[ ]	Integer array, containing control x-coordinates
ypos	integer[ ]	Integer array, containing control y-coordinates
API version	string	Current version of the API

Read results

Returns a list of results, with splits times

GET

View

http://www.cuoc.routegadget.co.uk/rg2/rg2api.php?type=results&id=:id

Request parameters

Field	Type	Required	Description
type	string	required	Tell the API what type of information to return (results)
id	integer	required	Race ID

Response parameters

Field	Type	Description
data	object	Root object
results	object[ ]	Object array
resultid	integer	Course ID
courseid	integer	Course ID
coursename	string	Course name
name	string	Competitor name
starttime	integer	Start time (seconds after midnight)
position	string	Empty string ""
status	string	Empty string ""
time	time or string	Finish time or Indication of course non-completion
splits	integer[ ]	Integer array, containing splits times in seconds
API version	string	Current version of the API

Read maps

Returns a list of maps

GET

View

http://www.cuoc.routegadget.co.uk/rg2/rg2api.php?type=maps

Request parameters

Field	Type	Required	Description
type	string	required	Tell the API what type of information to return (maps)

Response parameters

Field	Type	Description
data	object	Root object
maps	object[ ]	Object array
mapid	integer	Map ID
name	string	Map name
georeferenced	bool	Map georeferenced
API version	string	Current version of the API

Read tracks

Returns a list of tracks

GET

View

http://www.cuoc.routegadget.co.uk/rg2/rg2api.php?type=tracks&id=:id

Request parameters

Field	Type	Required	Description
type	string	required	Tell the API what type of information to return (tracks)
id	integer	required	Race ID

Response parameters

Field	Type	Description
data	object	Root object
routes	object[ ]	Object array
id	integer	Result ID (corresponds to resultid in read results)
y	string	String of comma separated values containing route y-coordinates. First coordinate is absolute, the rest are relative to the previous coordinate
x	string	String of comma separated values containing route x-coordinates. First coordinate is absolute, the rest are relative to the previous coordinate
API version	string	Current version of the API