Hackathon API

Jeśli czasopisma nie pochodzą z listy ministerialnej – należy  w żądaniu podać flagę „mnisw”: false

Np.
{
„issn”: „string”,
„mnisw”: false
}

W przypadku /search conferences, journals, publishers parametr official wskazuje na obiekty z listy MNISW, zatem w przypadku official=true, mnisw=false , podanie tych parametrów wzajemnie się wyklucza

Parametry official i mnisw można stosować zamiennie.

W przypadku kryterium w /search/institutions paramaetr official wskazuje na instytucje z POLONU

Należy skorzystać z końcówek DELETE.

DELETE /v1/institutionProfile/publications
Usunięcie oświadczeń w ramach danej instytucji zalogowanego użytkownika.

DELETE /v1/institutionProfile/publications/{id}
Usunięcie oświadczeń o danej publikacji w ramach instytucji zalogowanego użytkownika.

Dla DELETE /v1/institutionProfile/publications/{id}w ciele żądania należy wpisać all:true

{
"all":true,
"statementsOfPersons":[
{
"personId":"string",
"role":"AUTHOR"
}
]
}

all to Flaga wskazująca na to, że należy usunąć wszystkie oświadczenia w ramach danej publikacji i instytucji.

Nie przewidzieliśmy zapisu formatowania w naszej bazie danych. Przyjęty sposób formatowania musiałby być stosowany nie tylko przez PBN, ale także przez inne systemy, do którego przekazywane dane. Z tego względu nie zalecamy dodawania żadnych znaków specjalnych, które miałyby określać formatowanie – znaki takie zostaną potraktowane jako część tekstu.

W celu usunięcia oświadczeń należy skorzystać z końcówek DELETE

DELETE​/v1​/institutionProfile​/publications
Usunięcie oświadczeń w ramach danej instytucji zalogowanego użytkownika.

DELETE​/v1​/institutionProfile​/publications​/{id}
Usunięcie oświadczeń o danej publikacji w ramach instytucji zalogowanego użytkownika.

W celu zmiany dyscypliny należy dokonać edycji publikacji, podając w węźle statements właściwą dyscyplinę.

Stronicowaną listę publikacji, w tym publikacji usuniętych (definicja po statusie) można pobrać za pomocą końcówki:
GET/v1​/publications​/page
Nie ma możliwości pobierania szczegółów publikacji usuniętych, ponieważ nie było takiego uzasadnienia biznesowego. Ponadto, usunięcie publikacji, jest równoznaczne z usunięciem z danych publikacji obiektów powiązanych (wydawnictwa, czasopisma, autorzy). W przypadku, gdy końcówka do pobierania szczegółów publikacji usuniętych zostałaby wprowadzona trzeba się liczyć, że metadane otrzymanych publikacji byłyby bardzo ograniczone. Nie mamy w API wprowadzonej możliwości pobierania danych po zakresie dat. 

Dostęp do Profili Instytucji mają wyłącznie osoby z rolą Importera Publikacji, natomiast role do SEDN nadawane są niezależnie od tego czy osoba ma rolę Importera Publikacji w PBN. Dlatego te nie ma możliwości by linki prowadziły do rekordu na Profilu Instytucji.

Należy pamiętać aby poprawność danych w SEDN sprawdzać wyłącznie w odniesieniu do danych z Profilu Instytucji.

Opis sytuacji po stronie użytkownika:

W kontekście książek jednym z problemów jest również niemożność edycji poprzez API w przypadku, gdy występują dane pozycje książkowe (o tym samym ISBN) wielokrotnie – otrzymujemy tylko informację, o liście identyfikatorów pozycji o danym ISBN. PBN odpowiada listą ID prac ze zdublowanymi ISBNami i nie ważne, którego z tych ID użylibyśmy do wysłania pracy do API, to odpowiedź jest ta sama. Co najwyżej zmieniają się tylko numery ID zdublowanych prac, albo ich kolejność. 

Rozwiązanie:

W przypadku wystąpienia duplikatów należy zgłosić do Helpdesku prośbę o ich scalenie, wskazując rekord, który ma pozostać w bazie. W systemie PBN został wykonany również proces masowej deduplikacji, jednak nie zlikwidował on duplikatów w 100%.

Nie planujemy umożliwić samego importu. Uprawnienia istniejące w API PBN umożliwiają import i odczyt lub sam odczyt.

Problem dotyczy książek pod redakcją (do których nie mam oświadczenia), konkretnie sytuacji gdy książka pod redakcją została dodana przez inny podmiot i jej opis jest nieprawidłowy – źle określone jest wydawnictwo. Nie mam możliwości edycji tej książki, co za tym idzie nie mam 100% wpływu na to jakie dane sprawozdaję. Co się stanie teraz jeżeli spróbuję przez API wysłać aktualizację do EDITED BOOK o zadanym objectID, której twórcą nie jestem?

Aktualnie istnieje możliwość przesłania do systemu PBN książki pod redakcją opcjonalnie bez oświadczenia. Zapis danych publikacji w trakcie edycji przez API został rozszerzony, dzięki czemu aktualizacji podlegają zarówno metadane publikacji, jak również powiązania pomiędzy obiektami (czyli np. wydawnictwo w książce).