Wyszukiwarka (search-controller)

 

search – controller – REST API związane z wyszukiwaniem

 

POST /v1/search/conferences

Wyszukiwanie konferencji wg kryteriów

OPIS:

Końcówka umożliwia wyszukanie konferencji po zdefiniowanych kryteriach. Niezbędne jest wprowadzenie X-App-Id oraz X-App-Token w nagłówkach (headers). Kryteria wyszukiwania definiowane są w ciele żądania (body). Możliwe jest wprowadzenie jednego lub wielu kryteriów, zgodnie z którymi mają zostać zwrócone wartości. Brak definicji jakiegokolwiek kryterium (puste klamry) zwraca pełną listę dostępnych konferencji. Lista wyników jest stronicowana.

Dostępne są następujące kryteria wyszukiwania:

 

• „city” – Miasto, w którym odbyła się konferencja
• „country” – Państwo, w którym odbyła się konferencja
• „edition” – Flaga informująca o tym czy konferencja jest edycją konferencji
• „endDate” – Data zakończenia konferencji
• „endDateFrom” – Data zakończenia konferencji – od
• „endDateTo” – Data zakończenia konferencji – do
• „startDate” – Data rozpoczęcia konferencji
• „startDateFrom” – Data rozpoczęcia konferencji – od
• „startDateTo” – Data rozpoczęcia konferencji – do
• „fullName” – Pełna nazwa konferencji
• „mnisw” – Flaga informująca o tym czy spośród szukanych konferencji uwzględnić tylko te znajdujące się na liście ministerialnej. Domyślnie ustawiana jest wartość true.
• „mniswId” – Identyfikator MNISW konferencji
• „objectId” – Identyfikator obiektu
• „official” – Flaga informująca o tym czy konferencja jest obiektem oficjalnym
• „shortName” – Skrócona nazwa konferencji
• „website” – Strona internetowa konferencji

 

Parametry odnoszące się do stronicowania wyników to:

 

• „page” – Numer strony wyników wyszukiwania, która zostanie wyświetlona.
• „size” – Rozmiar strony wyników wyszukiwania. Definiowana jest ilość wyników na stronie

 

 

ZASTOSOWANIE:

opis w przygotowaniu  

 

POST /v1/search/institutions

Wyszukiwanie instytucji wg kryteriów

OPIS:

Końcówka umożliwia wyszukanie instytucji po zdefiniowanych kryteriach. Niezbędne jest wprowadzenie X-App-Id oraz X-App-Token w nagłówkach (headers). Kryteria wyszukiwania definiowane są w ciele żądania (body). Możliwe jest wprowadzenie jednego lub wielu kryteriów, zgodnie z którymi mają zostać zwrócone wartości. Brak definicji jakiegokolwiek kryterium zwraca pełną listę dostępnych instytucji. Lista wyników jest stronicowana.

Dostępne są następujące kryteria wyszukiwania:

 

• „city” – Siedziba instytucji – nazwa ulicy
• „country” – Siedziba instytucji – państwo
• „email” – Adres e-mail instytucji
• „name” – Nazwa instytucji
• „nameAndRoot”
• „objectId” – Identyfikator obiektu
• „official” – Flaga informująca o tym czy instytucja jest obiektem oficjalnym
• „polon” – Flaga informująca czy instytucja występuje w systemie POL-on
• „rootName” – Nazwa instytucji nadrzędnej
• „postalCode” – Siedziba instytucji – kod pocztowy
• „streetName” – Siedziba instytucji nazwa ulicy
• „streetNumber” – Siedziba instytucji – numer ulicy
• „type” – Typ instytucji. Możliwe wartości: PUBLIC_UNIVERSITY, UNIT, NON_PUBLIC_UNIVERSITY, PUBLIC_INSTITUTIONS_UNION, SUPERVISOR, UNKNOWN, SCIENTIFIC_INSTITUTION
• „website” – Strona internetowa instytucji

 

Parametry odnoszące się do stronicowania wyników to:

 

• „page” – Numer strony wyników wyszukiwania, która zostanie wyświetlona.
• „size” – Rozmiar strony wyników wyszukiwania. Definiowana jest ilość wyników na stronie

 

 

ZASTOSOWANIE:

opis w przygotowaniu  

 

POST /v1/search/journals

Wyszukiwanie czasopism wg kryteriów

Końcówka umożliwia wyszukanie czasopism po zdefiniowanych kryteriach. Niezbędne jest wprowadzenie X-App-Id oraz X-App-Token w nagłówkach (headers). Kryteria wyszukiwania definiowane są w ciele żądania (body). Możliwe jest wprowadzenie jednego lub wielu kryteriów, zgodnie z którymi mają zostać zwrócone wartości. Brak definicji jakiegokolwiek kryterium zwraca pełną listę dostępnych czasopism. Lista wyników jest stronicowana.

Dostępne są następujące kryteria wyszukiwania:

 

• „eissn” – Numer eISSN czasopisma
• „issn” – Numer ISSN czasopisma
• „mnisw” – Flaga informująca o tym czy spośród szukanych wydawców uwzględnić tylko te znajdujące się na liście ministerialnej. Domyślnie ustawiana jest wartość true.
• „mniswId” – Identifikator MNISW czasopisma
• „objectId” – Identyfikator obiektu
• „official” – Flaga informująca o tym czy czasopismo jest obiektem oficjalnym
• „title” – Nazwa instytucji nadrzędnej

 

Parametry odnoszące się do stronicowania wyników to:

 

• „page” – Numer strony wyników wyszukiwania, która zostanie wyświetlona.
• „size” – Rozmiar strony wyników wyszukiwania. Definiowana jest ilość wyników na stronie

 

ZASTOSOWANIE:

opis w przygotowaniu  

 

POST /v1/search/persons

Wyszukiwanie osób wg kryteriów

OPIS:

Końcówka umożliwia wyszukanie osób po zdefiniowanych kryteriach. Niezbędne jest wprowadzenie X-App-Id oraz X-App-Token w nagłówkach (headers). Kryteria wyszukiwania definiowane są w ciele żądania (body). Możliwe jest wprowadzenie jednego lub wielu kryteriów, zgodnie z którymi mają zostać zwrócone wartości. Brak definicji jakiegokolwiek kryterium zwraca pełną listę dostępnych osób. Lista wyników jest stronicowana.

Dostępne są następujące kryteria wyszukiwania:

 

• „employment” – Zatrudnienie osoby
• „firstName” – Imię osoby
• „lastName” – Nazwisko osoby
• „objectId” – Identyfikator obiektu
• „orcid” – Numer osoby w ORCID

 

Parametry odnoszące się do stronicowania wyników to:

 

• „page” – Numer strony wyników wyszukiwania, która zostanie wyświetlona.
• „size” – Rozmiar strony wyników wyszukiwania. Definiowana jest ilość wyników na stronie

 

ZASTOSOWANIE:

opis w przygotowaniu  

 

POST /v1/search/publications

Wyszukiwanie publikacji wg kryteriów

 OPIS:

Końcówka umożliwia wyszukanie publikacji po zdefiniowanych kryteriach. Niezbędne jest wprowadzenie X-App-Id oraz X-App-Token w nagłówkach (headers). Kryteria wyszukiwania definiowane są w ciele żądania (body). Możliwe jest wprowadzenie jednego lub wielu kryteriów, zgodnie z którymi mają zostać zwrócone wartości. Brak definicji jakiegokolwiek kryterium zwraca pełną listę dostępnych publikacji. Lista wyników jest stronicowana.  Możliwe jest wyszukiwanie publikacji po metadanych podstawowych, ale także metadanych obiektów zagnieżdżonych. UWAGA! W przypadku wyszukiwania po ISBN w żądaniu należy wpisać ISBN bez myślników „-„, jako jeden ciąg znaków. 

Dostępne są następujące kryteria wyszukiwania dla metadanych podstawowych:

 

• „authors” – Autorzy w publikacji
• „contributors” – Współtwórcy publikacji (autorzy, redaktorzy, redaktorzy przekładu, tłumacze)
• „doi” – Numer DOI publikacji
• „editors” – Redaktorzy naukowi w publikacji
• „isbn” – Numer ISBN publikacji
• „ismn” – Numer ISMN publikacji
• „issn” – Numer ISSN publikacji
• „objectId” – Identyfikator obiektu
• „orcid” – Flaga informująca o tym czy publikacja jest w ORCID
• „publisherName”  -Nazwa wydawcy powiązanego z publikacją
• „title” – Tytuł publikacji
• „translation”  -Flaga informująca o tym czy publikacja jest przekładem
• „translationEditors” – Redaktorzy przekładu w publikacji
• „translators” – Tłumacze w publikacji
• „type” – Typ publikacji. Możliwe wartości: BOOK, EDITED_BOOK, CHAPTER, ARTICLE, PROCEEDINGS
• „volume” – Numer tomu publikacji
• „year” – Rok publikacji

 

Wyszukiwanie po obiektach zagnieżdżonych dotyczy:

I. book – książki, w węźle zdefiniować można:

 

• „doi” – Numer DOI
• „isbn” – Numer ISBN
• „ismn” – Numer ISMN
• „issn” – Numer ISSN
• „title” – Tytuł

 

II. conference – konferencji, w węźle zdefiniować można:

 

• „fullName” – Pełna nazwa konferencji powiązanej z publikacją
• „shortName” – Skrócona nazwa konferencji powiązanej z publikacją

 

III. journal – czasopism, w węźle zdefiniować można:

 

• „eissn” – Numer EISSN czasopisma powiązanego z publikacją
• „issn” – Numer ISSN czasopisma powiązanego z publikacją
• „title” – Tytuł czasopisma powiązanego z publikacją

 

IV. proceedings – tomów pokonferencyjnych, w węźle zdefiniować można:

 

• „doi” – Numer DOI
• „isbn” – Numer ISBN
• „ismn” – Numer ISMN
• „issn” – Numer ISSN
• „title” – Tytuł

 

Parametry odnoszące się do stronicowania wyników to:

 

• „page” – Numer strony wyników wyszukiwania, która zostanie wyświetlona.
• „size” – Rozmiar strony wyników wyszukiwania. Definiowana jest ilość wyników na stronie

 

ZASTOSOWANIE:

opis w przygotowaniu  

 

POST /v1/search/publishers

Wyszukiwanie wydawnictw wg kryteriów

OPIS:

Końcówka umożliwia wyszukanie wydawnictw po zdefiniowanych kryteriach. Niezbędne jest wprowadzenie X-App-Id oraz X-App-Token w nagłówkach (headers). Kryteria wyszukiwania definiowane są w ciele żądania (body). Możliwe jest wprowadzenie jednego lub wielu kryteriów, zgodnie z którymi mają zostać zwrócone wartości. Brak definicji jakiegokolwiek kryterium zwraca pełną listę dostępnych wydawnictw. Lista wyników jest stronicowana.

Dostępne są następujące kryteria wyszukiwania:

 

• „mnisw” – Identifikator MNISW wydawcy
• „mniswId” – Identifikator MNISW wydawcy
• „name” – Nazwa wydawcy
• „objectId” – Identyfikator obiektu
• „official” – Flaga informująca o tym czy wydawca jest obiektem oficjalnym

 

Parametry odnoszące się do stronicowania wyników to:

 

• „page” – Numer strony wyników wyszukiwania, która zostanie wyświetlona.
• „size” – Rozmiar strony wyników wyszukiwania. Definiowana jest ilość wyników na stronie

 

ZASTOSOWANIE:

opis w przygotowaniu