Przejdź do treści Przejdź do głównej nawigacji Przejdź do stopki

Profile Instytucji (institution-profile-controller)

institution-profile-controllerREST API związane z profilami instytucji

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

OPIS:
Końcówka umożliwia usunięcie pojedynczego oświadczenia lub wielu oświadczeń w ramach instytucji zalogowanego użytkownika. Oświadczenia mogą być usuwane dla jednej lub wielu wskazanych publikacji.

W celu usunięcia oświadczeń niezbędne jest wprowadzenie X-App-Id, X-App-Token oraz X-User-Token w nagłówkach (headers). Usunięcie danych z Profilu Instytucji wymaga autoryzacji, analizie poddawane są wprowadzone tokeny – sprawdzane jest posiadanie roli Importera Publikacji dla podmiotu, z którego usuwane są dane (Importer najwyższego rzędu lub Importer Instytucji podrzędnej).

W ciele żądania konieczne jest wskazanie:
publicationId – ID publikacji, dla których oświadczenia mają zostać usunięte – możliwe jest podanie jednej lub wielu publikacji;
statementsOfPersons –  ze wskazaniem PersonID – ID osób, których oświadczenia mają zostać usunięte ze wskazanej publikacji (możliwe jest wskazanie jednej lub wielu osób).

ZASTOSOWANIE:
opis w przygotowaniu


GET
/v1/institutionProfile/publications/page
Pobieranie strony z publikacjami instytucji użytkownika

OPIS:
Końcówka umożliwia pobranie listy publikacji znajdujących się w Profilu Instytucji (są to wszystkie publikacje, które wezmą udział w procesie ewaluacji) użytkownika wykonującego żądanie. Aby pobrać listę publikacji z Profilu Instytucji niezbędne jest wprowadzenie X-App-Id, X-App-Token oraz X-User-Token w nagłówkach (headers). X-User-Token, czyli token użytkownika jest wymagany w przypadku tej końcówki, ponieważ pobranie danych o publikacjach z danego podmiotu wymaga dodatkowej autoryzacji – analizie poddawane są wprowadzone tokeny – sprawdzane jest posiadanie roli Importera Publikacji dla podmiotu, z którego pobierane są dane (Importer najwyższego rzędu lub Importer Instytucji podrzędnej).

Żądanie zwróci pełne dane wszystkich publikacji, które znajdują się w Profilu Instytucji zautoryzowanego użytkownika. Dla poszczególnych publikacji wyniki żądania zawierają między innymi: dane autorów (oraz inne role osób, o ile występują) oraz ich numery ORCID (jeśli są powiązani z ORCID i POL-on), objectId publikacji, typ publikacji, tytuł, DOI lub URL, rok wydania, informację o Open Access, abstrakt, informacje o czasopiśmie, wydawnictwie lub konferencji, afiliacje osób, itd. W tej końcówce nie ma informacji o dyscyplinach oświadczeń osób.

ZASTOSOWANIE:
opis w przygotowaniu


GET
/v1/institutionProfile/publications/page/statements
Pobieranie strony z oświadczeniami instytucji użytkownika

OPIS:
Końcówka umożliwia pobranie listy oświadczeń znajdujących się w Profilu Instytucji użytkownika wykonującego żądanie. Aby pobrać listę publikacji z Profilu Instytucji niezbędne jest wprowadzenie X-App-Id, X-App-Token oraz X-User-Token w nagłówkach (headers). X-User-Token, czyli token użytkownika jest wymagany w przypadku tej końcówki, ponieważ pobranie danych o publikacjach z danego podmiotu wymaga dodatkowej autoryzacji – analizie poddawane są wprowadzone tokeny – sprawdzane jest posiadanie roli Importera Publikacji dla podmiotu, z którego pobierane są dane (Importer najwyższego rzędu lub Importer Instytucji podrzędnej).

Żądanie zwróci listę wszystkich oświadczeń z Profilu Instytucji zautoryzowanego użytkownika. Na informacje o poszczególnych oświadczeniach składa się id oświadczenia (id), object ID instytucji (institutionId), object ID osoby (personId), object ID publikacji (publicationId), data dodania oświadczenia, dyscyplina oświadczona, informacja czy publikacja znajduje się na koncie ORCID osoby oraz rola osoby w publikacji.

ZASTOSOWANIE:
opis w przygotowaniu


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

OPIS:
Końcówka umożliwia usunięcie pojedynczego oświadczenia, wielu oświadczeń lub wszystkich oświadczeń z konkretnej publikacji w ramach instytucji zalogowanego użytkownika.

W celu usunięcia oświadczeń niezbędne jest wprowadzenie X-App-Id, X-App-Token, X-User-Token w nagłówkach (headers). Dodatkowo należy wskazać ID publikacji w żądaniu, dla której mają być usunięte oświadczenia. Usunięcie danych z Profilu Instytucji wymaga autoryzacji, analizie poddawane są wprowadzone tokeny – sprawdzane jest posiadanie roli Importera Publikacji dla podmiotu, z którego usuwane są dane (Importer najwyższego rzędu lub Importer Instytucji podrzędnej).

W ciele żądania konieczne jest wskazanie, czy chcemy usunąć konkretne oświadczenia dla danej publikacji, czy wszystkie oświadczenia: flaga true lub false oraz podać tablicę statementsOfPersons – ze wskazaniem PersonID – ID osób, których oświadczenia mają zostać usunięte z publikacji (możliwe jest wskazanie jednej lub wybranych osób (flaga false) lub wszystkich osób flaga – true).

ZASTOSOWANIE:
opis w przygotowaniu


POST
/v1/institutionProfile/publications/fees
Masowe dodawanie/edycja opłat w ramach podmiotu z tokena

OPIS:
Końcówka umożliwia masowe dodawanie i edytowanie opłat za publikacje, dla publikacji znajdujących się na Profilu Instytucji podmiotu z tokena.

W celu dodawania / edycji opłat za publikacje niezbędne jest wprowadzenie X-App-Id, X-App-Token, X-User-Token w nagłówkach (headers). Dodatkowo należy wskazać w żądaniu ID publikacji, dla których mają być dodane / edytowane opłaty za publikacje. Dodanie / edycja opłat za publikacje dla publikacji znajdujących się na Profilu Instytucji wymaga autoryzacji, analizie poddawane są wprowadzone ID publikacji – sprawdzane jest czy publikacja znajduje się na Profilu Instytucji podmiotu z tokena i czy jest ona objęta obowiązkiem wprowadzenia opłat.

Żądanie zwiera listę obiektów określających dane o opłatach za publikacje:
{   publicationId:”aaa”,     costFreePublication: false,     researchPotentialFinancialResources: true,     researchOrDevelopmentProjectsFinancialResources: false,     other: false,     amount: 2000.00 }

Dla wskazania źródła finansowania należy zastosować flagę true lub false. Kwota jest wartością liczbową.

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.


POST
/v1/institutionProfile/publications/fees/{publicationId}
Dodawanie/edycja opłaty publikacji w ramach podmiotu z tokena

OPIS:
Końcówka umożliwia dodawanie i edytowanie opłat za publikacje, dla wskazanej w żądaniu publikacji znajdującej się na Profilu Instytucji podmiotu z tokena.

W celu dodawania / edycji opłat za publikacje niezbędne jest wprowadzenie X-App-Id, X-App-Token, X-User-Token w nagłówkach (headers). Dodanie / edycja opłat za publikacje dla publikacji znajdującej się na Profilu Instytucji wymaga autoryzacji, analizie poddawane jest wprowadzone ID publikacji – sprawdzane jest czy publikacja znajduje się na Profilu Instytucji podmiotu z tokena i czy jest ona objęta obowiązkiem wprowadzenia opłat.

Żądanie zwiera obiekty określające dane o opłatach za publikacje:
{   publicationId:”aaa”,     costFreePublication: false,     researchPotentialFinancialResources: true,     researchOrDevelopmentProjectsFinancialResources: false,     other: false,     amount: 2000.00 }

Dla wskazania źródła finansowania należy zastosować flagę true lub false. Kwota jest wartością liczbową.

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.


DELETE
/v1/institutionProfile/publications/fees/ {publicationId}
Usunięcie opłaty danej publikacji w ramach podmiotu z tokena

OPIS:
Końcówka umożliwia usunięcie opłat za publikacje dla wskazanej w żądaniu publikacji, znajdującej się na Profilu Instytucji podmiotu z tokena.

W celu usunięcia opłat za publikacje niezbędne jest wprowadzenie X-App-Id, X-App-Token oraz X-User-Token w nagłówkach (headers). Usunięcie opłat za publikacje wymaga autoryzacji, analizie poddawany jest objectId wskazanej publikacji – sprawdzane jest czy publikacja znajduje się na Profilu Instytucji podmiotu z tokena.
W ciele żądania konieczne jest wskazanie ID publikacji, dla której chcemy usunąć opłaty za publikacje.

Końcówka służy wyłącznie do usuwania opłat za publikacje.
W przypadku wysłania żądania dla publikacji nie znajdującej się na Profilu Instytucji podmiotu z tokena lub publikacji, dla której nie wprowadzono opłat za publikacje API zwróci stosowne komunikaty:

  1. Dla podanej publikacji o objectId …… nie wprowadzono opłat za publikacje.
  2. Podana publikacja o objectId …… nie występuje na Profilu Instytucji o objectId….

DELETE
/v1/institutionProfile/publications/fees
Usunięcie opłat dla wielu publikacji w ramach podmiotu z tokena

OPIS:
Końcówka umożliwia usunięcie opłat za publikacje dla wskazanych w żądaniu publikacji, znajdujących się na Profilu Instytucji podmiotu z tokena.

W celu usunięcia opłat za publikacje niezbędne jest wprowadzenie X-App-Id, X-App-Token oraz X-User-Token w nagłówkach (headers). Usunięcie opłat za publikacje wymaga autoryzacji, analizie poddawane są objectId wskazanych publikacji – sprawdzane jest czy publikacje znajdują się na Profilu Instytucji podmiotu z tokena.

W ciele żądania konieczne jest wskazanie ID publikacji, dla których chcemy usunąć opłaty za publikacje.
Końcówka służy wyłącznie do usuwania opłat za publikacje.

W przypadku wysłania żądania dla publikacji nie znajdującej się na Profilu Instytucji podmiotu z tokena lub publikacji, dla której nie wprowadzono opłat za publikacje API zwróci stosowne komunikaty:

  1. Dla podanej publikacji o objectId …… nie wprowadzono opłat za publikacje.
  2. Podana publikacja o objectId …… nie występuje na Profilu Instytucji o objectId….

GET
/v1/institutionProfile/publications/fees
Pobranie informacji o opłatach publikacji w ramach podmiotu z tokena

OPIS:
Końcówka umożliwia pobranie listy opłat za publikacje dla publikacji znajdujących się w Profilu Instytucji użytkownika wykonującego żądanie i objętych obowiązkiem wprowadzenia opłat. Aby pobrać listę publikacji z Profilu Instytucji niezbędne jest wprowadzenie X-App-Id, X-App-Token oraz X-User-Token w nagłówkach (headers). X-User-Token.

Dane można pobrać albo dla wszystkich publikacji objętych obowiązkiem wprowadzenia opłat albo ograniczając wyszukiwania do następujących filtrów:

  • year (wyszukuje informacje o opłatach dla publikacji opublikowanych w podanym roku publikacji)
  • yearBefore (wyszukuje informacje o opłatach dla publikacji opublikowanych przed podanym rokiem publikacji)
  • yearAfter (wyszukuje informacje o opłatach dla publikacji opublikowanych po podanym roku publikacji)
  • publicationType (wyszukuje informacje o opłatach dla publikacji z podanym typem publikacji)
  • publicationIds (wyszukuje informacje o opłatach dla publikacji z podanymi idetyfikatorami)
  • isCostFreePublication (gdy true wyszukuje informacje o opłatach dla publikacji bezkosztowych, gdy false pomijane są publikacje bezkosztowe)
  • amountFrom (wyszukuje informacje o opłatach dla publikacji z opłatą powyżej kwoty)
  • amountTo (wyszukuje informacje o opłatach dla publikacji z opłatą poniżej kwoty)
  • amount (wyszukuje informacje o opłatach dla publikacji z opłatą w podanej kwocie)
  • inOpenAccess (gdy true wyszukuje informacje o opłatach dla publikacji sprawozdanych w otwartym dostępie, gdy false pomijane są publikacje sprawozdane w otwartym dostępie)

W żądaniu należy wpisać filtry, które mają zostać uwzględnione.
Żądanie zwróci listę lub stronę dopasowanych informacji o opłatach za publikacje dla publikacji występujących na Profilu Instytucji podmiotu z tokena. Dla poszczególnych publikacji wyniki żądania zawierają następujące dane: publicationId ; publicationType ; title ; year ; isbn ; inOpenAccess (wyłącznie jako flaga true jest publikacja jest publikacją open access lub flaga false jeśli publikacja nie jest publikacją open access) ; publisher (objectId; mniswId; name) ; journal (objectId; mniswId; title; issn; eissn); informację o opłatach – fee (flaga true lub false dla wartości costFreePublication; researchPotentialFinancialResources; other; oraz wartości liczbową dla amount).


GET
/v1/institutionProfile/publications/incompleted-fees
Pobranie informacji o nieuzupełnionych opłatach publikacji w ramach podmiotu z tokena

OPIS:
Końcówka umożliwia pobranie listy publikacji znajdujących się w Profilu Instytucji użytkownika wykonującego żądanie i objętych obowiązkiem wprowadzenia opłat, dla których to publikacji nie wprowadzono opłat za publikacje. Aby pobrać listę publikacji z Profilu Instytucji niezbędne jest wprowadzenie X-App-Id, X-App-Token oraz X-User-Token w nagłówkach (headers). X-User-Token.

Dane można pobrać albo dla wszystkich publikacji objętych obowiązkiem wprowadzenia opłat albo ograniczając wyszukiwania do następujących filtrów:

  • year (wyszukuje informacje o opłatach dla publikacji opublikowanych w podanym roku publikacji)
  • yearBefore (wyszukuje informacje o opłatach dla publikacji opublikowanych przed podanym rokiem publikacji)
  • yearAfter (wyszukuje informacje o opłatach dla publikacji opublikowanych po podanym roku publikacji)
  • publicationType (wyszukuje informacje o opłatach dla publikacji z podanym typem publikacji)
  • publicationIds (wyszukuje informacje o opłatach dla publikacji z podanymi idetyfikatorami)
  • inOpenAccess (gdy true wyszukuje informacje o opłatach dla publikacji sprawozdanych w otwartym dostępie, gdy false pomijane są publikacje sprawozdane w otwartym dostępie)

W żądaniu należy wpisać filtry, które mają zostać uwzględnione.
Żądanie zwróci listę lub stronę dopasowanych informacji o publikacjach występujących na Profilu Instytucji podmiotu z tokena i objętych obowiązkiem wprowadzenia opłat, dla których to publikacji nie wprowadzono informacji o opłatach. Dla poszczególnych publikacji wyniki żądania zawierają następujące dane: publicationId ; publicationType ; title ; year ; isbn ; inOpenAccess (wyłącznie jako flaga true jest publikacja jest publikacją open access lub flaga false jeśli publikacja nie jest publikacją open access) ; publisher (objectId; mniswId; name) ; journal (objectId; mniswId; title; issn; eissn).