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

Membra aliro

Ana Ribeiro edited this page Aug 6, 2017 · 10 revisions

Dokumentado

Ĝeneralaĵoj

Personaj informoj

Teko

  • a
  • b

Delegita reto

  • a
  • b

Voĉdonado

Kongresoj

  • a
  • b

Ĝeneralaĵoj

Ensaluti

Reveni supren

Baziita je la informoj donitaj je la uzantnomo, ĝi redonos ĵetonon (Token) kiu estos uzata en aliaj komandoj de tiu ĉi parto de la API.

  • POST - /Uzantoj/Ensaluti

Parametroj

  • Body:
    • uzantnomo: la uzantnomo de la uzanto. Ekzemple LLZamenhof;
    • pasvorto: la pasvorto de la uzanto. Ekzemple pasvorto1234;

Rezultoj

  • 200: Ĉio bonas. Ĝi redonos json kun ĵetono.
  • 401: Malkorekta uzantnomo aŭ pasvorto.

Forgesis pasvorton

Reveni supren

Kiam la uzanto forgesas la pasvorton registritan en la sistemo, ĝi refaras novan pasvorton kaj sendas ĝin retpoŝte al la uzanto. Atentu: por ke tiu funkcios, estas ege grava ke estu en la config arĥivo valida uzantnomo kaj pasvorto por sendado de retmesaĝoj.

  • POST - /Uzantoj/ForgesisPasvorton

Parametroj

  • Body
    • retposxto: la retpoŝto de la uzanto;
    • naskigxtago: la naskiĝtago de la uzanto;

Rezultoj

  • 200: ĉio bonas, ĝi ankaŭ sendos al la homo la mesaĝon kun la nova pasvorto.
  • 400: Ne estas uzanto kun la informitaj datumoj.

Personaj informoj

Preni uzantajn datumojn

Reveni supren

  • GET - /Uzanto/:id

Parametroj

  • id: Path parametro por la id de la uzanto.
  • Header:
    • x-access-token: la token farita en la ensaluta procezo.

Rezultoj

  • 200: Ĉio bonas. Ekzemplo de la atendata rezulto:
[
    {
        "personanomo": "personanomo",
        "familianomo": "undefined",
        "titolo": "titolo",
        "bildo": "bildo",
        "adreso": "adreso",
        "posxtkodo": "idNacialando",
        "idNacialando": 25,
        "idLogxurbo": null,
        "profesio": null
    }
]
  • 403: Malkorekta ĵetono aŭ sen ĵetono.

Ĝisdatigi uzantajn informojn

Reveni supren

Ĝi ĝisdatigas la informojn de la uzanto.

  • POST - /Uzantoj/:id/gxisdatigi

Parametroj

  • id: Path parametro por la ID de la uzanto;

  • Header

    • x-access-token: la token farita en la ensaluta procezo.
  • Body

    • kampo: la kampo kiu estos ĝisdatigita. Ekzemple familianomo;
    • valoro: la valoro de tiu kampo. Ekzemple Smith;

Respondoj

  • 200: Ĉio enordas.
  • 403: Ŝanĝo ne permesata
  • 500: Servila eraro (kontrolu la parametroj por vidi ĉu ili estas korektaj).