Logo

ORIS API

Není-li uvedeno jinak, je komunikace pomocí GET požadavku. Formát dat: json, xml.

Povinné parametry:
  - method: název metody, viz níže
  - format: formát dat, podporován je: xml, xml2, json (xml2 vrací stejné názvy XML nódů pro opakující se hodnoty)
  
Nepovinné parametry:
  - callback: pro json v případě cross domain volání (příklad zde)

Podporované metody:
  - getCSOSClubList - seznam všech klubů v ČSOS
        příklad: https://oris.orientacnisporty.cz/API/?format=xml&method=getCSOSClubList
                    
  - getClub         - informace o konkrétním klubu 
                        - povinné parametry:
                                  'id': číslo nebo zkratka klubu (viz getCSOSClubList)
                        - nepovinné parametry: 
                                  'eventkey': bezpečnostní klíč závodu pro kluby jednorázových přihlášek
        příklad: https://oris.orientacnisporty.cz/API/?format=json&method=getClub&id=1
 
  - getEventList    - kalendář závodů 
                        - nepovinné parametry: 
                                  'all':      pokud je nastaveno all=1 pak zobrazí i ostatní závody
                                              mimo oficiální kalendář
                                  'name':     část názvu závodu
                                  'sport':    id sportu ... 1=OB, 2=LOB, 3=MTBO, 4=TRAIL
                                              (lze zadat více hodnot oddělených čárkou)
                                  'rg':       zkratka regionu např. HA, P, MSK, ...
                                  'level':    id úrovně (lze zadat více hodnot oddělených čárkou)
                                  'datefrom': datum od ve formátu RRRR-MM-DD 
                                              (pokud není zadáno, pak se používá první den aktuálního roku)
                                  'dateto':   datum do ve formátu RRRR-MM-DD 
                                              (pokud není zadáno, pak se používá poslední den aktuálního roku)
                                  'club':     id pořádajícího klubu
                                  'myClubId': id klubu pro zobrazení počtu přihlášek a výsledků
        příklad: https://oris.orientacnisporty.cz/API/?format=xml&method=getEventList  
        lze použít i getEventListVersions se stejnými parametry (vrací pouze ID a verzi záznamu)  

  - getEvent         - kompletní informace o konkrétním závodu včetně kategorií
                        - povinné parametry:
                                  'id': ORIS id závodu (viz getEventList)
        příklad: https://oris.orientacnisporty.cz/API/?format=xml&method=getEvent&id=2252

  - getEventEntries - seznam přihlášek pro daný závod (možno i pro konkrétní kategorii)
                        - povinné parametry:
                                  'eventid': ORIS id závodu (viz getEventList)
                        - nepovinné parametry: 
                                  'classid': ORIS id kategorie
                                  'classname': název kategorie
                                  'clubid': číslo nebo zkratka klubu (viz getCSOSClubList) 
                                  /pozn. filtr na klub nelze kombinovat s kategorií
                                  'entrystop': termín přihlášek (číslo 1-3)
                                  'entrystopout': mimo termín přihlášek (číslo 1-3)
                        - nepovinné parametry (autorizace) pro zobrazení klubové poznámky: 
                                  'username':    přihlašovací jméno uživatele
                                  'password':    heslo uživatele
        příklad: https://oris.orientacnisporty.cz/API/?format=xml&method=getEventEntries&eventid=2077

  - getUserEventEntries - seznam přihlášek pro danou osobu
                        - povinné parametry:
                                  'userid': ORIS id osoby (viz getUser)
                        - nepovinné parametry: 
                                  'datefrom': datum od ve formátu RRRR-MM-DD 
                                  'dateto': datum do ve formátu RRRR-MM-DD
                        - nepovinné parametry (autorizace) pro zobrazení klubové poznámky: 
                                  'username':    přihlašovací jméno uživatele
                                  'password':    heslo uživatele
        příklad: https://oris.orientacnisporty.cz/API/?format=xml&method=getUserEventEntries&userid=224

  - getEventServiceEntries - seznam objednávek doplňkových služeb pro daný závod 
                        - povinné parametry:
                                  'eventid': ORIS id závodu (viz getEventList)
                        - nepovinné parametry: 
                                  'clubid': číslo nebo zkratka klubu (viz getCSOSClubList) 
        příklad: https://oris.orientacnisporty.cz/API/?format=xml&method=getEventServiceEntries&eventid=2320

  - getEventResults - seznam výsledků pro daný závod (možno i pro konkrétní kategorii)
                        - povinné parametry:
                                  'eventid': ORIS id závodu (viz getEventList)
                        - nepovinné parametry: 
                                  'classid': ORIS id kategorie
                                  'classname': název kategorie
                                  'clubid': číslo nebo zkratka klubu (viz getCSOSClubList) 
                                  /pozn. filtr na klub nelze kombinovat s kategorií
        příklad: https://oris.orientacnisporty.cz/API/?format=xml&method=getEventResults&eventid=2077
  
  - getEventStartLists - vrací startovku pro daný závod (možno i pro konkrétní kategorii)
                        - povinné parametry:
                                  'eventid': ORIS id závodu (viz getEventList)
                        - nepovinné parametry: 
                                  'classid': ORIS id kategorie
                                  'classname': název kategorie
                                  'clubid': číslo nebo zkratka klubu (viz getCSOSClubList) 
                                  /pozn. filtr na klub nelze kombinovat s kategorií
        příklad: https://oris.orientacnisporty.cz/API/?format=xml&method=getEventStartLists&eventid=2077
        
  - getUser - vrací ID a jméno osoby
                        - povinné parametry: 
                                  'rgnum': aktuálně platné registrační číslo
        příklad: https://oris.orientacnisporty.cz/API/?format=xml&method=getUser&rgnum=AOP7601
                        
  - getRegistration  - seznam registrace 
                        - povinné parametry: 
                                  'sport':    id sportu ... 1=OB, 2=LOB, 3=MTBO, 4=TRAIL
                                  'year':     rok
        příklad: https://oris.orientacnisporty.cz/API/?format=xml&method=getRegistration&sport=1&year=2014  

  - getClubUsers  - seznam členství v klubech pro konkrétního uživatele 
                        - povinné parametry: 
                                  'user':    id uživatele
                        - nepovinné parametry: 
                                  'date':    pouze platná členství k danému datu
        příklad: https://oris.orientacnisporty.cz/API/?format=xml&method=getClubUsers&user=5186  

  - getValidClasses  - seznam kategorií platných pro konkrétního člena klubu v daném závodě 
                        - povinné parametry: 
                                  'clubuser':    id členství v klubu
                                  'comp':        id závodu
        příklad: https://oris.orientacnisporty.cz/API/?format=xml&method=getValidClasses&clubuser=5425&comp=2328  

  - createEntry  - přihlášení závodníka na závod (POST požadavek)
                        - povinné parametry (autorizace): 
                                  'username':    přihlašovací jméno uživatele odesílajícího přihlášku
                                  'password':    heslo uživatele odesílajícího přihlášku
                        - povinné parametry (přihláška): 
                                  'clubuser':    id člena klubu
                                  'class':       id kategorie
                        - nepovinné parametry: 
                                  'si':          SI čip (není-li parametr použit, tak se použije SI čip z ORISu)
                                  'note':        poznámka
                                  'clubnote':    klubová poznámka
                                  'requested_start':    požadovaný start
                                  'rent_si':     zapůjčení SI čipu (1=ano)
                                  'iofid':       IOF ID závodníka (číslo)
                                  'stageX':      přihláška pro X-tou etapu vícedenních závodů 
                                                 (parametr se používa opakovaně)
                                                 (kde X je 1..počet etap vícedenního závodu 
                                                  - hodnota 1=přihlásit, 0=nepřihlásit)
                                  'entrystatus': termín přihlášek, parametr je brán v potaz pouze 
                                                 pokud má uživatel práva editovat závod

  - updateEntry  - aktualizace přihlášky závodníka na závod (POST požadavek)
                        - povinné parametry (autorizace): 
                                  'username':    přihlašovací jméno uživatele odesílajícího přihlášku
                                  'password':    heslo uživatele odesílajícího přihlášku
                        - povinné parametry (přihláška): 
                                  'entryid':     id přihlášky
                        - nepovinné parametry: 
                                  'si':          SI čip (není-li parametr použit, tak se použije SI čip z ORISu)
                                  'note':        poznámka
                                  'clubnote':    klubová poznámka
                                  'requested_start':    požadovaný start
                                  'rent_si':     zapůjčení SI čipu (1=ano)
                                  'iofid':       IOF ID závodníka (číslo)

  - deleteEntry  - odhlášení závodníka ze závodu (POST požadavek)
                        - povinné parametry (autorizace): 
                                  'username':    přihlašovací jméno uživatele rušícího přihlášku
                                  'password':    heslo uživatele rušícího přihlášku
                        - povinné parametry (přihláška): 
                                  'entryid':     id přihlášky

  - createServiceEntry  - objednání doplňkové služby (POST požadavek)
                        - povinné parametry (autorizace): 
                                  'username':    přihlašovací jméno uživatele objednávajícího službu
                                  'password':    heslo uživatele objednávajícího službu
                        - povinné parametry (doplňková služba): 
                                  'clubuser':    id člena klubu
                                  'service':     id doplňkové služby
                                  'qty':         množství
                        - nepovinné parametry: 
                                  'note':        poznámka

  - updateServiceEntry  - aktualizace objednávky doplňkové služby (POST požadavek)
                        - povinné parametry (autorizace): 
                                  'username':    přihlašovací jméno uživatele objednávajícího službu
                                  'password':    heslo uživatele objednávajícího službu
                        - povinné parametry (doplňková služba): 
                                  'serviceentryid': id objednávky doplňkové služby
                        - nepovinné parametry: 
                                  'qty':         množství
                                  'note':        poznámka

  - deleteServiceEntry  - zrušení objednávky doplňkové služby (POST požadavek)
                        - povinné parametry (autorizace): 
                                  'username':    přihlašovací jméno uživatele rušícího službu
                                  'password':    heslo uživatele rušícího službu
                        - povinné parametry (doplňková služba): 
                                  'serviceentryid': id objednávky doplňkové služby
                                  
  - getEventBalance - seznam vyúčtování pro daný závod po jednotlivých klubech
                        - povinné parametry:
                                  'eventid': ORIS id závodu (viz getEventList)
        příklad: https://oris.orientacnisporty.cz/API/?format=xml&method=getEventBalance&eventid=2077

  - getVersion - informace o aktuální verzi ORISu
        příklad: https://oris.orientacnisporty.cz/API/?format=xml&method=getVersion
                                  
  - getList - číselníky v ORISu
                        - povinné parametry:
                                  'list': název číselníku - některá z následujících hodnot:
                                          region - regiony
                                          discipline - disciplíny
                                          sport - sporty
                                          level - úrovně
                                          sourcetype - typy souborů / odkazů
                                          clubcontacttype - typy ostatních klubových kontaktů
        příklad: https://oris.orientacnisporty.cz/API/?format=xml&method=getList&list=sport

  - getClassDefinitions - definice kategorií
                        - povinné parametry:
                                  'sport':    id sportu ... 1=OB, 2=LOB, 3=MTBO, 4=TRAIL
        příklad: https://oris.orientacnisporty.cz/API/?format=xml&method=getClassDefinitions&sport=1

  - getSplits - mezičasy kategorie
                        - povinné parametry:
                                  'classid': id kategorie
        příklad: https://oris.orientacnisporty.cz/API/?format=xml&method=getSplits&classid=103880
  
  - getClubEntryRights - přihlašovací práva v rámci klubu (POST požadavek)
                        - povinné parametry:
                                  'clubkey': bezpečnostní klíč klubu ze stránky klubu (přístupné pro vedoucí klubu)

  - setClubEntryRights - nastavení přihlašovacích práv v rámci klubu (POST požadavek)
                        - povinné parametry:
                                  'clubkey':  bezpečnostní klíč klubu ze stránky klubu (přístupné pro vedoucí klubu)
                                  'clubuser': id člena klubu
                                  'self': právo přihlašovat sám sebe, hodnota 0 nebo 1 (0 = nemá právo, 1 = má právo)
                                  'other': právo přihlašovat ostatní, hodnota 0 nebo 1 (0 = nemá právo, 1 = má právo)

  - createEventPayment - zadání platby závodu (POST požadavek)
                        - povinné parametry:
                                  'eventkey':  bezpečnostní klíč závodu ze stránky závodu
                                  'clubid': identifikátor klubu - číslo klubu dle adresáře, zkratka nebo variabilní symbol
                                  'amount': částka
                        - nepovinné parametry
                                  'paymentdate': datum platby ve formátu RRRR-MM-DD
                                  'regnum': registrační číslo, na které se platba vztahuje
                                  'note': poznámka