Documentation for API methods
This page lists the service methods exposed by the Eventor API. More information about the API is found in the Eventor API documentation.
GET https://eventor.orientering.se/api/events
Returnerar en lista med tävlingar som matchar sökparametrarna.
| Name | Req |
Default | Description |
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. |
Returned element
EventList
GET https://eventor.orientering.se/api/events/documents
Returnerar en lista med dokument för tävlingar som matchar sökparametrarna.
| Name | Req |
Default | Description |
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. |
Returned element
DocumentList
GET https://eventor.orientering.se/api/event/{eventId}
Returnerar en tävling.
| Name | Req |
Default | Description |
eventId |
yes |
Tävlingens id enligt /events. |
Returned element
Event
GET https://eventor.orientering.se/api/eventclasses
Returnerar alla klasser i en tävling.
| Name | Req |
Default | Description |
eventId |
yes |
Tävlingens id enligt /events. |
|
includeEntryFees |
Sätt till true för att inkludera id:n och tillämpningsordning för klassernas anmälningsavgifter. |
Returned element
EventClassList
GET https://eventor.orientering.se/api/entryfees/events/{eventId}
Returnerar alla anmälningsavgifter i en tävling.
| Name | Req |
Default | Description |
eventId |
yes |
Tävlingens id enligt /events. |
Returned element
EntryFeeList
GET https://eventor.orientering.se/api/organisation/apiKey
Returnerar den organisation som den använda api-nyckeln tillhör.
Returned element
Organisation
GET https://eventor.orientering.se/api/organisations
Returnerar en lista med samtliga organisationer (förbund, distriktsförbund och klubbar).
| Name | Req |
Default | Description |
includeProperties |
false |
Sätt till true för att inkludera utökad information om organisationerna. |
Returned element
OrganisationList
GET https://eventor.orientering.se/api/organisation/{id}
Returnerar en organisation (förbund, distriktsförbund och klubbar).
| Name | Req |
Default | Description |
id |
yes |
Organisationens id. |
Returned element
Organisation
GET https://eventor.orientering.se/api/persons/organisations/{organisationId}
Returnerar alla personer som är medlemmar i en organisation.
| Name | Req |
Default | Description |
organisationId |
yes |
Organisationens id enligt /organisations. Denna parameter måste sättas till den egna organisationens id. |
| Name | Req |
Default | Description |
includeContactDetails |
false |
Sätt till true för att inkludera medlemmarnas adresser, telefonnummer och e-postadresser. |
|
includePersonProperties |
false |
Sätt till true för att inkludera utökad information. |
|
includePersonIdentifiers |
false |
Sätt till true för att inkludera en persons externa id:n. |
Returned 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.
| Name | Req |
Default | Description |
organisationId |
yes |
Organisationens id enligt /organisations. Denna parameter måste sättas till den egna organisationens id. |
Returned 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!
| Name | Req |
Default | Description |
personId |
yes |
Personens id enligt /persons/organisations/{organisationId}. Personen måste vara medlem i organisationen som anges av organisationId. |
|
organisationId |
yes |
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. |
Returned element
ExternalLoginUrl
GET https://eventor.orientering.se/api/authenticatePerson
Returnerar den person som matchar givet användarnamn och lösenord.
| Name | Req |
Default | Description |
Username |
yes |
Personens användarnamn i Eventor. | |
Password |
yes |
Personens lösenord i Eventor. |
Returned element
Person
GET https://eventor.orientering.se/api/entries
Returnerar personer som anmälts till tävlingar enligt sökparametrarna.
| Name | Req |
Default | Description |
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. |
Returned element
EntryList
GET https://eventor.orientering.se/api/competitorcount
Returnerar antalet tävlingsanmälningar enligt sökparametrarna.
| Name | Req |
Default | Description |
organisationIds |
yes |
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. |
Returned element
CompetitorCountList
GET https://eventor.orientering.se/api/starts/event
Returnerar starttider för en tävling.
| Name | Req |
Default | Description |
eventId |
Tävlings-id enligt /events. |
Returned element
StartList
GET https://eventor.orientering.se/api/starts/event/iofxml
Returnerar starttider i IOF XML 3.0-format för en tävling.
| Name | Req |
Default | Description |
eventId |
yes |
Tävlings-id enligt /events. |
|
eventRaceId |
Etapp-id enligt /events. |
Returned 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.
| Name | Req |
Default | Description |
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). |
Returned element
StartListList
GET https://eventor.orientering.se/api/starts/organisation
Returnerar starttider för en organisations (klubbs) deltagare på en tävling.
| Name | Req |
Default | Description |
organisationIds |
yes |
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. |
Returned element
StartList
GET https://eventor.orientering.se/api/results/event
Returnerar resultat för en tävling.
| Name | Req |
Default | Description |
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. |
Returned element
ResultList
GET https://eventor.orientering.se/api/results/event/iofxml
Returnerar resultat i IOF XML 3.0-format för en tävling.
| Name | Req |
Default | Description |
eventId |
yes |
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. |
Returned 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.
| Name | Req |
Default | Description |
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. |
Returned element
ResultListList
GET https://eventor.orientering.se/api/results/organisation
Returnerar resultat för en organisations (klubbs) deltagare på en tävling.
| Name | Req |
Default | Description |
organisationIds |
yes |
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. |
Returned element
ResultList
GET https://eventor.orientering.se/api/activities
Returnerar alla aktiviteter för en organisation (klubb) i en viss tidsperiod.
| Name | Req |
Default | Description |
organisationId |
yes |
Organisationens id enligt /organisations. Denna parameter måste sättas till den egna organisationens id. |
|
from |
yes |
Start för tidsperioden (åååå-mm-dd 00:00:00). | |
to |
yes |
Slut för tidsperioden (åååå-mm-dd 23:59:59). | |
includeRegistrations |
false |
Sätt till true för att inkludera anmälningar till aktiviteterna. |
Returned element
ActivityList
GET https://eventor.orientering.se/api/activity
Returnerar en aktivitet.
| Name | Req |
Default | Description |
organisationId |
yes |
Organisationens id enligt /organisations. Denna parameter måste sättas till den egna organisationens id. |
|
id |
yes |
Aktivitetens id enligt /activities. |
|
includeRegistrations |
false |
Sätt till true för att inkludera anmälningar till aktiviteten. |
Returned element
Activity
GET https://eventor.orientering.se/api/competitor/{competitorId}
Returnerar en persons tävlingsuppgifter (t ex förvalda klasser och bricknummer). Notera att competitiorId är ett internt ID och inte det publika personId.
| Name | Req |
Default | Description |
competitorId |
yes |
Personens tävlings id enligt /persons/organisations/{organisationId}. Personen måste vara medlem i organisationen vars API-nyckel används. |
Returned element
Competitor
PUT https://eventor.orientering.se/api/competitor
Sparar en persons tävlingsuppgifter (t ex förvalda klasser och bricknummer).
| Element | Description |
| 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. |
Returned element
Competitor