POST Api/Countries/Search
Pobiera odfiltrowaną listę obiektów Country
Request Information
URI Parameters
None.
Body Parameters
ustawienia filtrowania i sortowania wyników
CountryFilterName | Description | Type | Additional information |
---|---|---|---|
TextFilter |
Filtrowanie w zależności od tekstu. Jeśli null to brak filtrowania. |
string |
None. |
SortOrder |
Określa sposób sortowania wyników |
CountrySortEnum |
Required |
ItemsPerPage |
Ilość obiektów na stronę |
integer |
None. |
CurrentPage |
Obecna strona |
integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "textFilter": "sample string 1", "sortOrder": 0, "itemsPerPage": 2, "currentPage": 3 }
multipart/form-data
Sample:
{"textFilter":"sample string 1","sortOrder":0,"itemsPerPage":2,"currentPage":3}
application/xml, text/xml
Sample:
<CountryFilter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ItemsPerPage>2</ItemsPerPage> <CurrentPage>3</CurrentPage> <TextFilter>sample string 1</TextFilter> <SortOrder>CountryIdAsc</SortOrder> </CountryFilter>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
lista obiektów Country zgodna z ustawieniem filtrowania oraz całkowita liczba wszystkich elementów w bazie spełniających kryteria (całkowita liczba obiektów jest obliczana tylo dla pierwszej strony CurrentPage == 0)
CountryResultsName | Description | Type | Additional information |
---|---|---|---|
Countries |
Lista elementów zgodna z ustawieniami stronnicowania |
Collection of CountryDto |
None. |
TotalElements |
Całkowita liczba elementów w bazie danych spełniających warunki filtrowania |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "countries": [ { "countryId": 1, "name": "sample string 2" }, { "countryId": 1, "name": "sample string 2" } ], "totalElements": 1 }
multipart/form-data
Sample:
{"countries":[{"countryId":1,"name":"sample string 2"},{"countryId":1,"name":"sample string 2"}],"totalElements":1}