Difference between revisions of "Inschrijvingen Overzicht Module"

From SBN uvponline documentatie
Jump to navigation Jump to search
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
Een experimentele module is beschikbaar voor website beheerders om via bv een iframe in een CMS een kleine status indicator te hebben van de totalen inschrijvingen per categorie.
+
Een experimentele module is beschikbaar voor website beheerders om via bv een iframe in een CMS een kleine status indicator te hebben van de totalen inschrijvingen per categorie.<br>
 +
Ook is het een '''MINIMAAL ingerichte API''' om de ruwe aantallen data terug te geven in '''JSON format'''.<br>
 +
 
 +
Minimale syntax voor wedstrijdnummer 4:
 +
https://www.uvponline.nl/uvponlineF/Overzicht_deelnemer_aantallen/4
 +
https://www.uvponline.nl/uvponlineF/Overzicht_deelnemer_aantallen/4/justJSON
  
 
:[[File:ClipCapIt-150327-173830.PNG]]
 
:[[File:ClipCapIt-150327-173830.PNG]]
  
Bovenstaande voorbeeld komt van [http://www.dronterlandrun.nl Dronterlandrun] en is een iframe met onderstaande pagina:
+
Bovenstaande voorbeeld komt van [http://www.dronterlandrun.nl Dronterlandrun] en is een <u>TRANSPARANTE</u> iframe met onderstaande pagina:
  
https://www.uvponline.nl/uvponlineF/overzicht_module/compleet/441/modx=187px:mody=auto:bordercol=lightgrey:headercol=&8fbe00:barcol=&8fbe00:textcol=lightgrey:textsize=6pt
+
https://www.uvponline.nl/uvponlineF/Overzicht_deelnemer_aantallen/441/modx=187px:mody=auto:bordercol=lightgrey:headercol=&8fbe00:barcol=&8fbe00:textcol=lightgrey:textsize=6pt
  
Het nummer '''441''' in de URL vervangen door het eigen wedstrijdnummer.
+
<hr>
 +
'''De formatting (optionele veld na het wedstrijdnummer)is css gebaseerd:'''<br />
 +
<span style="color:darkblue;">
 +
Format: url/{'''wedstrijdID'''}/{veld=waarde:veld2=waarde2 etc}<br />
 +
Format: url/{'''wedstrijdID'''}/justJSON</span><br />
 +
<span style="color:darkred;">
 +
Door in plaats van veld/css waarden ''''justJSON'''' op te geven komen de aantallendata enkel als JSON text retour van de server. Geschikt voor je eigen display module bijvoorbeeld.<br>
 +
</span>
 +
Het nummer '''441''' in de URL vervangen door het eigen wedstrijdnummer.
 +
Het laatste veld (het css veld) is optioneel en staat default of fit-auto-x (modx=auto) en fit-auto-y (mody=auto)
  
 
Verder zijn de opties '''modx=auto:mody=auto''' nog verder uit te breiden als volgt (volgorde onbelangrijk)
 
Verder zijn de opties '''modx=auto:mody=auto''' nog verder uit te breiden als volgt (volgorde onbelangrijk)
 
<syntaxhighlight>
 
<syntaxhighlight>
  
# de defaults van de module. Tenminste 2 opties meegeven anders een foutmelding.
+
# uitgebreide voorbeeld URL
 +
https://www.uvponline.nl/uvponlineF/Overzicht_deelnemer_aantallen/441/modx=187px:mody=auto:bordercol=lightgrey:headercol=&8fbe00:barcol=&8fbe00:textcol=lightgrey:textsize=6pt
 +
 
 +
# de defaults van de module.
  
 
  # modx          breedte van gehele DIV            'auto' voor fit content anders bv 200px
 
  # modx          breedte van gehele DIV            'auto' voor fit content anders bv 200px
Line 19: Line 36:
 
  # headercol    kleur headers boven tabel          #8fbe00  vervang de # voor een & in de url.
 
  # headercol    kleur headers boven tabel          #8fbe00  vervang de # voor een & in de url.
 
  # headersize    font size headers (in pt)          8pt
 
  # headersize    font size headers (in pt)          8pt
  # barcol        kleur van de staafdiagram          'none' voor geen staven anders css col
+
  # barcol        kleur van de staafdiagram          'none' voor geen staven anders css color
 
  # barwidth      hoogte staafdiagram (px)          40 default
 
  # barwidth      hoogte staafdiagram (px)          40 default
  # textcol      kleur van aantallen/cat tekst      css color names of hex
+
  # textcol      kleur van aantallen/cat tekst      css color names of hexadecimale kleurcode
  # textsize      font grootte tekst                7pt
+
  # textsize      font grootte tekst                7pt default
  # hovercol      kleur van de DIV hover            none voor geen hover
+
  # hovercol      kleur van de DIV hover            none voor geen aparte hover kleur. Hoover is gekoppeld aan het openen overzicht.
  
#specifieke voorbeeld
+
#specifieke voorbeelden
 
   modx={auto of aantal px}
 
   modx={auto of aantal px}
 
       auto  # automatische breedte
 
       auto  # automatische breedte
Line 39: Line 56:
 
       6pt  # 6 punt font
 
       6pt  # 6 punt font
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
<br>
 +
<br>
 +
<syntaxhighlight lang="JSON">
 +
https://www.uvponline.nl/uvponlineF/Overzicht_deelnemer_aantallen/441/justJSON
  
 +
JSON retour text:
 +
{
 +
  "wedstrijd_id":"441",
 +
  "totaal":711,
 +
  "cats":{
 +
      "KSR":{
 +
        "cat_oms1":"Korte survivalrun (KSR)",
 +
        "cat_oms2":"Licentie wedstrijd, 8 km, vanaf 18 jaar",
 +
        "max_deelnemers":"350",
 +
        "is_reserve":"0",
 +
        "volgorde_display":"0",
 +
        "actueel_aantal":"132"
 +
      },
 +
      "JSR 15-17":{
 +
        "cat_oms1":"JSR 15-17 Licentiewedstrijd",
 +
        "cat_oms2":"8 km, 15 t\/m 17 jaar",
 +
        "max_deelnemers":"100",
 +
        "is_reserve":"0",
 +
        "volgorde_display":"1",
 +
        "actueel_aantal":"67"
 +
      },
 +
      "JSR 12-14":{
 +
        "cat_oms1":"JSR 12-14 Licentiewedstrijd",
 +
        "cat_oms2":"6 km, 12 t\/m 14 jaar",
 +
        "max_deelnemers":"150",
 +
        "is_reserve":"0",
 +
        "volgorde_display":"2",
 +
        "actueel_aantal":"83"
 +
      },
 +
      "JSR 10-11":{
 +
        "cat_oms1":"JSR 10-11 Licentiewedstrijd",
 +
        "cat_oms2":"6 km, 10 t\/m 11 jaar",
 +
        "max_deelnemers":"100",
 +
        "is_reserve":"0",
 +
        "volgorde_display":"3",
 +
        "actueel_aantal":"47"
 +
      },
 +
      "RECindiv12":{
 +
        "cat_oms1":"Recreatief 12 km (try-out MSR)",
 +
        "cat_oms2":"vanaf 16 jaar en enkel SBN leden",
 +
        "max_deelnemers":"60",
 +
        "is_reserve":"0",
 +
        "volgorde_display":"4",
 +
        "actueel_aantal":"50"
 +
      },
 +
      "REC-indiv8":{
 +
        "cat_oms1":"Recreatief Indiv 8 km",
 +
        "cat_oms2":"vanaf 15 jaar (voor getrainde atleten!)",
 +
        "max_deelnemers":"185",
 +
        "is_reserve":"0",
 +
        "volgorde_display":"5",
 +
        "actueel_aantal":"182"
 +
      },
 +
      "REC-indiv5":{
 +
        "cat_oms1":"Recreatief Indiv 6 km",
 +
        "cat_oms2":"vanaf 8 jaar",
 +
        "max_deelnemers":"80",
 +
        "is_reserve":"0",
 +
        "volgorde_display":"6",
 +
        "actueel_aantal":"74"
 +
      },
 +
      "Team5":{
 +
        "cat_oms1":"Teamrun 6km",
 +
        "cat_oms2":"vanaf 8 jaar, teams van 3-4 deelnemers",
 +
        "max_deelnemers":"150",
 +
        "is_reserve":"0",
 +
        "volgorde_display":"7",
 +
        "actueel_aantal":"72"
 +
      },
 +
      "BEGLEIDGR":{
 +
        "cat_oms1":"Begeleid (na goedkeuring), GROEP inschr",
 +
        "cat_oms2":"Speciaal 6km",
 +
        "max_deelnemers":"50",
 +
        "is_reserve":"0",
 +
        "volgorde_display":"8",
 +
        "actueel_aantal":"0"
 +
      },
 +
      "BEGELEID":{
 +
        "cat_oms1":"Begeleid (na goedkeuring), INDIVIDUEEL inschr",
 +
        "cat_oms2":"Speciaal 6km",
 +
        "max_deelnemers":"45",
 +
        "is_reserve":"0",
 +
        "volgorde_display":"8",
 +
        "actueel_aantal":"4"
 +
      },
 +
      "Spons5":{
 +
        "cat_oms1":"Sponsors 6km",
 +
        "cat_oms2":"Speciale teams",
 +
        "max_deelnemers":"25",
 +
        "is_reserve":"0",
 +
        "volgorde_display":"10",
 +
        "actueel_aantal":"0"
 +
      }
 +
  }
 +
}
 +
</syntaxhighlight>
  
--[[User:AlexBossers|AlexBossers]] ([[User talk:AlexBossers|talk]]) 17:40, 27 March 2015 (CET)
+
--[[User:AlexBossers|AlexBossers]] ([[User talk:AlexBossers|talk]]) 23:05, 8 October 2016 update JSON 14 October 2020 (CEST)

Latest revision as of 22:50, 14 October 2020

Een experimentele module is beschikbaar voor website beheerders om via bv een iframe in een CMS een kleine status indicator te hebben van de totalen inschrijvingen per categorie.
Ook is het een MINIMAAL ingerichte API om de ruwe aantallen data terug te geven in JSON format.

Minimale syntax voor wedstrijdnummer 4:
https://www.uvponline.nl/uvponlineF/Overzicht_deelnemer_aantallen/4
https://www.uvponline.nl/uvponlineF/Overzicht_deelnemer_aantallen/4/justJSON
ClipCapIt-150327-173830.PNG

Bovenstaande voorbeeld komt van Dronterlandrun en is een TRANSPARANTE iframe met onderstaande pagina:

https://www.uvponline.nl/uvponlineF/Overzicht_deelnemer_aantallen/441/modx=187px:mody=auto:bordercol=lightgrey:headercol=&8fbe00:barcol=&8fbe00:textcol=lightgrey:textsize=6pt


De formatting (optionele veld na het wedstrijdnummer)is css gebaseerd:


Format: url/{wedstrijdID}/{veld=waarde:veld2=waarde2 etc}
Format: url/{wedstrijdID}/justJSON

Door in plaats van veld/css waarden 'justJSON' op te geven komen de aantallendata enkel als JSON text retour van de server. Geschikt voor je eigen display module bijvoorbeeld.
Het nummer 441 in de URL vervangen door het eigen wedstrijdnummer. Het laatste veld (het css veld) is optioneel en staat default of fit-auto-x (modx=auto) en fit-auto-y (mody=auto)

Verder zijn de opties modx=auto:mody=auto nog verder uit te breiden als volgt (volgorde onbelangrijk)


# uitgebreide voorbeeld URL
https://www.uvponline.nl/uvponlineF/Overzicht_deelnemer_aantallen/441/modx=187px:mody=auto:bordercol=lightgrey:headercol=&8fbe00:barcol=&8fbe00:textcol=lightgrey:textsize=6pt

# de defaults van de module.

 # modx          breedte van gehele DIV             'auto' voor fit content anders bv 200px
 # mody          hoogte van module                  'auto' voor fit anders bv 180px
 # bordercol     kleur van de border                'none' voor geen border
 # headercol     kleur headers boven tabel          #8fbe00   vervang de # voor een & in de url.
 # headersize    font size headers (in pt)          8pt
 # barcol        kleur van de staafdiagram          'none' voor geen staven anders css color
 # barwidth      hoogte staafdiagram (px)           40 default
 # textcol       kleur van aantallen/cat tekst      css color names of hexadecimale kleurcode
 # textsize      font grootte tekst                 7pt default
 # hovercol      kleur van de DIV hover             none voor geen aparte hover kleur. Hoover is gekoppeld aan het openen overzicht.

#specifieke voorbeelden
  modx={auto of aantal px}
       auto  # automatische breedte
       100px # 100 pixels breed
  mody={auto of aantal px}
  bordercol={css_kleur}
       lightgrey  # bv
       &eeffee    # kleur in hex mag ook
  headercol={css kleur}
  barcol={css kleur}
  textcol={css kleur}
  textsize={tekst grootte}
       6pt  # 6 punt font



https://www.uvponline.nl/uvponlineF/Overzicht_deelnemer_aantallen/441/justJSON

JSON retour text: 
{
   "wedstrijd_id":"441",
   "totaal":711,
   "cats":{
      "KSR":{
         "cat_oms1":"Korte survivalrun (KSR)",
         "cat_oms2":"Licentie wedstrijd, 8 km, vanaf 18 jaar",
         "max_deelnemers":"350",
         "is_reserve":"0",
         "volgorde_display":"0",
         "actueel_aantal":"132"
      },
      "JSR 15-17":{
         "cat_oms1":"JSR 15-17 Licentiewedstrijd",
         "cat_oms2":"8 km, 15 t\/m 17 jaar",
         "max_deelnemers":"100",
         "is_reserve":"0",
         "volgorde_display":"1",
         "actueel_aantal":"67"
      },
      "JSR 12-14":{
         "cat_oms1":"JSR 12-14 Licentiewedstrijd",
         "cat_oms2":"6 km, 12 t\/m 14 jaar",
         "max_deelnemers":"150",
         "is_reserve":"0",
         "volgorde_display":"2",
         "actueel_aantal":"83"
      },
      "JSR 10-11":{
         "cat_oms1":"JSR 10-11 Licentiewedstrijd",
         "cat_oms2":"6 km, 10 t\/m 11 jaar",
         "max_deelnemers":"100",
         "is_reserve":"0",
         "volgorde_display":"3",
         "actueel_aantal":"47"
      },
      "RECindiv12":{
         "cat_oms1":"Recreatief 12 km (try-out MSR)",
         "cat_oms2":"vanaf 16 jaar en enkel SBN leden",
         "max_deelnemers":"60",
         "is_reserve":"0",
         "volgorde_display":"4",
         "actueel_aantal":"50"
      },
      "REC-indiv8":{
         "cat_oms1":"Recreatief Indiv 8 km",
         "cat_oms2":"vanaf 15 jaar (voor getrainde atleten!)",
         "max_deelnemers":"185",
         "is_reserve":"0",
         "volgorde_display":"5",
         "actueel_aantal":"182"
      },
      "REC-indiv5":{
         "cat_oms1":"Recreatief Indiv 6 km",
         "cat_oms2":"vanaf 8 jaar",
         "max_deelnemers":"80",
         "is_reserve":"0",
         "volgorde_display":"6",
         "actueel_aantal":"74"
      },
      "Team5":{
         "cat_oms1":"Teamrun 6km",
         "cat_oms2":"vanaf 8 jaar, teams van 3-4 deelnemers",
         "max_deelnemers":"150",
         "is_reserve":"0",
         "volgorde_display":"7",
         "actueel_aantal":"72"
      },
      "BEGLEIDGR":{
         "cat_oms1":"Begeleid (na goedkeuring), GROEP inschr",
         "cat_oms2":"Speciaal 6km",
         "max_deelnemers":"50",
         "is_reserve":"0",
         "volgorde_display":"8",
         "actueel_aantal":"0"
      },
      "BEGELEID":{
         "cat_oms1":"Begeleid (na goedkeuring), INDIVIDUEEL inschr",
         "cat_oms2":"Speciaal 6km",
         "max_deelnemers":"45",
         "is_reserve":"0",
         "volgorde_display":"8",
         "actueel_aantal":"4"
      },
      "Spons5":{
         "cat_oms1":"Sponsors 6km",
         "cat_oms2":"Speciale teams",
         "max_deelnemers":"25",
         "is_reserve":"0",
         "volgorde_display":"10",
         "actueel_aantal":"0"
      }
   }
}

--AlexBossers (talk) 23:05, 8 October 2016 update JSON 14 October 2020 (CEST)