Skip to content
This repository has been 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 Sep 27, 2017 · 122 revisions

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

Dokumentado

Membrado

Ĝeneralaĵoj

Rilate al Asocioj

Rilate al Perantoj

Rilate al Laborgrupoj

Rilate al kongresoj

Registrado

Krei uzanton

Reveni supren

POST - /Uzantoj

Ĝi kreos uzanton.

Parametroj

  • Body Informoj pri la uzanto:

    • uzantnomo: La uzantnomo de la uzanto. Ekzemple llzamenhof. Unika
    • pasvorto: La pasvorto de la uzanto. Ekzemple 1234.
    • 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.
    • bildo: ligilo al bildo de uzanto. Opcia
    • profesio: La profesio de la uzanto. Ekzemple kuracisto. Opcia
    • adreso: La Adreso de la uzanto. Ekzemple Strato Esperanto. Varsovio. Opcia
    • Posxtokod: La posxtkodo. Ekzemple 51800.
    • idUrbo: La ID de la loĝurbo de la uzanto laŭ nia datumbazo. Ekzemple 1. Opcia
    • idNaciaLando: 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 [email protected].
    • 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.
  • 400: Jam ekzistasa tiu uzantnomo en la sistemo.
  • 500: serveraro. (kontrolu viajn parametrojn).

Preni membrecajn kategoriojn

Reveni supren

  • GET - /grupoj/membrecoj

Ĝi donos la liston de kategorioj kiuj eblas membriĝi.

Parametroj

Ne Estas.

Rezultoj

  • 200: ĉio enordas. Ekzemplo de atendata rezulto estas la jena:
     [
        {
            "id": 1,
            "mallongigilo": "IM",
            "nomo": "Individuaj Membroj",
            "priskribo": "La grupo de individuaj membroj kiuj ricevas tion",
        },
        ...
     ]

Preni aldonajn membrecajn kategoriojn

Reveni supren

  • GET - /grupoj/membrecoj/aldonoj

Ĝi donos la liston de kategorioj kiuj eblas membriĝi.

Parametroj

Ne Estas.

Rezultoj

  • 200: ĉio enordas. Ekzemplo de atendata rezulto estas la jena:
     [
        {
            "id": 1,
            "mallongigilo": "PTEJO",
            "nomo": "Patrono de TEJO",
            "priskribo": "La grupo de patronoj de TEJO kiuj ricevas tion",
        },
        ...
     ]

Preni aliĝkotizojn

Reveni supren

Ĝi prenas ĉiujn aliĝkotizojn por unu grupa kategorio kaze ekzistas (kelkaj grupoj ne havas membreckotizon).

  • GET - /grupoj/:id/kotizoj

Parametroj

  • id: la ID de la membrgrupo laŭ nia datumbazo.

Rezultoj

  • 200: En ordo. Ekzemplo de atendata rezulto:
[
  {
    "id": 3,
    "prezo": 500,
    "priskribo": "priskribo varchar(255)",
    "lando": 26,
    "monero": "Pundo",
    "idGrupo": 7
  }
...
]

Sciigo: La prezo ĉiam estas centobligita por ne bezoni gardi "float" numeroj, do 100 eŭroj estas fakte 1 eŭro.

Membriĝi en UEA

Reveni supren

Ĝi utilas por membriĝi iun uzanton en la organizo.

  • POST - /grupoj/:id/anoj

Parametroj

  • id: Path parametro kun la id de la grupo;
  • Body:
    • idAno: La id de la uzanto kiu aniĝos je la grupo. Ekzemple 1;
    • komencdato: Ekde kiam la homo membras en tiu grupo. Ekzemple 2017-01-01;
    • findato: Ĝis kiam tiu homo estos en tiu grupo. Ekzemple 2018-01-01. Opcia;
    • dumviva: Boolean por diri ĉu la membreco estos dumviva aŭ ne. Eblaj valoroj 0 aŭ 1;
    • observoj: Observoj pri la membreco. Opcia.

Ĝeneralaĵoj

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."
        },
        ...
     ]

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": "[email protected]"
            "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": "[email protected]"
            "tttpagxo": "http://bejo.esperanto.org.br"
        },
        ...
     ]

Preni publikajn datumojn de Perantoj

Reveni supren

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

  • GET - /Perantoj

Filtriloj

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

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

Rezulto

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

     [
   {
     "id": 1,
     "publikaNomo": "BEL",
     "idLando": 25
   },
   {
      "id": 2,
      "publikaNomo": "Ana",
      "idLando": 25
    }
  ...
  ]

Rilate al laborgrupoj

Laborgrupoj estas tiuj kiuj rekte laboras al la bonfartigo de la organizo. Ekzemple: Estraro, Oficistoj, Volontuloj, ktp.

Preni liston de laborogrupoj

Reveni supren

Ĝi montras liston de laborgrupoj.

  • GET - /Grupoj/Laboroj/

Parametroj

Ne estas.

Rezultoj

  1. Ĉio enordas. Ekzemplo de la atendata rezulto estas la jena:
     [
        {
            "id": 1,
            "nomo": "Estraro",
            "priskribo": "La grupo kiu gvidas UEA",
            "idAsocio": 1
        },
        ...
     ]

Preni informojn pri la anoj de iu laborgrupo

Reveni supren

Ĝi montras bazajn informojn de estraranoj.

  • GET - /Grupoj/Laboroj/:id/anoj

Parametroj

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"
        },
        ...
     ]

Kongresoj

Preni informojn pri kongresoj

Reveni supren

GET - /Kongresoj/: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 informojn pri kromaj kongresoj de iu kongreso

Reveni supren

GET - /Kongresoj/:id/kromaj

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

Parametroj

Rezultoj

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

    [
        {
            "id": 2,
            "titolo": "Antaŭ kongreso 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"
            "idCxefaKongreso": 1,

        }
    ]

Preni liston de aliĝintoj de iu kongreso

Reveni supren

  • GET - /Kongresoj/:id/Aligxintoj

Parametroj

  • id : Path parametro por la ID de la kongreso. Ekzemple, /kongresoj/1 donos informojn pri la kongreso kun ID 1 en nia sistemo. Deviga

Filtriloj

Filtriloj aplikeblas. Kelkaj utilaj filtriloj:

  • lando: Oni filtros laŭ la lando de la aliĝinto.

Rezultoj

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

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

Preni liston de aliĝkotizoj de iu kongreso

Reveni supren

Ĝi redonos aliĝikotizoj por la kongreso.

  • GET - /Kongresoj/:id/Aligxkotizoj

Parametroj

  • id : Path parametro por la ID de la kongreso. Ekzemple, /kongresoj/1 donos informojn pri la kongreso kun ID 1 en nia sistemo. Deviga

Rezultoj

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

         [
        {
            "id": 1,
            "aligxperiodo": 1,
            "prezo": 100,
            "gxis_naskigxjaro ": 1982,
            "landkategorio": 2,
            "grupo": 1,
            "priskribo": "Por junuloj el landoj A",
        },
        ...
     ]

Preni liston de programeroj de iu kongreso

Reveni supren

Ĝi redonos la programerojn por la kongreso.

  • GET - /Kongresoj/:id/Programeroj

Parametroj

  • id : Path parametro por la ID de la kongreso. Ekzemple, /kongresoj/1 donos informojn pri la kongreso kun ID 1 en nia sistemo. Deviga

Filtriloj

Utilas filtri per la programejoj, kaj la kategorioj

Rezultoj

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

         [
        {
            "id": 1,
            "idKongreso": 2, 
            "komenctempo": 10-10-2010 14:00,
            "fintempo": 10-10-2010 16:00,
            "evento": "Prelego pri Muziko",
            "priskribo": "En tiu ĉi prelego oni studos muzikon...",
            "idkategorio": 1,
            "idprogramejo": 2,
        },
        ...
     ]

Preni liston de lokoj de programeroj de iu kongreso

Reveni supren

Ĝi redonos la programejojn por la kongreso.

  • GET - /Kongresoj/:id/Programejoj

Parametroj

  • id : Path parametro por la ID de la kongreso. Ekzemple, /kongresoj/1 donos informojn pri la kongreso kun ID 1 en nia sistemo. Deviga

Rezultoj

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

         [
        {
            "id": 1,
            "idkongreso": 2, 
            "nomo": "Ĉambro L.L. Zamenhof", 
            "priskribo": "Granda ĉambro en la unua etaĝo"
        },
        ...
     ]

Preni liston de kategorioj de programeroj

Reveni supren

Ĝi redonos la kategoriojn por la kongreso.

  • GET - /Kongresoj/programkategorioj

Parametroj

Ne estas.

Rezultoj

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

         [
        {
            "id": 1,
            "titolo": "IKU", 
        },
        ...
     ]
Clone this wiki locally