-
Notifications
You must be signed in to change notification settings - Fork 4
WhyJustRun has many API's, mostly based on the IOF XML Standard.
Entry list is available in the IOF XML 3.0 Standard.
https://whyjustrun.ca/iof/3.0/events/#{event_id}/entry_list.xml
Start list is available in the IOF XML 2.0.3 Standard.
https://whyjustrun.ca/iof/2.0.3/events/#{event_id}/start_list.xml
Result list is available in the IOF XML 2.0.3 and 3.0 Standards.
https://whyjustrun.ca/iof/3.0/events/#{event_id}/result_list.xml
https://whyjustrun.ca/iof/2.0.3/events/#{event_id}/result_list.xml
Write access is also available for IOF XML 3.0, in order to post event results to WhyJustRun. To send results to WhyJustRun, send the Result List XML in the body of an HTTP POST request to the below URL. HTTP Basic Auth is used for authenticating your WhyJustRun account.
NOTE: this will overwrite pre-existing results for the event. Additionally, providing the User id is recommended: if there are multiple users in WhyJustRun with the same name, without the User id, live results posting will fail.
https://whyjustrun.ca/iof/3.0/events/#{event_id}/result_list.xml
You can upload live results for an event via a POST request to:
https://whyjustrun.ca/iof/3.0/events/#{event_id}/live_result_list.xml
Fetch the live results with a GET request
https://whyjustrun.ca/iof/3.0/events/#{event_id}/live_result_list.xml
Organization list is available in the IOF XML 3.0 Standard.
https://whyjustrun.ca/iof/3.0/organization_list.xml
All club's in the WhyJustRun system are listed.
A competitor list is available in the IOF XML 3.0 Standard. This is handy for importing into your results software.
https://whyjustrun.ca/iof/3.0/competitor_list.xml
All registered users in the WhyJustRun system are listed.
- IOF XML 3.0 (
.xml) (use URL parameteriof_version=3.0) - IOF XML 2.0.3 (
.xml) (use URL parameteriof_version=2.0.3) - Full Calendar JSON (
.json) - iCal (
.ics)
(use the file extension to select the format)
These are URL parameters - all parameters are optional.
-
start,endtimes (UTC Unix timestamps) -
club_id(find events within a club) -
club_events(default:all) (options:none,significant,all) (you must specify aclub_idfor this parameter to take effect) -
external_significant_events(default:none) (options:none,all) - use to include events from other clubs that the members of the club may be interested (you must specify aclub_idfor this parameter to take effect) -
prefix_club_acronym(default:false) (options:true,false,external_only) - add the club acronym to the beginning of the event name -
iof_version(options:2.0.3,3.0) (required when using IOF xml format)
The list will be sorted in ascending order of start date.
https://whyjustrun.ca/events.{format}?start=###&end=###&club_id=##
A standard iCal feed for use with any calendaring software (Google Calendar, Outlook, iCal, etc). Has all events ever organized by a club.
webcal://whyjustrun.ca/club/#{club_id}/events.ics
Can also use https as the protocol if you don't need the webcal protocol handler.
A JSON events feed designed for use with FullCalendar. Start and end GET parameters are UTC timestamps. Also provides description, latitude, longitude for events.
The list will be sorted in ascending order of start date.
https://whyjustrun.ca/club/#{club_id}/events.json?start=#{start_utc_timestamp}&end=#{end_utc_timestamp}
Sample FullCalendar embed code:
$('#calendar').fullCalendar({
events: 'https://whyjustrun.ca/club/#{club_id}/events.json'
});