Svenska Orienteringsförbundet

Dokumentation för API-metoder

Denna sida innehåller en lista på de servicemetoder som exponeras i Eventors API. Mer information om API:et finns i <a class="external" href="/Documents/Guide_Eventor_-_Hamta_data_via_API.pdf">Eventors API-dokumentation</a>.

GET https://eventor.orientering.se/api/events

Returnerar en lista med tävlingar som matchar sökparametrarna.

Query-parametrar
Namn
Obl
Standard Beskrivning
fromDate 0000-01-01 00:00:00 Starttidpunkt (åååå-mm-dd hh:mm:ss).
toDate 9999-12-31 23:59:59 Sluttidpunkt (åååå-mm-dd hh:mm:ss).
fromModifyDate 0000-01-01 00:00:00 Inkluderar endast tävlingar som ändrats efter denna tidpunkt (åååå-mm-dd hh:mm:ss).
toModifyDate 9999-12-31 23:59:59 Inkluderar endast tävlingar som ändrats före denna tidpunkt (åååå-mm-dd hh:mm:ss).
eventIds Kommaseparerad lista med tävlings-id:n. Utelämna för att inkludera alla tävlingar.
organisationIds Kommaseparerad lista med organisations-id:n för arrangörsklubbarna. Om ett distrikts organisations-id anges kommer alla tävlingar som arrangeras av en klubb i distriktet att inkluderas. Utelämna för att inkludera alla tävlingar.
classificationIds Kommaseparerad lista med tävlingstyps-id:n, där 1=mästerskapstävling, 2=nationell tävling, 3=distriktstävling, 4=närtävling, 5=klubbtävling, 6=internationell tävling. Utelämna för att inkludera alla tävlingar.
includeEntryBreaks false Sätt till true för att inkludera tävlingens anmälningsstopp.
includeAttributes false Sätt till true för att inkludera tävlingens tävlingsattribut.

Returnerat element

EventList

GET https://eventor.orientering.se/api/events/documents

Returnerar en lista med dokument för tävlingar som matchar sökparametrarna.

Query-parametrar
Namn
Obl
Standard Beskrivning
fromDate 0000-01-01 00:00:00 Starttidpunkt (åååå-mm-dd hh:mm:ss).
toDate 9999-12-31 23:59:59 Sluttidpunkt (åååå-mm-dd hh:mm:ss).
eventIds Kommaseparerad lista med tävlings-id:n. Utelämna för att inkludera alla tävlingar.
organisationIds Kommaseparerad lista med organisations-id:n för arrangörsklubbarna. Om ett distrikts organisations-id anges kommer alla tävlingar som arrangeras av en klubb i distriktet att inkluderas. Utelämna för att inkludera alla tävlingar.

Returnerat element

DocumentList

GET https://eventor.orientering.se/api/event/{eventId}

Returnerar en tävling.

Path-parametrar
Namn
Obl
Standard Beskrivning
eventId ja Tävlingens id enligt /events.

Returnerat element

Event

GET https://eventor.orientering.se/api/eventclasses

Returnerar alla klasser i en tävling.

Query-parametrar
Namn
Obl
Standard Beskrivning
eventId ja Tävlingens id enligt /events.
includeEntryFees Sätt till true för att inkludera id:n och tillämpningsordning för klassernas anmälningsavgifter.

Returnerat element

EventClassList

GET https://eventor.orientering.se/api/entryfees/events/{eventId}

Returnerar alla anmälningsavgifter i en tävling.

Path-parametrar
Namn
Obl
Standard Beskrivning
eventId ja Tävlingens id enligt /events.

Returnerat element

EntryFeeList

GET https://eventor.orientering.se/api/organisation/apiKey

Returnerar den organisation som den använda api-nyckeln tillhör.

Returnerat element

Organisation

GET https://eventor.orientering.se/api/organisations

Returnerar en lista med samtliga organisationer (förbund, distriktsförbund och klubbar).

Query-parametrar
Namn
Obl
Standard Beskrivning
includeProperties false Sätt till true för att inkludera utökad information om organisationerna.

Returnerat element

OrganisationList

GET https://eventor.orientering.se/api/organisation/{id}

Returnerar en organisation (förbund, distriktsförbund och klubbar).

Path-parametrar
Namn
Obl
Standard Beskrivning
id ja Organisationens id.

Returnerat element

Organisation

GET https://eventor.orientering.se/api/persons/organisations/{organisationId}

Returnerar alla personer som är medlemmar i en organisation.

Path-parametrar
Namn
Obl
Standard Beskrivning
organisationId ja Organisationens id enligt /organisations. Denna parameter måste sättas till den egna organisationens id.
Query-parametrar
Namn
Obl
Standard Beskrivning
includeContactDetails false Sätt till true för att inkludera medlemmarnas adresser, telefonnummer och e-postadresser.

Returnerat element

PersonList

GET https://eventor.orientering.se/api/competitors

Returnerar tävlingsinställningar (bricknummer, förvalda klasser) för alla personer som angett detta i en organisation.

Query-parametrar
Namn
Obl
Standard Beskrivning
organisationId ja Organisationens id enligt /organisations. Denna parameter måste sättas till den egna organisationens id.

Returnerat element

CompetitorList

GET https://eventor.orientering.se/api/externalLoginUrl

Returnerar en länk som kan användas för att omdirigera en person från en extern sida till inloggat läge i Eventor. Länken kan bara användas vid ett tillfälle och förfaller efter fem minuter. Användbar i det fall klubben har en hemsidelösning med egen inloggning. Obs! Var noga med att använda denna metod på ett sådant sätt så att endast autentiserade användare i det externa systemet har tillgång till omdirigeringslänken!

Query-parametrar
Namn
Obl
Standard Beskrivning
personId ja Personens id enligt /persons/organisations/{organisationId}. Personen måste vara medlem i organisationen som anges av organisationId.
organisationId ja Organisationens id enligt /organisations. Denna parameter måste sättas till den egna organisationens id.
includeContactDetails false Sätt till true för att inkludera medlemmarnas adresser, telefonnummer och e-postadresser.

Returnerat element

ExternalLoginUrl

GET https://eventor.orientering.se/api/authenticatePerson

Returnerar den person som matchar givet användarnamn och lösenord.

Header-parametrar
Namn
Obl
Standard Beskrivning
Username ja Personens användarnamn i Eventor.
Password ja Personens lösenord i Eventor.

Returnerat element

Person

GET https://eventor.orientering.se/api/entries

Returnerar personer som anmälts till tävlingar enligt sökparametrarna.

Query-parametrar
Namn
Obl
Standard Beskrivning
organisationIds Kommaseparerad lista med id:n enligt /organisations för de organisationer som anmälningar ska hämtas för. Utelämna för att inkludera alla organisationer.
eventIds Kommaseparerad lista med tävlings-id:n enligt /events. Utelämna för att inkludera alla tävlingar.
eventClassIds Kommaseparerad lista med klass-id:n enligt /eventclasses. Utelämna för att inkludera alla klasser.
fromEventDate 0000-01-01 00:00:00 Hämtar anmälningar från tävlingar som arrangeras från denna eller senare tidpunkt (åååå-mm-dd hh:mm:ss).
toEventDate 9999-12-31 23:59:59 Hämtar anmälningar från tävlingar som arrangeras till denna eller tidigare tidpunkt (åååå-mm-dd hh:mm:ss).
fromEntryDate 0000-01-01 00:00:00 Hämtar anmälningar som gjorts denna eller senare tidpunkt (åååå-mm-dd hh:mm:ss).
toEntryDate 9999-12-31 23:59:59 Hämtar anmälningar som gjorts denna eller tidigare tidpunkt (åååå-mm-dd hh:mm:ss).
fromModifyDate 0000-01-01 00:00:00 Hämtar anmälningar som ändrats denna eller senare tidpunkt (åååå-mm-dd hh:mm:ss).
toModifyDate 9999-12-31 23:59:59 Hämtar anmälningar som ändrats denna eller tidigare tidpunkt (åååå-mm-dd hh:mm:ss).
includeEntryFees false Sätt till true för att inkludera information om anmälningsavgifter.
includePersonElement false Sätt till true för att inkludera fullständig personinformation i stället för enbart person-id.
includeOrganisationElement false Sätt till true för att inkludera fullständig organisationsinformation i stället för enbart organisations-id.
includeEventElement false Sätt till true för att inkludera fullständig tävlingsinformation i stället för enbart tävlings-id.

Returnerat element

EntryList

GET https://eventor.orientering.se/api/competitorcount

Returnerar antalet tävlingsanmälningar enligt sökparametrarna.

Query-parametrar
Namn
Obl
Standard Beskrivning
organisationIds ja Kommaseparerad lista med id:n enligt /organisations för de organisationer som anmälningar ska hämtas för.
eventIds Kommaseparerad lista med tävlings-id:n enligt /events. Utelämna för att inkludera alla tävlingar.
personIds Kommaseparerad lista med person-id:n enligt /persons/organisations/{organisationId}. Personerna måste vara medlemmar i organisationen som anges av organisationIds.

Returnerat element

CompetitorCountList

GET https://eventor.orientering.se/api/starts/event

Returnerar starttider för en tävling.

Query-parametrar
Namn
Obl
Standard Beskrivning
eventId Tävlings-id enligt /events.

Returnerat element

StartList

GET https://eventor.orientering.se/api/starts/event/iofxml

Returnerar starttider i IOF XML 3.0-format för en tävling.

Query-parametrar
Namn
Obl
Standard Beskrivning
eventId ja Tävlings-id enligt /events.
eventRaceId Etapp-id enligt /events.

Returnerat element

IOF XML 3.0 StartList

GET https://eventor.orientering.se/api/starts/person

Returnerar starttider för en person på ett antal tävlingar.

Query-parametrar
Namn
Obl
Standard Beskrivning
personId Person-id enligt /persons/organisations/{organisationId}.
eventIds Kommaseparerad lista med tävlings-id:n enligt /events. Utelämna för att inkludera alla tävlingar.
fromDate 0000-01-01 00:00:00 Inkluderar tävlingar som arrangeras från denna eller senare tidpunkt (åååå-mm-dd hh:mm:ss).
toDate 9999-12-31 23:59:59 Inkluderar tävlingar som arrangeras till denna eller tidigare tidpunkt (åååå-mm-dd hh:mm:ss).

Returnerat element

StartListList

GET https://eventor.orientering.se/api/starts/organisation

Returnerar starttider för en organisations (klubbs) deltagare på en tävling.

Query-parametrar
Namn
Obl
Standard Beskrivning
organisationIds ja Kommaseparerad lista med id:n enligt /organisations för de organisationer som starttider ska hämtas för. Denna parameter måste sättas till den egna organisationens id.
eventId Tävlings-id enligt /events.

Returnerat element

StartList

GET https://eventor.orientering.se/api/results/event

Returnerar resultat för en tävling.

Query-parametrar
Namn
Obl
Standard Beskrivning
eventId Tävlings-id enligt /events.
includeSplitTimes Sätt till true för att inkludera sträcktider.
top Returnerar endast detta antal deltagare från toppen av resultatlistan. Utelämna för att inkludera alla deltagare.

Returnerat element

ResultList

GET https://eventor.orientering.se/api/results/event/iofxml

Returnerar resultat i IOF XML 3.0-format för en tävling.

Query-parametrar
Namn
Obl
Standard Beskrivning
eventId ja Tävlings-id enligt /events.
eventRaceId Etapp-id enligt /events.
includeSplitTimes Sätt till true för att inkludera sträcktider.
totalResult Sätt till true för att returnera totalresultat om tävlingen är en fleretappstävling.

Returnerat element

IOF XML 3.0 ResultList

GET https://eventor.orientering.se/api/results/person

Returnerar resultat för en person på ett antal tävlingar.

Query-parametrar
Namn
Obl
Standard Beskrivning
personId Person-id enligt /persons/organisations/{organisationId}.
eventIds Kommaseparerad lista med tävlings-id:n enligt /events. Utelämna för att inkludera alla tävlingar.
fromDate 0000-01-01 00:00:00 Inkluderar tävlingar som arrangeras från denna eller senare tidpunkt (åååå-mm-dd hh:mm:ss).
toDate 9999-12-31 23:59:59 Inkluderar tävlingar som arrangeras till denna eller tidigare tidpunkt (åååå-mm-dd hh:mm:ss).
includeSplitTimes Sätt till true för att inkludera sträcktider.
top Returnerar, förutom den angivna personen, endast detta antal deltagare från toppen av resultatlistan. Utelämna för att inkludera endast den angivna personen.

Returnerat element

ResultListList

GET https://eventor.orientering.se/api/results/organisation

Returnerar resultat för en organisations (klubbs) deltagare på en tävling.

Query-parametrar
Namn
Obl
Standard Beskrivning
organisationIds ja Kommaseparerad lista med id:n enligt /organisations för de organisationer som resultat ska hämtas för. Denna parameter måste sättas till den egna organisationens id.
eventId Tävlings-id enligt /events.
includeSplitTimes Sätt till true för att inkludera sträcktider.
top Returnerar, förutom de angivna organisationernas deltagare, endast detta antal deltagare från toppen av varje klass resultatlista. Utelämna för att inkludera endast de angivna organisationernas deltagare.

Returnerat element

ResultList

GET https://eventor.orientering.se/api/activities

Returnerar alla aktiviteter för en organisation (klubb) i en viss tidsperiod.

Query-parametrar
Namn
Obl
Standard Beskrivning
organisationId ja Organisationens id enligt /organisations. Denna parameter måste sättas till den egna organisationens id.
from ja Start för tidsperioden (åååå-mm-dd 00:00:00).
to ja Slut för tidsperioden (åååå-mm-dd 23:59:59).
includeRegistrations false Sätt till true för att inkludera anmälningar till aktiviteterna.

Returnerat element

ActivityList

GET https://eventor.orientering.se/api/activity

Returnerar en aktivitet.

Query-parametrar
Namn
Obl
Standard Beskrivning
organisationId ja Organisationens id enligt /organisations. Denna parameter måste sättas till den egna organisationens id.
id ja Aktivitetens id enligt /activities.
includeRegistrations false Sätt till true för att inkludera anmälningar till aktiviteten.

Returnerat element

Activity

GET https://eventor.orientering.se/api/competitor/{personId}

Returnerar en persons tävlingsuppgifter (t ex förvalda klasser och bricknummer).

Path-parametrar
Namn
Obl
Standard Beskrivning
personId ja Personens id enligt /persons/organisations/{organisationId}. Personen måste vara medlem i organisationen vars API-nyckel används.

Returnerat element

Competitor

PUT https://eventor.orientering.se/api/competitor

Sparar en persons tävlingsuppgifter (t ex förvalda klasser och bricknummer).

Body-parameter
Element Beskrivning
Competitor Tävlingsuppgifterna för en person i form av ett Competitor-objekt. Personen måste vara medlem i organisationen vars API-nyckel används.

Returnerat element

Competitor

Annonser