Publikacje (publications-controller)
publications-controller – REST API związane z publikacjami
| POST /v1/publications | Dodaj lub edytuj publikację |
OPIS:
Końcówka umożliwia dodanie nowej lub edytowanie istniejącej publikacji za pomocą API. Dodawanie lub edytowanie publikacji wymaga autoryzacji, analizie poddawane są wprowadzone nagłówki żądania:
- X-App-Id – identyfikator zarejestrowanej aplikacji reprezentującej instytucję
- X-App-Token – token dla aplikacji wystawiony podczas rejestracji
- X-User-Token – token pozyskany przez użytkownika w ramach ww. aplikacji (instrukcja pozyskiwania tokenu użytkownika znajduje się tutaj)
Przykładowy minimalny i przykładowy maksymalny zestaw pól w celu dodania poszczególnych typów publikacji za pomocą API (KLIKNIJ NA TYP PUBLIKACJI, ABY OTWORZYĆ PLIK):
1. Artykuł_2021-01-28
2. Książka pod redakcją_2021-01-28
3. Rozdział-2021-10-28
4. Książka 2021-04-09
5. Tom pokonferencyjny_2021-01-28
6. Artykuł w tomie pokoferencyjnym_2021_04_16
W przypadku edycji publikacji, minimalny zestaw pól jest taki sam jak w przypadku jej dodawania. Identyfikacja publikacji w przypadku jej aktualizacji (edycji) odbywa się za pomocą objectId (id publikacji z mongo) i DOI (jeśli DOI nie było pierwotne podane to może być null lub bez DOI) lub tylko DOI.
W przypadku dodawania / edycji monografii i książki pod redakcją połączonej z wydawnictwem spoza listy ministerialnej występującym już w PBN i z wydawnictwem z listy ministerialnej dane dla wydawnictwa należy podać w następujący sposób:
Walidacje przy dodawaniu publikacji (POST /v1/publications):
Opis walidacji na nadsyłanych publikacjach. Kliknij tutaj, aby otworzyć: publikacje przesyłane przez API_opis walidacji_29 09 2021
Mapowanie kodów dyscyplin między PBN a POL-on. Kliknij tutaj, aby otworzyć: dyscypliny_polon_pbn2
Rozszerzono działanie końcówki o możliwość dodania / edycji opłat za publikacje.
W ciele żądania należy podać informacje dotyczące opłat za publikacje. Dodanie / edycja opłat w ramach końcówki wymaga autoryzacji – sprawdzane jest czy publikacja, dla której dodawane / edytowane są opłaty za publikacje jest objęta obowiązkiem wprowadzenia opłat.
W ciele żądania należy podać:
fee: { costFreePublication: false, researchPotentialFinancialResources: true, researchOrDevelopmentProjectsFinancialResources: false, other: false, amount: 2000.00 }
Dla costFreePublication oraz źródeł finansowania stosowana jest flaga true lub false. Wartość amount wyrażana jest liczbą.
Poprawnie przesłane żądanie musi mieć wskazane źródło bądź źródła finansowania oraz kwotę. Dla publikacji bezkosztowej (costFreePublication) źródła finansowania muszą posiadać flagę false oraz wartość amount równą 0. W przypadku błędnego przesłania opłat API zwróci odpowiedni komunikat błędu.
| GET /v1/publications/doi | Pobierz metadane publikacji za pomocą DOI (Digital Object Identifier) |
OPIS:
Końcówka umożliwia pobranie danych o publikacji na podstawie jej numeru DOI. Aby pobrać dane o publikacji wymagane jest wprowadzenie X-App-Id, X-App-Token w nagłówkach (headers) oraz numer DOI publikacji w żądaniu.
Żądanie zwróci rozszerzone dane publikacji, takie jak: tytuł, DOI, ISBN w przypadku książki, typ publikacji, abstrakt, rok publikacji, język, autorzy, redaktorzy, afiliacje (jeśli są) publikacji, powiązane z publikacją linki takie jak: szczegółowe dane wydawnictwa w przypadku książki, szczegółowe dane czasopisma/konferencji w przypadku artykułu, numer czasopisma dane książki źródłowej w przypadku rozdziału, itp., stopień weryfikacji linków (czyli powiązań pomiędzy obiektami), identyfikatory poszczególnych powiązań, nazwa tabeli w bazie danych z której pochodzą poszczególne obiekty
ZASTOSOWANIE:
opis w przygotowaniu
| GET /v1/publications/id/{id} | Pobierz rozszerzone metadane publikacji według identyfikatora |
OPIS:
Końcówka umożliwia pobranie danych o publikacji na podstawie jej object ID. Aby pobrać dane o publikacji wymagane jest wprowadzenie X-App-Id, X-App-Token w nagłówkach (headers) oraz id publikacji w żądaniu.
Żądanie zwróci rozszerzone dane publikacji, takie jak: object ID, tytuł, DOI, ISBN w przypadku książki, typ publikacji, abstrakt, rok publikacji, język, autorzy, redaktorzy, afiliacje (jeśli są) publikacji, powiązane z publikacją linki takie jak: szczegółowe dane wydawnictwa w przypadku książki, szczegółowe dane czasopisma/konferencji w przypadku artykułu, numer czasopisma dane książki źródłowej w przypadku rozdziału, itp., stopień weryfikacji linków (czyli powiązań pomiędzy obiektami), identyfikatory poszczególnych powiązań, nazwa tabeli w bazie danych z której pochodzą poszczególne obiekty
ZASTOSOWANIE:
opis w przygotowaniu
| POST /v1/publications/import | Importuj listę publikacji w celu dodania lub edycji. |
OPIS:
Końcówka umożliwia zaimportowanie listy publikacji w celu dodania lub edycji istniejących publikacji za pomocą API. Dodawanie lub edytowanie publikacji wymaga autoryzacji, analizie poddawane są wprowadzone nagłówki żądania:
- X-App-Id – identyfikator zarejestrowanej aplikacji reprezentującej instytucję
- X-App-Token – token dla aplikacji wystawiony podczas rejestracji
- X-User-Token – token pozyskany przez użytkownika w ramach ww. aplikacji (instrukcja pozyskiwania tokenu użytkownika znajduje się tutaj)
Minimalny przykładowy zestaw pól w celu importu listy publikacji jest taki sam jak w przypadku dodawania publikacji pojedynczo (KLIKNIJ NA TYP PUBLIKACJI, ABY OTWORZYĆ PLIK):
1. Artykuł
2. Książka pod redakcją
3. Rozdział
4. Książka
W przypadku edycji publikacji identyfikacja publikacji w przypadku jej aktualizacji (edycji) odbywa się za pomocą objectId (id publikacji z mongo) i DOI (jeśli DOI nie było pierwotne podane to może być null lub bez DOI) lub tylko DOI.
Walidacje przy imporcie listy publikacji w celu dodania lub edycji (POST /v1/publications/import):
1. Nie można przesłać wielu publikacji o takim samym typie i numerze DOI
2. Każda z przesyłanych publikacji powinna mieć unikalny tytuł
3. Każda z przesyłanych publikacji powinna mieć unikalny numer ISBN
4. Każda z przesyłanych publikacji powinna mieć unikalny numer ISSN
5. Każda z przesyłanych publikacji powinna mieć unikalny numer ISMN
Rozszerzono działanie końcówki o możliwość dodania / edycji opłat za publikacje.
W ciele żądania należy podać informacje dotyczące opłat za publikacje. Dodanie / edycja opłat w ramach końcówki wymaga autoryzacji – sprawdzane jest czy publikacja, dla której dodawane / edytowane są opłaty za publikacje jest objęta obowiązkiem wprowadzenia opłat.
W ciele żądania należy podać:
fee: { costFreePublication: false, researchPotentialFinancialResources: true, researchOrDevelopmentProjectsFinancialResources: false, other: false, amount: 2000.00 }
Dla costFreePublication oraz źródeł finansowania stosowana jest flaga true lub false. Wartość amount wyrażana jest liczbą.
Poprawnie przesłane żądanie musi mieć wskazane źródło bądź źródła finansowania oraz kwotę. Dla publikacji bezkosztowej (costFreePublication) źródła finansowania muszą posiadać flagę false oraz wartość amount równą 0.
W przypadku błędnego przesłania opłat API zwróci odpowiedni komunikat błędu.
| GET /v1/publications/page | Pobierz stronę ze wszystkimi publikacjami według statusu |
OPIS:
Końcówka umożliwia pobranie listy publikacji według ich statusu. Dostępne statusy to ACTIVE lub DELETED. Aby pobrać listę publikacji według statusu niezbędne jest wprowadzenie X-App-Id, X-App-Token w nagłówkach (headers) oraz opcjonalnie parametrów: zakresu numerów stron, rozmiaru strony wyników (liczba publikacji wyświetlonych na stronie) oraz statusu (ACTIVE lub DELETED) w żądaniu.
Żądanie zwróci dane o publikacjach według ich statusu – aktywny lub usunięty.
ZASTOSOWANIE:
opis w przygotowaniu
| GET /v1/publications/version/{version} | Pobierz metadane publikacji, wpisując klucz istniejącej wersji |
OPIS:
opis w przygotowaniu
ZASTOSOWANIE:
opis w przygotowaniu
| GET /v1/publications/{publicationId}/metadata | Pobierz metadane publikacji według identyfikatora publikacji. |
OPIS:
Końcówka umożliwia pobranie danych o publikacji na podstawie jej object ID. Aby pobrać dane o publikacji wymagane jest wprowadzenie X-App-Id, X-App-Token w nagłówkach (headers) oraz id publikacji w żądaniu.
Żądanie zwróci pełne dane publikacji, takie jak: tytuł, DOI, ISBN w przypadku książki, typ publikacji, abstrakt, rok publikacji, język, autorzy, redaktorzy, afiliacje (jeśli są) publikacji, powiązane z publikacją linki takie jak dane wydawnictwa w przypadku książki, dane czasopisma/konferencji w przypadku artykułu, numer czasopisma dane książki źródłowej w przypadku rozdziału, itp.,
ZASTOSOWANIE:
opis w przygotowaniu