Skip to content
russellporter edited this page Apr 19, 2013 · 17 revisions

API

WhyJustRun has many API's, mostly based on the IOF XML Standard.

Entry List

Entry list is available in the IOF XML 3.0 Standard.

http://whyjustrun.ca/iof/3.0/events/#{event_id}/entry_list.xml

Start List

Start list is available in the IOF XML 2.0.3 Standard.

http://whyjustrun.ca/iof/2.0.3/events/#{event_id}/start_list.xml

Result List

GET

Result list is available in the IOF XML 2.0.3 and 3.0 Standards.

http://whyjustrun.ca/iof/3.0/events/#{event_id}/result_list.xml

http://whyjustrun.ca/iof/2.0.3/events/#{event_id}/result_list.xml

POST

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.

http://whyjustrun.ca/iof/3.0/events/#{event_id}/result_list.xml

Organization List

Organization list is available in the IOF XML 3.0 Standard.

http://whyjustrun.ca/iof/3.0/organization_list.xml

All club's in the WhyJustRun system are listed.

Event List

A list of all events a given user is organizing (HTTP Basic Auth required) (available in both 2.0.3, 3.0)

http://whyjustrun.ca/iof/3.0/users/event_list.xml

A list of all events for a club

http://whyjustrun.ca/iof/3.0/clubs/#{club_id}/event_list.xml?start=#{start_utc_timestamp}&end=#{end_utc_timestamp}

The start and end times are UTC Unix timestamps

iCal Feed

A standard iCal feed for use with any calendaring software (Google Calendar, Outlook, iCal, etc). Has upcoming and recently past events, but won't have all past events for a club.

http://whyjustrun.ca/club/#{club_id}/events.ics

JSON Events List (FullCalendar compatible)

A JSON events feed designed for use with FullCalendar. Start and end GET parameters are UTC timestamps. Also provides description, latitude, longitude for events.

http://whyjustrun.ca/club/#{club_id}/events.json?start=#{start_utc_timestamp}&end=#{end_utc_timestamp}

Sample FullCalendar embed code:

$('#calendar').fullCalendar({
	events: 'http://whyjustrun.ca/club/#{club_id}/events.json'
});