Norsk Orientering

Dokumentasjon av API-metoder

Denne siden inneholder en liste med de servicemetoder som er tilgjengelig i Eventors API. Mer informasjon om API-et finnes i Eventors API-dokumentasjon.

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

Returnerer en liste med arrangementer som matcher søkeparameterne.

Query-parametere
Navn
Obl
 Standard Beskrivelse
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

Returnert element

EventList

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

Returnerer en liste med dokumenter fra arrangementer som matcher søkeparameterne.

Query-parametere
Navn
Obl
 Standard Beskrivelse
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.

Returnert element

DocumentList

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

Returnerer et arrangement.

Path-parametere
Navn
Obl
 Standard Beskrivelse
eventId ja Arrangementets ID som /events.

Returnert element

Event

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

Returnerer alle klasser i et arrangement.

Query-parametere
Navn
Obl
 Standard Beskrivelse
eventId ja Arrangementets ID som /events.
includeEntryFees Settes til true for å inkludere ID-en og tilpasning til klassenes påmeldingskontingenter.

Returnert element

EventClassList

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

Returnerer alle påmeldingskontingenter i et arrangement.

Path-parametere
Navn
Obl
 Standard Beskrivelse
eventId ja Arrangementets ID som /events.

Returnert element

EntryFeeList

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

Returnerer den organisasjonen som den gjeldende API-nøkkelen tilhører.

Returnert element

Organisation

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

Returnerer en liste med samtlige organisasjoner (forbund, kretser og klubber).

Query-parametere
Navn
Obl
 Standard Beskrivelse
includeProperties false Settes til true for å inkludere utvidet informasjon om organisasjonene.

Returnert element

OrganisationList

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

Returnerer en organisasjon (forbund, kretser og klubber).

Path-parametere
Navn
Obl
 Standard Beskrivelse
id ja Organisasjonens ID.

Returnert element

Organisation

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

Returnerer alle personer som er medlemmer i en organisasjon (forbund, krets eller klubb).

Path-parametere
Navn
Obl
 Standard Beskrivelse
organisationId ja Organisasjonens ID som /organisations. Denne parameteren må settes til den bestemte organisasjonens ID.
Query-parametere
Navn
Obl
 Standard Beskrivelse
includeContactDetails false Settes til true for å inkludere medlemmenes adresser, telefonnummer og e-postadresser.

Returnert element

PersonList

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

Returnerer arrangementsinnstillinger (brikkenr, valgt standardklasse) for alle personer som har angitt dette i en organisasjon.

Query-parametere
Navn
Obl
 Standard Beskrivelse
organisationId ja Organisasjonens ID som /organisations. Denne parameteren må settes til den bestemte organisasjonens ID.

Returnert 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!

Query-parametere
Navn
Obl
 Standard Beskrivelse
personId ja Personens ID som /persons/organisations/{organisationId}. Personen må være medlem i organisasjonen som angis av organisationId.
organisationId ja 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.

Returnert element

ExternalLoginUrl

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

Returnerer den personen som matcher oppgitt brukernavn og passord.

Header-parametere
Navn
Obl
 Standard Beskrivelse
Username ja Personens brukernavn i Eventor.
Password ja Personens passord i Eventor.

Returnert element

Person

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

Returnerer personer som er påmeldt til arrangementer etter søkeparameterne.

Query-parametere
Navn
Obl
 Standard Beskrivelse
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.

Returnert element

EntryList

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

Returnerer antallet arrangementspåmeldinger etter søkeparameterne.

Query-parametere
Navn
Obl
 Standard Beskrivelse
organisationIds ja 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.

Returnert element

CompetitorCountList

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

Returnerer starttider for et arrangement.

Query-parametere
Navn
Obl
 Standard Beskrivelse
eventId Arrangements-ID som /events.

Returnert element

StartList

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

Returnerer starttider for en person på et antall arrangementer.

Query-parametere
Navn
Obl
 Standard Beskrivelse
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).

Returnert element

StartListList

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

Returnerer starttider for en klubbs (organisasjons) deltagere i et arrangement.

Query-parametere
Navn
Obl
 Standard Beskrivelse
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.

Returnert element

StartList

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

Returnerer resultat for et arrangement.

Query-parametere
Navn
Obl
 Standard Beskrivelse
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.

Returnert element

ResultList

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

Returnerer resultat for en person på et antall arrangementer.

Query-parametere
Navn
Obl
 Standard Beskrivelse
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.

Returnert element

ResultListList

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

Returnerer resultat for en klubbs (organisasjons) deltagere i et arrangement.

Query-parametere
Navn
Obl
 Standard Beskrivelse
organisationIds ja 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.

Returnert element

ResultList

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

Returnerer alle aktiviteter for en klubb (organisasjon) i en gitt tidsperiode.

Query-parametere
Navn
Obl
 Standard Beskrivelse
organisationId ja Organisasjonens ID som /organisations. Denne parameteren må settes til den bestemte organisasjonens ID.
from ja Start på tidsperioden (åååå-mm-dd hh:mm:ss).
to ja Slutt på tidsperioden (åååå-mm-dd hh:mm:ss).
includeRegistrations false Sätt till true for å inkludere påmeldingene til aktivitetene.

Returnert element

ActivityList

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

Returnerar en aktivitet.

Query-parametere
Navn
Obl
 Standard Beskrivelse
organisationId ja Organisasjonens ID som /organisations. Denne parameteren må settes til den bestemte organisasjonens ID.
id ja Aktivitetens ID som /activities.
includeRegistrations false Settes til true for å inkludere påmeldinger til aktiviteten.

Returnert element

Activity

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

Returnerer en persons arrangementsinformasjon (f eks valgt standardklasse og brikkenr).

Path-parametere
Navn
Obl
 Standard Beskrivelse
personId ja Personens ID som /persons/organisations/{organisationId}. Personen må være medlem i den organisasjonen som API-nøkkelen tilhører.

Returnert element

Competitor

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

Lagrer en persons arrangementsinformasjon (f eks valgt standardklasse og brikkenr).

Body-parameter
Element Beskrivelse
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.

Returnert element

Competitor

Annonser

IOF Eventor