Osoby

Obsah

Zoznam osôb #

Rozhranie dodáva zoznam osôb.

• URL: GET /interface/{db}/eshop/v1/osoby/zoznam
• Status: implementované
• Bearer: áno

Parametre:

• firma_id=X (voliteľný) - Dodá zoznam osôb, ktoré patria pod konkrétnu firmu.
• email=X (voliteľný) - Dodá zoznam osôb, ktoré majú zadaný email.

Vytvorenie novej osoby #

Rozhranie vytvorí novú osobu.

• URL: POST /interface/{db}/eshop/v1/osoby/vytvor
• Status: implementované
• Bearer: áno

Limity na zasielané parametre:

• priezvisko(50) - Povinný parameter. Nesmie mať nulovú dĺžku.
• meno(50)
• ulica(50)
• mesto(30)
• psc(10)
• firma_id(integer) - Odkaz na firmu (ID z číselníka firiem). Voliteľný parameter.
• primarny(boolean) - Určuje, či je osoba primárnym kontaktom pre danú firmu.
• mobil(20)
• email(100)

Vysvetlenie činnosti pri vytváraní #

• Ak je osoba priraďovaná k firme (firma_id je zadané):
  • Pokiaľ nie je parameter primarny explicitne zadaný a firma zatiaľ nemá žiadny iný primárny kontakt, táto nová osoba sa automaticky nastaví ako primárny kontakt (primarny = true).
  • Pokiaľ je parameter primarny explicitne nastavený na true, systém automaticky zruší príznak primárneho kontaktu u všetkých ostatných osôb v danej firme a primárnym kontaktom pre túto firmu zostane iba novovytvorená osoba.

Možné chybové stavy (HTTP 400) #

• Parameter priezvisko je povinný a nesmie mať nulovú dĺžku. - ak chýba priezvisko.
• Pridanie osoby sa ti podarilo, ale toto je testovacia verzia bez zápisu a tak sa to do databázy neprenieslo. Formálne si ale splnil podmienky validity. - v testovacom režime, keď je zápis zablokovaný.

Príklad požiadavky #

{
  "meno": "Jozef",
  "priezvisko": "Mrkvička",
  "ulica": "Zelená 12",
  "mesto": "Bratislava",
  "psc": "81101",
  "firma_id": 123,
  "primarny": true,
  "mobil": "0900123456",
  "email": "jozef.mrkvicka@mojafirma.sk"
}

Príklad odpovede #

{
  "id": 456
}

Aktualizácia osoby #

Rozhranie slúži na aktualizovanie údajov o existujúcej osobe.

• URL: POST /interface/{db}/eshop/v1/osoby/aktualizuj
• Status: implementované
• Bearer: áno

Identifikačné parametre (povinný):

• osoba_id - Explicitné ID osoby, ktorá sa má aktualizovať.

Limity na zasielané parametre na aktualizáciu sú zhodné s vytváraním osoby. Ak sa nejaký parameter neuvedie, jeho hodnota sa v databáze nemení. Zoznam voliteľných parametrov:

• priezvisko(50)
• meno(50)
• ulica(50)
• mesto(30)
• psc(10)
• firma_id(integer)
• primarny(boolean) - Ak sa nastaví na true, systém automaticky zruší tento príznak pre všetky ostatné osoby v tej istej firme.
• mobil(20)
• email(100)

Možné chybové stavy (HTTP 400) #

• Parameter osoba_id je povinný pre aktualizáciu. - ak nie je zadané ID osoby.
• Osoba s ID {osoba_id} neexistuje. - ak sa zadaná osoba nenájde v databáze.
• Firma s ID {firma_id} neexistuje. - ak je zadané ID firmy, ale taká firma v databáze neexistuje.

Príklad požiadavky #

{
  "osoba_id": 456,
  "mobil": "0911987654",
  "mesto": "Košice"
}

Príklad odpovede #

{
  "id": 456
}