International Orienteering Federation

Documentation for API methods

This page lists the service methods exposed by the Eventor API. More information about the API is found in <a class="external" href="/Documents/Guide_Eventor_-_Get_data_via_API.pdf">the Eventor API documentation</a>.

GET https://eventor.orienteering.org/api/events

Returns a list with the events matching the search parameters.

Query parameters
Name
Req
Default Description
fromDate 0000-01-01 00:00:00 Start time (yyyy-mm-dd hh:mm:ss).
toDate 9999-12-31 23:59:59 End time (yyyy-mm-dd hh:mm:ss).
fromModifyDate 0000-01-01 00:00:00 Includes only events that have changed after this time (yyyy-mm-dd hh:mm:ss).
toModifyDate 9999-12-31 23:59:59 Includes only events that have changed before this time (yyyy-mm-dd hh:mm:ss).
eventIds Comma-separated list of event IDs. Omit to include all events.
organisationIds Comma-separated list of organisation IDs for the organising clubs. If a state's organisation ID is specified, all events organised by a club in that state will be included. Omit to include all events.
classificationIds Comma-separated list of event classification IDs, where 1=championship event, 2=national event, 3=state event, 4=local event, 5=club event. Omit to include all events.
includeEntryBreaks false Set to true to include the entry deadlines of the event.
includeAttributes false Set to true to include the event's event attributes.
parentIds If filtering on parent events, comma-separated list of IDs for parent events.

Returned element

EventList

GET https://eventor.orienteering.org/api/events/iofxml

Returns a list with the events matching the search parameters.

Query parameters
Name
Req
Default Description
fromDate 0000-01-01 00:00:00 Start time (yyyy-mm-dd hh:mm:ss).
toDate 9999-12-31 23:59:59 End time (yyyy-mm-dd hh:mm:ss).
fromModifyDate 0000-01-01 00:00:00 Includes only events that have changed after this time (yyyy-mm-dd hh:mm:ss).
toModifyDate 9999-12-31 23:59:59 Includes only events that have changed before this time (yyyy-mm-dd hh:mm:ss).
eventIds Comma-separated list of event IDs. Omit to include all events.
eventRaceId The event race ID. Omit to include all events.
organisationIds Comma-separated list of organisation IDs for the organisiong clubs. If a state's organisation ID is specified, all events organised by a club in that state will be included. Omit to include all events.
classificationIds Comma-separated list of event classification IDs, where 1=championship event, 2=national event, 3=state event, 4=local event, 5=club event. Omit to include all events.
parentIds If filtering on parent events, comma-separated list of IDs for parent events.

Returned element

IOF XML 3.0 EventList

GET https://eventor.orienteering.org/api/events/documents

Returns a list with documents for the events matching the search parameters.

Query parameters
Name
Req
Default Description
fromDate 0000-01-01 00:00:00 Start time (yyyy-mm-dd hh:mm:ss).
toDate 9999-12-31 23:59:59 End time (yyyy-mm-dd hh:mm:ss).
eventIds Comma-separated list of event IDs. Omit to include all events.
organisationIds Comma-separated list of organisation IDs for the organising clubs. If a state's organisation ID is specified, all events organised by a club in that state will be included. Omit to include all events.

Returned element

DocumentList

GET https://eventor.orienteering.org/api/event/{eventId}

Returns an event.

Path parameters
Name
Req
Default Description
eventId yes The ID of the event as specified by /events.

Returned element

Event

GET https://eventor.orienteering.org/api/event/iofxml/{eventId}

Returns an event.

Path parameters
Name
Req
Default Description
eventId yes The ID of the event as specified by /events.

Returned element

IOF XML 3.0 EventList containing a single event

GET https://eventor.orienteering.org/api/eventclasses

Returns all classes in an event.

Query parameters
Name
Req
Default Description
eventId yes The ID of the event as specified by /events.
includeEntryFees Set to true to include IDs and application order for the entry fees of the classes.

Returned element

EventClassList

GET https://eventor.orienteering.org/api/entryfees/events/{eventId}

Returns all entry fees in an event.

Path parameters
Name
Req
Default Description
eventId yes The ID of the event as specified by /events.

Returned element

EntryFeeList

GET https://eventor.orienteering.org/api/organisation/apiKey

Returns the organisation that the specified API key belongs to.

Returned element

Organisation

GET https://eventor.orienteering.org/api/organisations

Returns a list with all organisations (federations, state associations and clubs).

Query parameters
Name
Req
Default Description
includeProperties false Set to true to include extended information about the organisations.

Returned element

OrganisationList

GET https://eventor.orienteering.org/api/organisations/iofxml

Returns a list with all organisations (federations, state associations and clubs).

Returned element

IOF XML 3.0 OrganisationList

GET https://eventor.orienteering.org/api/organisation/{id}

Returns an organisation (federation, state association or club).

Path parameters
Name
Req
Default Description
id yes The ID of the organisation.

Returned element

Organisation

GET https://eventor.orienteering.org/api/persons/organisations/{organisationId}

Returns all persons that are members of an organisation.

Path parameters
Name
Req
Default Description
organisationId yes The ID of the organisation as specified by /organisations. This parameter must be set to the own organisation's ID.
Query parameters
Name
Req
Default Description
includeContactDetails false Set to true to include the members' addresses, phone numbers and email addresses.

Returned element

PersonList

GET https://eventor.orienteering.org/api/competitors

Returns event settings (punching card numbers, pre-selected classes) for all persons that have specified these settings within an organisation.

Query parameters
Name
Req
Default Description
organisationId yes The ID of the organisation as specified by /organisations. This parameter must be set to the own organisation's ID.

Returned element

CompetitorList

GET https://eventor.orienteering.org/api/externalLoginUrl

Returns a link that can be used to redirect a person from an external website to logged-in mode in Eventor. The link can only be used once and is forfeited after five minutes. Useful when a club has a website solution with its own login system. Caution! Make sure to use this method in such a way that only authorized users in the external system will have access to the redirect link!

Query parameters
Name
Req
Default Description
personId yes The ID of the person as specified by /persons/organisations/{organisationId}. The person must be a member of the organisation specified by organisationId.
organisationId yes The ID of the organisation as specified by /organisations. This parameter must be set to the own organisation's ID.
includeContactDetails false Set to true to include the members' addresses, phone numbers and email addresses.

Returned element

ExternalLoginUrl

GET https://eventor.orienteering.org/api/authenticatePerson

Returns the person matching the specified user name and password.

Header parameters
Name
Req
Default Description
Username yes The person's user name i Eventor.
Password yes The person's password i Eventor.

Returned element

Person

GET https://eventor.orienteering.org/api/entries

Returns persons entered to an event as specified by the search parameters.

Query parameters
Name
Req
Default Description
organisationIds Comma-separated list with IDs as specified by /organisations for the organisation that entries is to be fetched for. Omit to include all organisations.
eventIds Comma-separated list with event IDs as specified by /events. Omit to include all events..
eventClassIds Comma-separated list with class IDs as specified by /eventclasses. Omit to include all classes.
fromEventDate 0000-01-01 00:00:00 Gets entries from events organised at this or later times (yyyy-mm-dd hh:mm:ss).
toEventDate 9999-12-31 23:59:59 Gets entries from events organised at this or earlier times (yyyy-mm-dd hh:mm:ss).
fromEntryDate 0000-01-01 00:00:00 Gets entries that are made at this time or later (yyyy-mm-dd hh:mm:ss).
toEntryDate 9999-12-31 23:59:59 Gets entries that are made at this time or earlier (yyyy-mm-dd hh:mm:ss).
fromModifyDate 0000-01-01 00:00:00 Gets entries that have changed at this time or later (yyyy-mm-dd hh:mm:ss).
toModifyDate 9999-12-31 23:59:59 Gets entries that are changed at this time or earlier (yyyy-mm-dd hh:mm:ss).
includeEntryFees false Set to true to include entry fee information.
includePersonElement false Set to true to include complete person information insted of just a person ID.
includeOrganisationElement false Set to true to include complete organisation information insted of just an organisation ID.
includeEventElement false Set to true to include complete event information insted of just an event ID.

Returned element

EntryList

GET https://eventor.orienteering.org/api/competitorcount

Returns the number of entries as given by the search parameters.

Query parameters
Name
Req
Default Description
organisationIds yes Comma-separated list with organisation IDs as specified by /organisations for the organisations that entries are to be fetched for.
eventIds Comma-separated list with event IDs as specified by /events. Omit to include all events.
personIds Comma-separated list with personIDs as specified by /persons/organisations/{organisationId}. The persons must be members in the organisation specified by organisationIds.

Returned element

CompetitorCountList

GET https://eventor.orienteering.org/api/starts/event

Returns start times for an event.

Query parameters
Name
Req
Default Description
eventId Event ID as specified by /events.

Returned element

StartList

GET https://eventor.orienteering.org/api/starts/event/iofxml

Returns start times for an event.

Query parameters
Name
Req
Default Description
eventId Event ID as specified by /events.

Returned element

IOF XML 3.0 StartList

GET https://eventor.orienteering.org/api/starts/person

Returns start times for a person in a number of events.

Query parameters
Name
Req
Default Description
personId Person ID as specified by /persons/organisations/{organisationId}.
eventIds Comma-separated list with event IDs as specified by /events. Omit to include all events.
fromDate 0000-01-01 00:00:00 Includes events organised this or later times (yyyy-mm-dd hh:mm:ss).
toDate 9999-12-31 23:59:59 Includes events organised this or earlier times (yyyy-mm-dd hh:mm:ss).

Returned element

StartListList

GET https://eventor.orienteering.org/api/starts/organisation

Returns start times for an organisation's (club's) competitors in an event.

Query parameters
Name
Req
Default Description
organisationIds yes Comma-separated list with IDs as specified by /organisations for the organisations that start times are to be fetched for. This parameter must be set to the own organisation's ID.
eventId Tävlings-id as specified by /events.

Returned element

StartList

GET https://eventor.orienteering.org/api/results/event

Returns results for an event.

Query parameters
Name
Req
Default Description
eventId The event ID as specified by /events.
includeSplitTimes Set to true to include split times.
top Only returns this number of competitors from the top of the result list. Omit to include all competitors.

Returned element

ResultList

GET https://eventor.orienteering.org/api/results/event/iofxml

Returns results for an event.

Query parameters
Name
Req
Default Description
eventId The event ID as specified by /events.
includeSplitTimes Set to true to include split times.

Returned element

IOF XML 3.0 ResultList

GET https://eventor.orienteering.org/api/results/person

Returns results for a person in a number of events.

Query parameters
Name
Req
Default Description
personId Person ID as specified by /persons/organisations/{organisationId}.
eventIds Comma-separated list with event IDs as specified by /events. Omit to include all events.
fromDate 0000-01-01 00:00:00 Includes events organised this or later times (yyyy-mm-dd hh:mm:ss).
toDate 9999-12-31 23:59:59 Includes events organised this or earlier times (yyyy-mm-dd hh:mm:ss).
includeSplitTimes Set to true to include split times.
top Returns, besides the specified person, only this number of competitors from the top of the result list. Omit to include the specified person only.

Returned element

ResultListList

GET https://eventor.orienteering.org/api/results/organisation

Returns results for an organisation's (club's) competitors in an event.

Query parameters
Name
Req
Default Description
organisationIds yes Comma-separated list with IDs as specified by /organisations for the organisations that start times are to be fetched for. This parameter must be set to the own organisation's ID.
eventId Tävlings-id as specified by /events.
includeSplitTimes Set to true to include split times.
top Returns, besides the specified organisation's competitors, only this number of competitors from the top of each class' result list. Omit to include the specified organisation's comeptitors only.

Returned element

ResultList

GET https://eventor.orienteering.org/api/activities

Returns all activities for an organisation (club) in a given period of time.

Query parameters
Name
Req
Default Description
organisationId yes The ID of the organisation as specified by /organisations. This parameter must be set to the own organisation's ID.
from yes The start of the time period (yyyy-mm-dd hh:mm:ss).
to yes The end of the time period (yyyy-mm-dd hh:mm:ss).
includeRegistrations false Set to true to include registrastions for the activities.

Returned element

ActivityList

GET https://eventor.orienteering.org/api/activity

Returns an activity.

Query parameters
Name
Req
Default Description
organisationId yes The ID of the organisation as specified by /organisations. This parameter must be set to the own organisation's ID.
id yes The ID of the activity as specified by by /activities.
includeRegistrations false Set to true to include registrastions for the activities.

Returned element

Activity

GET https://eventor.orienteering.org/api/competitor/{personId}

Returns a person's event settings (e.g. pre-selected classes and punching card numbers).

Path parameters
Name
Req
Default Description
personId yes The ID of the person as specified by /persons/organisations/{organisationId}. The person must be a member of the organisation whose API key is used.

Returned element

Competitor

PUT https://eventor.orienteering.org/api/competitor

Saves a person's event settings (e.g. pre-selected classes and punching card numbers).

Body-parameter
Element Description
Competitor The event settings for the person specified as a Competitor object. The person must be a member of the organisation whose API key is used.

Returned element

Competitor

Advertisements

OCAD
WOC 2019 Banner 2
Bryzos
Advertise Here!

Advertise HERE! Want to market your event? Or your orienteering product? Reach the world's orienteers with IOF Eventor! Contact iof@orienteering.org