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 24, 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

Rezultoj

201: Sukceso. Ĝi redonos la ID de la uzanto.

Preni liston de urboj

Reveni supren

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

  • GET - /Urboj

Parametroj

Ne estas.

Rezultoj

200: ĉio enordas. Ekzemplo de atendata rezulto:

     [
        {
            "id": 1,
            "NomoEO": "Braziljo",
            "NomoLoka": "Brasília",
            "IDLando": 25

        },
        {
            "id": 2,
            "NomoEO": "Londono",
            "NomoLoka": "London",
            "IDLando": 26

        },
        ...
     ]

Preni liston de landoj

Reveni supren

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

  • GET - /Landoj

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 - /Faktemoj

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."
        },
        ...
     ]
  • 404: Ne trovita.

Asociaj komandoj

Preni publikajn datumojn de Asocioj

Reveni supren

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

  • GET - /Asocioj

Parametroj

  • id: Path Parametro por la ID de la asocio. Ekzemple /Asocioj/25 por preni informojn pri la asocio kun la ID 25.

Filtriloj

La rezulto povos esti filtrata per ajna kampo. Sed kelkaj pli utilaj kampoj estas la jenaj:

  • junulara: Boolean filtrilo (valoroj 0 aŭ 1) por indiki ĉu oni volas junularajn asociojn aŭ ne. Ekzemple, /Asocio?junulara=0 montras nur ne junularaj organizoj dum kiam /Asocio?junulara=1 montras nur junularajn organizojn.

  • lando: ID filtrilo por la lando. Ekzemple /Asocio?lando=25 montros nur la asocioj kiuj estas el la lando kun la ID 25.

  • faka: Boolean filtrilo (valoroj 0 aŭ 1) por indiki ĉu oni volas fakajn asociojn.

  • landa: Boolean filtrilo (valoroj 0 aŭ 1) por indiki ĉu oni volas landajn asociojn.

Krom tio, oni povas kunigi la filtriloj por havi rezultojn kiel "landaj junularaj asocioj", ekzemple.

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 liston de laborogrupoj

Reveni supren

Ĝi montras liston de laborgrupoj.

  • GET - /Grupoj/Laboroj/

Parametroj

Ne estas.

Rezultoj

  1. Ĉio enordas.

Preni liston de komisionoj

Reveni supren

Ĝi montras liston de komisionoj.

  • GET - /Grupoj/Laboroj/Komisionoj

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 informojn pri la estraranoj

Reveni supren

Ĝi montras bazajn informojn de estraranoj.

  • GET - /Grupoj/Laboroj/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 - /Grupoj/Laboraj/Komitatanoj

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 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](#dokumentado)

Ĝ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](#preni-liston-de--komisionoj). 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 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 bazajn informojn pri oficistoj

[Reveni supren](#dokumentado)

* `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](#dokumentado)

* `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](#dokumentado)

`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](#dokumentado)

`GET - /Kongreso/:id`

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

**Parametroj**

* _id_ : La ID de la kongreso [laŭ nia datumbazo](#preni-informojn-pri-kongresoj).

**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](#dokumentado)

* `GET - /Kongreso/:id/aligxinto`


**Parametroj**

* _id_ : `Path` parametro por la ID de la kongreso [laŭ nia datumbazo](#preni-informojn-pri-kongresoj).


**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](#dokumentado)

* `GET - /Kongreso/:idKongreso/aligxinto/lando/:idLando`


**Parametroj**

* _idKongreso_ : `Path` Parametro por la ID de la kongreso [laŭ nia datumbazo](#preni-informojn-pri-kongresoj).
* _idLando_: `Path` parametro kun la id de la lando [laŭ nia datumbazo](#preni-liston-de-landoj)

**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