Klienci¶

Struktura danych jest dostępna na tej stronie Klienci

Lista¶

Adres api.infirma.pl/api/klienci

Metoda GET

Parametry query

Parametr	Typ	Domyślnie	Opis
`strona`	`int`	1	strona wyników
`na_stronie`	`int`	10	liczba wyników na stronie
`pola`	`text[]`	Wszystkie pola obiektu	zwracane pola obiektu
`warunki`	`object`	–	tablica warunków, które obiekt musi spełnić w formacie: `POLE_ID:{value: WARTOSC, operator: OPERATOR}` gdzie: `POLE_ID` to id pola wg struktury danych `WARTOSC` to wartość jaką pole ma zadaną `OPERATOR` to operator dla pola. Nie jest to pole obowiązkowe Jeżeli podasz wiele warunków wszystkie muszą być spełnione przykład: `[{nazwa: {value: 'Lukana', operator: 'equals'}, nazwa_skrocona: {value: 'Lukana'}]}`
`POLE_ID`	`any`	–	Jest to skrótowa forma warunków. Można wpisać nazwę pola zamiast `POLE_ID` i wartość, która to pole ma spełniać. Wówczas system użyje domyślnego operatora wyszukiwania np. przy polach tekstowych operatora `like` przykład: `nazwa_skrocona=Lukana`

Zwraca

Tabelę obiektów

Liczba wyników¶

Adres api.infirma.pl/api/klienci/wynikow

Metoda GET

Parametry query

Parametr Typ Domyślnie Opis

warunki

object

–

tablica warunków, które obiekt musi spełnić w formacie:

POLE_ID:{value: WARTOSC, operator: OPERATOR}

gdzie:

POLE_ID to id pola wg struktury danych
WARTOSC to wartość jaką pole ma zadaną
OPERATOR to operator dla pola. Nie jest to pole obowiązkowe

Jeżeli podasz wiele warunków wszystkie muszą być spełnione

przykład: [{nazwa: {value: 'Lukana', operator: 'equals'}, nazwa_skrocona: {value: 'Lukana'}]}

POLE_ID

any

–

Jest to skrótowa forma warunków. Można wpisać nazwę pola zamiast POLE_ID i wartość, która to pole ma spełniać. Wówczas system użyje domyślnego operatora wyszukiwania np. przy polach tekstowych operatora like

przykład: nazwa_skrocona=Lukana

Zwraca

Liczbę dostępnych elementów

Szczegóły¶

Adres api.infirma.pl/api/klienci/id

Metoda GET

Atrybuty adresu

id Id elementu

Zwraca

Dane elementu

Dodawanie¶

Adres api.infirma.pl/api/klienci

Metoda POST

Parametry post

Jako parametr post powinien być podany obiekt w formacie POLE_ID: WARTOSC zgodne ze strukturą danych

Zwraca

Nowo dodany element

Zamiana¶

Adres api.infirma.pl/api/klienci/id

Metoda PATCH

Atrybuty adresu

id Id elementu

Parametry post

Jako parametr post powinien być podany obiekt w formacie {POLE_ID: WARTOSC} zgodne ze strukturą danych

Zwraca

Zmieniony element