Page tree
Skip to end of metadata
Go to start of metadata

Wyszukiwanie organizacji odbywa się poprzez podanie jednego lub więcej z poniższych kryteriów jako parametr w zapytaniu GET wykonanym na adres URI kolekcji organizacji:

  • /v1/organizations

Przykładowe zapytanie

 

 

GET /v1/organizations HTTP/1.1
Content-Type: application/json

Kryteria wyszukiwania

ParametrTypDziałaniePrzykład
tax_id

String

Wyszukuje organizacje o podanym numerze identyfikacji podatkowej.

?tax_id=12

name

String

Wyszukuje organizacje, których nazwa jest identyczny jak wskazany ciąg.

?name=nazwa_organizacji

address_street

String

Wyszukuje organizacje, w których adres (street lub line1) rozpoczyna się od wskazanego ciągu.

?address_street=ulica

owner_full_nameStringWyszukuje organizacje, w których imię i nazwisko zawiera jak wskazany ciąg.?owner_full_name=imie i nazwisko
application_name
StringWyszukuje organizacje, w których nazwa aplikacji zawiera jak wskazany ciąg.?application_name=nazwa aplikacji

Sortowanie wyników

Wyniki wyszukiwania można sortować przekazując parametr sort_by, który może przyjmować przyjmować następujące wartości:

Wartość sort_byDziałaniePrzykład
idSortuje organizacje po identyfikatorze.?sort_by=id
nameSortuje organizacje po nazwie.?sort_by=name
tax_idSortuje organizacje po numerze identyfikacji podatkowej.?sort_by=tax_id
address_street
Sortuje organizacje po ulicy.?sort_by=address_street
created_atSortuje organizacje po czasie utworzenia.?sort_by=created_at

 

Sortowanie może odbywać się w dwóch kierunkach, poprzez użycie parametru sort_order:

Wartość sort_orderDziałaniePrzykład
ascSortuje organizacje rosnąco?sort_order=asc&sort_by=id
descSortuje organizacje malejąco?sort_order=desc&sort_by=id

Domyślnie wyniki sortowane są malejąco (desc) wg daty utworzenia organizacji (created_at).


 

  • No labels