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.no/api/events
Returnerer en liste med arrangementer som matcher søkeparameterne.
Name | Req |
Default | Description |
fromDate |
0000-01-01 00:00:00 |
Starttidspunkt (åååå-mm-dd hh:mm:ss). | |
toDate |
9999-12-31 23:59:59 |
Sluttidspunkt (åååå-mm-dd hh:mm:ss). | |
fromModifyDate |
0000-01-01 00:00:00 |
||
toModifyDate |
9999-12-31 23:59:59 |
||
eventIds |
Kommaseparert liste med arrangements-ID. Kan utelates for å inkludere alle arrangement. | ||
organisationIds |
Kommaseparert liste med organisasjons-ID for arrangørklubbene. Hvis en krets' organisasjons-ID angis, vil alle arrangementer i kretsen inkluderes. Kan utelates for å inkludere alle arrangementer. | ||
classificationIds |
Kommaseparert liste med arrangements-ID, der 1=mesterskap, 2=nasjonalt løp, 3=kretsløp, 4=nærløp, 5=klubbløp. Kan utelates for å inkludere alle arrangementer. | ||
includeEntryBreaks |
false |
Må settes til true for å inkludere arrangementets påmeldingsfrist. | |
includeAttributes |
false |
Returned element
EventList
GET https://eventor.orientering.no/api/events/documents
Returnerer en liste med dokumenter fra arrangementer som matcher søkeparameterne.
Name | Req |
Default | Description |
fromDate |
0000-01-01 00:00:00 |
Starttidspunkt (åååå-mm-dd hh:mm:ss). | |
toDate |
9999-12-31 23:59:59 |
Sluttidspunkt (åååå-mm-dd hh:mm:ss). | |
eventIds |
Kommaseparert liste med arrangements-ID. Kan utelates for å inkludere alle arrangement. | ||
organisationIds |
Kommaseparert liste med organisasjons-ID for arrangørklubbene. Hvis en krets' organisasjons-ID angis, vil alle arrangementer i kretsen inkluderes. Kan utelates for å inkludere alle arrangementer. |
Returned element
DocumentList
GET https://eventor.orientering.no/api/event/{eventId}
Returnerer et arrangement.
Name | Req |
Default | Description |
eventId |
yes |
Arrangementets ID som /events . |
Returned element
Event
GET https://eventor.orientering.no/api/eventclasses
Returnerer alle klasser i et arrangement.
Name | Req |
Default | Description |
eventId |
yes |
Arrangementets ID som /events . |
|
includeEntryFees |
Settes til true for å inkludere ID-en og tilpasning til klassenes påmeldingskontingenter. |
Returned element
EventClassList
GET https://eventor.orientering.no/api/entryfees/events/{eventId}
Returnerer alle påmeldingskontingenter i et arrangement.
Name | Req |
Default | Description |
eventId |
yes |
Arrangementets ID som /events . |
Returned element
EntryFeeList
GET https://eventor.orientering.no/api/organisation/apiKey
Returnerer den organisasjonen som den gjeldende API-nøkkelen tilhører.
Returned element
Organisation
GET https://eventor.orientering.no/api/organisations
Returnerer en liste med samtlige organisasjoner (forbund, kretser og klubber).
Name | Req |
Default | Description |
includeProperties |
false |
Settes til true for å inkludere utvidet informasjon om organisasjonene. |
Returned element
OrganisationList
GET https://eventor.orientering.no/api/organisation/{id}
Returnerer en organisasjon (forbund, kretser og klubber).
Name | Req |
Default | Description |
id |
yes |
Organisasjonens ID. |
Returned element
Organisation
GET https://eventor.orientering.no/api/persons/organisations/{organisationId}
Returnerer alle personer som er medlemmer i en organisasjon (forbund, krets eller klubb).
Name | Req |
Default | Description |
organisationId |
yes |
Organisasjonens ID som /organisations . Denne parameteren må settes til den bestemte organisasjonens ID. |
Name | Req |
Default | Description |
includeContactDetails |
false |
Settes til true for å inkludere medlemmenes adresser, telefonnummer og e-postadresser. |
|
includePersonProperties |
false |
Settes til true for å inkludere utvidet informasjon. |
|
includePersonIdentifiers |
false |
Settes til true for å inkludere en persons eksterne ID:n. |
Returned element
PersonList
GET https://eventor.orientering.no/api/competitors
Returnerer arrangementsinnstillinger (brikkenr, valgt standardklasse) for alle personer som har angitt dette i en organisasjon.
Name | Req |
Default | Description |
organisationId |
yes |
Organisasjonens ID som /organisations . Denne parameteren må settes til den bestemte organisasjonens ID. |
Returned element
CompetitorList
GET https://eventor.orientering.no/api/externalLoginUrl
Returnerer en lenke som kan brukes for å omdirigere den besøkende fra en ekstern webside til innlogget sted i Eventor. Lenken kan bare brukes i dette ene tilfellet og forfaller etter fem minutter. Kan brukes hvis klubben har en hjemmeside med innlogging. Obs! Vær nøye med å bruke denne metoden på en slik måte at det kun er verifiserte brukere i den eksterne websiden som har tilgang til omdirigeringslenken!
Name | Req |
Default | Description |
personId |
yes |
Personens ID som /persons/organisations/{organisationId} . Personen må være medlem i organisasjonen som angis av organisationId . |
|
organisationId |
yes |
Organisasjonens ID som /organisations . Denne parameteren må settes til den bestemte organisasjonens ID. |
|
includeContactDetails |
false |
Settes til true for å inkludere medlemmenes adresser, telefonnummer og e-postadresser. |
Returned element
ExternalLoginUrl
GET https://eventor.orientering.no/api/authenticatePerson
Returnerer den personen som matcher oppgitt brukernavn og passord.
Name | Req |
Default | Description |
Username |
yes |
Personens brukernavn i Eventor. | |
Password |
yes |
Personens passord i Eventor. |
Returned element
Person
GET https://eventor.orientering.no/api/entries
Returnerer personer som er påmeldt til arrangementer etter søkeparameterne.
Name | Req |
Default | Description |
organisationIds |
Kommaseparert liste med ID som /organisations for de organisasjoner som påmeldinger skal hentes for. Kan utelates for å inkludere alle organisasjoner. |
||
eventIds |
Kommaseparert liste med arrangements-ID som /events . Kan utelates for å inkludere alle arrangement. |
||
eventClassIds |
Kommaseparert liste med klasse-ID som /eventclasses . Kan utelates for å inkludere alle klasser. |
||
fromEventDate |
0000-01-01 00:00:00 |
Henter påmeldinger fra arrangementer som arrangeres på denne eller senere tidspunkt (åååå-mm-dd hh:mm:ss). | |
toEventDate |
9999-12-31 23:59:59 |
Henter påmeldinger fra arrangement som arrangeres på denne eller tidligere tidspunkt (åååå-mm-dd hh:mm:ss). | |
fromEntryDate |
0000-01-01 00:00:00 |
Henter påmeldinger som er gjort på denne eller senere tidspunkt (åååå-mm-dd hh:mm:ss). | |
toEntryDate |
9999-12-31 23:59:59 |
Henter påmeldinger som er gjort på denne eller tidligere tidspunkt (åååå-mm-dd hh:mm:ss). | |
fromModifyDate |
0000-01-01 00:00:00 |
Henter påmeldinger som er entret på denne eller senere tidspunkt (åååå-mm-dd hh:mm:ss). | |
toModifyDate |
9999-12-31 23:59:59 |
Henter påmeldinger som er endret på denne eller tidligere tidspunkt (åååå-mm-dd hh:mm:ss). | |
includeEntryFees |
false |
Settes til true for å inkludere informasjon om påmeldingskontingenter. |
|
includePersonElement |
false |
Settes til true for å inkludere fullstendig personinformasjon i stedet for bare person-ID. |
|
includeOrganisationElement |
false |
Settes til true for å inkludere fullstendig organisasjonsinformasjon i stedet for bare organisasjons-ID. |
|
includeEventElement |
false |
Settes til true for å inkludere fullstendig arrangementsinformasjon i stedet for bare arrangements-ID. |
Returned element
EntryList
GET https://eventor.orientering.no/api/competitorcount
Returnerer antallet arrangementspåmeldinger etter søkeparameterne.
Name | Req |
Default | Description |
organisationIds |
yes |
Kommaseparert liste med ID som /organisations for de organisasjoner som påmelding skal hentes for. |
|
eventIds |
Kommaseparert liste med arrangements-ID som /events . Kan utelates for å inkludere alle arrangement. |
||
personIds |
Kommaseparert liste med person-ID som /persons/organisations/{organisationId} . Personene må være medlemmer i organisasjonen som angis av organisationIds . |
Returned element
CompetitorCountList
GET https://eventor.orientering.no/api/starts/event
Returnerer starttider for et arrangement.
Name | Req |
Default | Description |
eventId |
Arrangements-ID som /events . |
Returned element
StartList
GET https://eventor.orientering.no/api/starts/person
Returnerer starttider for en person på et antall arrangementer.
Name | Req |
Default | Description |
personId |
Person-ID som /persons/organisations/{organisationId} . |
||
eventIds |
Kommaseparert liste med arrangements-ID som /events . Kan utelates for å inkludere alle arrangementer. |
||
fromDate |
0000-01-01 00:00:00 |
Inkluderer arrangementer som arrangeres på denne eller senere tidspunkt (åååå-mm-dd hh:mm:ss). | |
toDate |
9999-12-31 23:59:59 |
Inkluderer arrangementer som arrangeres på denne eller tidligere tidspunkt (åååå-mm-dd hh:mm:ss). |
Returned element
StartListList
GET https://eventor.orientering.no/api/starts/organisation
Returnerer starttider for en klubbs (organisasjons) deltagere i et arrangement.
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.no/api/results/event
Returnerer resultat for et arrangement.
Name | Req |
Default | Description |
eventId |
Arrangements-ID som /events . |
||
includeSplitTimes |
Settes til true for å inkludere strekktider. |
||
top |
Returnerer kun dette antall deltagere fra toppen av resultatlisten. Kan utelates for å inkludere alle deltagere. |
Returned element
ResultList
GET https://eventor.orientering.no/api/results/person
Returnerer resultat for en person på et antall arrangementer.
Name | Req |
Default | Description |
personId |
Person-ID som /persons/organisations/{organisationId} . |
||
eventIds |
Kommaseparert liste med arrangements-ID som /events . Kan utelates for å inkludere alle arrangement. |
||
fromDate |
0000-01-01 00:00:00 |
Inkluderer arrangementer som arrangeres på denne eller senere tidspunkt (åååå-mm-dd hh:mm:ss). | |
toDate |
9999-12-31 23:59:59 |
Inkluderer arrangementer som arrangeres på denne eller tidligere tidspunkt (åååå-mm-dd hh:mm:ss). | |
includeSplitTimes |
Settes til true for å inkludere strekktider. |
||
top |
Returnerer, foruten den angitte personen, kun dette antall deltagere fra toppen av resultatlisten. Kan utelates for å inkludere kun den angitte personen. |
Returned element
ResultListList
GET https://eventor.orientering.no/api/results/organisation
Returnerer resultat for en klubbs (organisasjons) deltagere i et arrangement.
Name | Req |
Default | Description |
organisationIds |
yes |
Kommaseparert liste med ID som /organisations for de klubber (organisasjoner) som resultat skal hentes for. Denne parameteren må settes til den bestemte organisasjonens ID. |
|
eventId |
Arrangements-ID som /events . |
||
includeSplitTimes |
Settes til true for å inkludere strekktider. |
||
top |
Returnerer, foruten de angitte organisasjonenes deltagere, kun dette antall deltagere fra toppen av resultatlisten. Kan utelates for å inkludere kun den angitte organisasjonens deltagere. |
Returned element
ResultList
GET https://eventor.orientering.no/api/activities
Returnerer alle aktiviteter for en klubb (organisasjon) i en gitt tidsperiode.
Name | Req |
Default | Description |
organisationId |
yes |
Organisasjonens ID som /organisations . Denne parameteren må settes til den bestemte organisasjonens ID. |
|
from |
yes |
Start på tidsperioden (åååå-mm-dd hh:mm:ss). | |
to |
yes |
Slutt på tidsperioden (åååå-mm-dd hh:mm:ss). | |
includeRegistrations |
false |
Sätt till true for å inkludere påmeldingene til aktivitetene. |
Returned element
ActivityList
GET https://eventor.orientering.no/api/activity
Returnerar en aktivitet.
Name | Req |
Default | Description |
organisationId |
yes |
Organisasjonens ID som /organisations . Denne parameteren må settes til den bestemte organisasjonens ID. |
|
id |
yes |
Aktivitetens ID som /activities . |
|
includeRegistrations |
false |
Settes til true for å inkludere påmeldinger til aktiviteten. |
Returned element
Activity
GET https://eventor.orientering.no/api/competitor/{competitorId}
Returnerer en persons arrangementsinformasjon (f eks valgt standardklasse og brikkenr). Merk at competitorId er en intern ID og ikke den offentlige personId.
Name | Req |
Default | Description |
competitorId |
yes |
Personens konkurranse-ID som /persons/organisations/{organisationId} . Personen må være medlem i den organisasjonen som API-nøkkelen tilhører. |
Returned element
Competitor
PUT https://eventor.orientering.no/api/competitor
Lagrer en persons arrangementsinformasjon (f eks valgt standardklasse og brikkenr).
Element | Description |
Competitor | Arrangementsinformasjon for en person i form av et Competitor-objekt. Personen må være medlem i den organisasjonen som API-nøkkelen tilhører. |
Returned element
Competitor