Skip to content
This repository was archived by the owner on Nov 22, 2019. It is now read-only.

Publikaj komandoj de la API

Jump to bottom
Ana Ribeiro edited this page May 20, 2017 · 122 revisions

Ĉi tie estas dokumentado por la komandoj de la API kiuj ne bezonas permeson por esti alvenitaj de la eksteraj apoj.

Baza URL

//Daŭre ne certas ĉu tio estos la fina URL

La publika API estos alirebla tra la URL http://rest.uea.org/publika/

Dokumentado

Ĝeneralaĵoj

Rilate al Asocioj

Rilate al Laborgrupoj

Rilate al kongresoj

Ĝeneralaj

Krei uzanton

Reveni supren

POST - /Uzanto

Ĝi kreos uzanton.

Parametroj

  • Body Informoj pri la uzanto:

    • personaNomo: La persona nomo de la uzanto. Ekzemple: Ludoviko.
    • familiNomo: La familia nomo de la uzanto. Ekzemple: Zamenhof.
    • titolo: La titolo de la uzanto. Ekzemple D-ro.
    • profesio: La profesio de la uzanto. Ekzemple kuracisto. Opcia
    • personanomoIdentigilo: La persona nomo laŭ la identigilo. Ekzemple Ludwik Łazarz. Opcia
    • familianomoIdentigilo: La familia nomo laŭ la identigilo. Ekzemple Zamenhof. Opcia
    • adreso: La Adreso de la uzanto. Ekzemple Strato Esperanto. Varsovio.
    • Posxtokod: La posxtkodo. Ekzemple 51800.
    • logxurbo: La ID de la loĝurbo de la uzanto laŭ nia datumbazo. Ekzemple 1.
    • naciaLando: La ID de la nacilando de la uzanto laŭ nia datumbazo. Ekzemple 1.
    • naskigxtago: La naskiĝtago de la uzanto. Ekzemple 1859-12-15.
    • retposxto: La retposxto de la uzanto. Ekzemple mi@esperanto.com.
    • telhejmo: La hejma telefono de la uzanto. Ekzemple 44 222 522. opcia
    • telportebla: La portebla telefono de la uzanto. Ekzemple 44 22004 88. opcia

Preni liston de urboj

Preni liston de urboj laŭ lande

Preni liston de landoj

Reveni supren

Ĝi montras la liston de la landoj kiuj estas registrita en la sistemo.

  • GET - /Lando

Parametroj

Ne estas.

Rezultoj

200: ĉio enordas. Ekzemplo de atendata rezulto:

     [
        {
            "id": 25,
            "NomoEO": "Brazilo",
            "NomoLoka": "Brasil",
            "Landkodo": 55

        },
        {
            "id": 26,
            "NomoEO": "Britio",
            "NomoLoka": "Great Britain",
            "Landkodo": 44

        },
        ...
     ]

Preni liston de faktemoj

Reveni supren

Ĝi montras la liston de la landoj kiuj estas registrita en la sistemo.

  • GET - /Faktemo

Parametroj

Ne estas.

Rezultoj

200: ĉio enordas. Ekzemplo de atendata rezulto:

     [
        {
            "id": 3,
            "nomo": "Biciklado",
            "priskribo": "Diskonigi E-on inter biciklantoj kaj biciklemon inter la esperantistoj."
        },
        {
            "id": 4,
            "Nomo": "Blinduloj",
            "priksribo": "Disvastigi Esperanton inter blinduloj kaj informi pri la vivo de diverslandaj blinduloj."
        },
        ...
     ]

Asociaj komandoj

Preni publikajn datumojn de Asocioj

Reveni supren

Ĝi montras publikajn datumojn de ĉiuj asocioj en la sistemo.

  • GET - /Asocio

Parametroj

Ne estas.

Rezulto

  • 200: ĉio enordas. Ekzemplo de atendata rezulto estas la jena:

         [
        {
            "id": 4,
            "nomo": "Brazila Esperanto-Ligo",
            "siglo": "BEL",
            "adreso": "SDS Bl.P 36, Ed. Venâncio III Sala 303, 70393-902 Brasília - DF, Brazilo"
            "fondigxdato": 1907,
            "urbo": 1,
            "landokodo": "25"
            "telhejmo": "(61) 3226 1298",
            "retpoŝto": "bel@esperanto.org.br"
            "tttpagxo": "http://www.esperanto.org.br"
        },

        {
            "nomo": "Brazila Esperantista Junulara Organizo",
            "siglo": "BEJO",
            "adreso": "SDS Bl.P 36, Ed. Venâncio III Sala 303, 70393-902 Brasília - DF, Brazilo"
            "fondigxdato": 1967,
            "urbo": "Braziljo",
            "lando": "Brazilo"
            "telhejmo": "(61) 3226 1298",
            "retpoŝto": "bejo@esperanto.org.br"
            "tttpagxo": "http://bejo.esperanto.org.br"
        },
        ...
     ]

Preni publikajn datumojn de Asocio laŭ la ID

Reveni supren

Ĝi montras publikajn datumojn de asocio laŭ la ID.

  • GET - /Asocio/ID/:id

Parametroj

  • id: Path Parametro por la ID de la asocio.

Rezulto

  • 200: ĉio enordas. Ekzemplo de atendata rezulto estas la jena:

            {
            "id": 4,
            "nomo": "Brazila Esperanto-Ligo",
            "siglo": "BEL",
            "adreso": "SDS Bl.P 36, Ed. Venâncio III Sala 303, 70393-902 Brasília - DF, Brazilo"
            "fondigxdato": 1907,
            "urbo": 1,
            "landokodo": "25"
            "telhejmo": "(61) 3226 1298",
            "retpoŝto": "bel@esperanto.org.br"
            "tttpagxo": "http://www.esperanto.org.br"
        },

  • 404: "Not found": Ne estis trovita asocio por tiu ID.

Preni publikajn datumojn de Asocioj ligitaj al TEJO

Reveni supren

Ĝi montras publikajn datumojn de asocioj ligitaj al TEJO.

  • GET - /Asocio/TEJO

Parametroj

Ne estas

Rezulto

  • 200: ĉio enordas. Ekzemplo de atendata rezulto estas la jena:

         [
        {
            "nomo": "Brazila Esperantista Junulara Organizo",
            "siglo": "BEJO",
            "adreso": "SDS Bl.P 36, Ed. Venâncio III Sala 303, 70393-902 Brasília - DF, Brazilo"
            "fondigxdato": 1967,
            "urbo": "Braziljo",
            "lando": "Brazilo"
            "telhejmo": "(61) 3226 1298",
            "retpoŝto": "bejo@esperanto.org.br"
            "tttpagxo": "http://bejo.esperanto.org.br"
        },
        ...
     ]

Preni publikajn datumojn de Asocioj ligitaj al TEJO laŭ ID

Reveni supren

Ĝi montras publikajn datumojn de asocioj ligitaj al TEJO.

  • GET - /Asocio/TEJO/ID/:id

Parametroj

  • id: Path Parametro por la ID de la asocio.

Rezulto

  • 200: ĉio enordas. Ekzemplo de atendata rezulto estas la jena:

            {
            "nomo": "Brazila Esperantista Junulara Organizo",
            "siglo": "BEJO",
            "adreso": "SDS Bl.P 36, Ed. Venâncio III Sala 303, 70393-902 Brasília - DF, Brazilo"
            "fondigxdato": 1967,
            "urbo": "Braziljo",
            "lando": "Brazilo"
            "telhejmo": "(61) 3226 1298",
            "retpoŝto": "bejo@esperanto.org.br"
            "tttpagxo": "http://bejo.esperanto.org.br"
        },

  • 404: Not Found. Ne estis trovitaj asocioj kun tiu ID.

Preni publikajn datumojn de Asocioj ligitaj al UEA

Reveni supren

Ĝi montras publikajn datumojn de asocioj ligitaj al UEA.

  • GET - /Asocio/UEA

Parametroj

Ne estas

Rezulto

  • 200: ĉio enordas. Ekzemplo de atendata rezulto estas la jena:

         [
        {
            "nomo": "Brazila Esperanto-Ligo",
            "siglo": "BEL",
            "adreso": "SDS Bl.P 36, Ed. Venâncio III Sala 303, 70393-902 Brasília - DF, Brazilo"
            "fondigxdato": 1907,
            "urbo": "Braziljo",
            "lando": "Brazilo"
            "telhejmo": "(61) 3226 1298",
            "retpoŝto": "bel@esperanto.org.br"
            "tttpagxo": "http://esperanto.org.br"
        },
        ...
     ]

Preni publikajn datumojn de Asocioj ligitaj al UEA laŭ ID

Reveni supren

Ĝi montras publikajn datumojn de asocioj ligitaj al UEA.

  • GET - /Asocio/UEA/ID/:id

Parametroj

  • id: Path Parametro por la ID de la asocio.

Rezulto

  • 200: ĉio enordas. Ekzemplo de atendata rezulto estas la jena:

            {
            "nomo": "Brazila Esperanto-Ligo",
            "siglo": "BEL",
            "adreso": "SDS Bl.P 36, Ed. Venâncio III Sala 303, 70393-902 Brasília - DF, Brazilo"
            "fondigxdato": 1907,
            "urbo": "Braziljo",
            "lando": "Brazilo"
            "telhejmo": "(61) 3226 1298",
            "retpoŝto": "bejo@esperanto.org.br"
            "tttpagxo": "http://bejo.esperanto.org.br"
        },

  • 404: Not Found. Ne estis trovitaj asocioj kun tiu ID.

Preni publikajn informojn de asocioj laŭ lande

Reveni supren

Ĝi donos informojn de ĉiuj asocioj en tiu lando asociita aŭ al TEJO aŭ/kaj al UEA.

  • GET - /Asocio/Lando/:id

Parametroj

  • id: "Path" parametro kun la id de la lando laŭ nia datumbazo. Ekzemple, 25 por Brazilo.

Rezulto

  • 200: ĉio enordas. Ekzemplo de atendata rezulto estas la jena:

         [
        {
            "nomo": "Brazila Esperanto-Ligo",
            "siglo": "BEL",
            "adreso": "SDS Bl.P 36, Ed. Venâncio III Sala 303, 70393-902 Brasília - DF, Brazilo"
            "fondigxdato": 1907,
            "urbo": "Braziljo",
            "lando": "Brazilo"
            "telhejmo": "(61) 3226 1298",
            "retpoŝto": "bel@esperanto.org.br",
            "tttpagxo": "http://www.esperanto.org.br"
        },

        {
            "nomo": "Brazila Esperantista Junulara Organizo",
            "siglo": "BEJO",
            "adreso": "SDS Bl.P 36, Ed. Venâncio III Sala 303, 70393-902 Brasília - DF, Brazilo"
            "fondigxdato": 1967,
            "urbo": "Braziljo",
            "lando": "Brazilo"
            "telhejmo": "(61) 3226 1298",
            "retpoŝto": "bejo@esperanto.org.br"
            "tttpagxo": "http://bejo.esperanto.org.br"
        },
        ...
     ]

  • 400: malbonaj parametroj

  • 404: asocioj en tiu lando ne estis trovitaj

Preni publikajn datumojn de Fakaj Asocioj laŭ fako

Reveni supren

Ĝi montras publikajn datumojn de fakaj asocioj de UEA kaj de TEJO laŭ la fako.

  • GET - /Asocio/Faktemo/:id

Parametroj

Rezultoj

  • 200: ĉio enordas. Ekzemplo de atendata rezulto estas la jena:

         [
        {
            "nomo": "Internacia Ligo de Esperantistaj Instruistoj",
            "siglo": "ILEI",
            "adreso": "p/a Radojica Petrović, Bul. Oslobodjenja 36 III-14, 32000 Čačak, Serbio"
            "fondigxdato": 1949,
            "urbo": "Čačak",
            "lando": "Serbio"
            "telhejmo": "",
            "retpoŝto": "",
            "tttpagxo": "http://www.ilei.info"
        },
        ...
     ]

  • 400: malbonaj parametroj

Laborgrupaj komandoj

Reveni supren

Preni informojn pri la estraranoj

Ĝi montras bazajn informojn de estraranoj.

  • GET - /Laborgrupo/Estraranoj

Parametroj

Ne estas

Rezultoj

200: ĉio enordas. Ekzemplo de atendata rezulto estas la jena:

     [
        {
            "persona nomo": "Mark",
            "familia nomo": "Fettes",
            "titolo": "D-ro",
            "Bildo": "http://uea.org/l/foto?n=116115g116.jpg",
            "lando": "Kanado",
            "retposxto": "mtfettes (cxe) sfu.ca",
            "respondeco": "prezidanto",
            "tasko": "Strategio, Kunordigo, Statuta Reformo, Esploro kaj Dokumentado, Faka kaj Scienca Agado"
        },
        ...
     ]

Preni informojn pri la komitatanoj

Reveni supren

Ĝi montras bazajn informojn de komitatanoj.

  • GET - /Laborgrupo/Komitatano

Parametroj

Ne estas

Rezultoj

200: ĉio enordas. Ekzemplo de atendata rezulto estas la jena:

     [
        {
            "persona nomo": "Mireille",
            "familia nomo": "Grosjean",
            "titolo": "S-ino",
            "Bildo": "http://uea.org/l/foto?n=105103i114.jpg",
            "lando": "Svislando",
            "retposxto": "mirejo.mireille (cxe) gmail.com",
            "grupo": "Komitatano A",
            "Asocio": "ILEI"
        },
       
        {
            "persona nomo": "Emilio",
            "familia nomo": "Cid",
            "titolo": "S-oro",
            "Bildo": "http://uea.org/l/foto?n=109111m108.jpg",
            "lando": "Brazilo",
            "retposxto": "cid.emilio (cxe) gmail.com",
            "grupo": "Komitatano B",
         },
        ...
     ]

Preni informojn pri la konsilianoj

Ĝi montras bazajn informojn de konsilianoj.

  • GET - /Laborgrupo/Konsiliano

Parametroj

Ne estas

Rezultoj

200: ĉio enordas. Ekzemplo de atendata rezulto estas la jena:

     [
        {
            "persona nomo": "Peter",
            "familia nomo": "Baláž",
            "titolo": "S-ro",
            "Bildo": "http://uea.org/l/foto?n=116122q98.jpg",
            "lando": "Slovakio"
        },
        ...
     ]

Preni liston de komisionoj

Reveni supren

Ĝi montras liston de komisionoj.

  • GET - /Laborgrupo/Komisiono

Parametroj

Ne estas

Rezultoj

200: ĉio enordas. Ekzemplo de atendata rezulto estas la jena:

     [
        {
            "id": 1,
            "titolo": "Afrika Agado"
        },
        {
            "id": 2,
            "titolo": "Amerika Agado"
        },
        ...
     ]

Preni liston de komisionanoj laŭ komisiono

Reveni supren

Ĝi donas la liston de ĉiuj kiuj membras en tiu komisiono.

  • GET - /Laborgrupo/Komisionano/Komisiono/:id

Parametroj

  • id: Path Parametro kun la id de la komisiono laŭ nia datumbazo. Ekzemple, 1 por Afrika Agado.

Rezultoj

200: ĉio enordas. Ekzemplo de la atendata rezulto estas la jena:

     [
        {
            "persona nomo": "Adjévi",
            "familia nomo": "Adjé",
            "titolo": "S-ro",
            "Bildo": "",
            "lando": "Togolando"
            "retposxto": "adjevia (cxe) yahoo.fr"
            "tasko": "kunordiganto"
        },
        ...
     ]

Preni bazajn informojn pri oficistoj

Reveni supren

  • GET - /Laborgrupo/Oficisto

Parametroj

Ne estas

Rezultoj

200: ĉio enordas. Ekzemplo de atendata rezulto estas la jena:

     [
        {
            "persona nomo": "Veronika",
            "familia nomo": "Pȯor",
            "titolo": "D-ino",
            "Bildo": "http://uea.org/l/foto?n=112111f111.jpg",
            "lando": "Hungario",
            "retposxto": "direktoro (cxe) co.uea.org",
            "tasko": "Ĝenerala Direktoro"
        },
        ...
     ]

Preni bazajn informojn pri volontuloj

Reveni supren

  • GET - /Laborgrupo/Volontulo

Parametroj

Ne estas

Rezultoj

200: ĉio enordas. Ekzemplo de atendata rezulto estas la jena:

     [
        {
            "persona nomo": "Alessandro",
            "familia nomo": "Bonfati",
            "titolo": "S-ro",
            "Bildo": "",
            "lando": "Italio",
            "retposxto": " bnf.lsn (cxe) gmail.com",
            "tasko": "TEJO"
        },
        ...
     ]

Kongresoj

Preni informojn pri kongresoj

Reveni supren

GET - /Kongreso

Ĝi donas informojn pri ĉiuj kongresoj, kiuj estas en nia datumbazo.

Parametroj

Ne estas.

Rezultoj

200: ĉio enordas. Ekzemplo de atendata rezulto estas la jena:

     [
        {
            "id": 1,
            "titolo": "Universala Kongreso",
            "numero": 102,
            "jaro": 2017,
            "idUrbo": 3,
            "komencdato": 22-07-2017,
            "findato": 29-07-2017,
            "temo": "Turismo kaj evoluo: Vojoj al daŭripovo",
            "priskribo": "La ĉefa kongreso de UEA"

        },
        ...
     ]

Preni informojn pri kongresoj laŭ la ID

Reveni supren

GET - /Kongreso/:id

Ĝi donas informojn pri la kongreso laŭ la id.

Parametroj

Rezultoj

200: ĉio enordas. Ekzemplo de atendata rezulto estas la jena:

        {
            "id": 1,
            "titolo": "Universala Kongreso",
            "numero": 102,
            "jaro": 2017,
            "idUrbo": 3,
            "komencdato": 22-07-2017,
            "findato": 29-07-2017,
            "temo": "Turismo kaj evoluo: Vojoj al daŭripovo",
            "priskribo": "La ĉefa kongreso de UEA"

        }

Preni liston de aliĝintoj de iu kongreso

Reveni supren

  • GET - /Kongreso/:id/aligxinto

Parametroj

Rezultoj

200: ĉio enordas. Ekzemplo de atendata rezulto estas la jena:

     [
        {
            "persona nomo": "Peter",
            "familia nomo": "Baláž",
            "titolo": "S-ro",
            "lando": "Slovakio"
        },
        ...
     ]

404: Ne estis trovita iu kongreso kun tiu ID.

Preni liston de aliĝintoj de iu kongreso laŭ lande

Reveni supren

  • GET - /Kongreso/:idKongreso/aligxinto/lando/:idLando

Parametroj

Rezultoj

200: ĉio enordas. Ekzemplo de atendata rezulto estas la jena:

     [
        {
            "persona nomo": "Peter",
            "familia nomo": "Baláž",
            "titolo": "S-ro",
            "lando": "Slovakio"
        },
        ...
     ]

Clone this wiki locally