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

Osoby (person-controller)

person-controllerREST API związane z osobami

GET
/v1/person/institution/{id}
Pobierz osobę według identyfikatora instytucji

OPIS:
Końcówka umożliwia pobranie listy osób na podstawie identyfikatora (objectId) instytucji, w której osoby te są zatrudnione. Aby pobrać W tym celu niezbędne jest wprowadzenie X-App-Id, X-App-Token w nagłówkach (headers) oraz objectId instytucji zatrudniającej (mongoId) w żądaniu.

Żądanie zwróci listę osób zatrudnionych w danej instytucji na podstawie wprowadzonego identyfikatora tej instytucji. Dane o osobach, jakie są zwracane w tym żądaniu to imię, nazwisko, tytuł, identyfikator instytucji, nazwa instytucji, numer ORCID przypisany do osoby, identyfikator osoby (person Id – jest to object ID z bazy mongo), numer UUID z POL-on przypisany do osoby w tej instytucji, której id wprowadzono. Dane pochodzą z systemu POL-on. 

ZASTOSOWANIE:
opis w przygotowaniu

 

GET
/v1/person/natural/{id}
Pobierz metadane osoby za pomocą jej naturalnego identyfikatora.

OPIS:
Końcówka umożliwia pobranie metadanych o osobie na podstawie jej naturalnego identyfikatora (naturalId). Aby pobrać dane osoby niezbędne jest wprowadzenie X-App-Id, X-App-Token w nagłówkach (headers) oraz naturalId osoby w żądaniu. Naturalny identyfikator (naturalId) osoby to zahashowany PESEL lub kod kraju, który wydał dokument i numer dokumentu w przypadku obcokrajowca. Funkcja hashująca to SHA-512.

Żądanie zwróci metadane osoby. Dane osoby, jakie są zwracane w tym żądaniu to objectId (mongoId) osoby, imię, nazwisko, identyfikator zatrudniającej ją instytucji, nazwa tej instytucji, numer ORCID przypisany do osoby, identyfikator osoby (person Id – jest object ID z bazy mongo), numer UUID z POL-on przypisany do osoby w tej instytucji. Dane pochodzą z systemu POL-on. 

ZASTOSOWANIE:
opis w przygotowaniu

 

GET
/v1/person/page
Pobierz stronę wszystkich osób zaangażowanych w publikacje według kryteriów statusu

OPIS:
Końcówka umożliwia pobranie listy osób z systemu PBN, według ich statusu. Aby pobrać listę osób niezbędne jest wprowadzenie X-App-Id, X-App-Token w nagłówkach (headers) oraz opcjonalnie zakresu numerów stron oraz rozmiaru strony wyników (liczba osób wyświetlonych na stronie) oraz statusu (ACTIVE lub DELETED) w żądaniu.

Żądanie zwróci metadane wszystkich osób z systemu według ich statusu (aktywny lub usunięty). Wynik żądania zawiera identyfikator osoby (mongoId = objectId), imię, nazwisko, tytuł naukowy oraz informację o instytucji, w której trwa aktualne zatrudnienie (identyfikator oraz nazwę instytucji).

ZASTOSOWANIE:
opis w przygotowaniu

 

GET
/v1/person/version/{version}
Pobierz metadane osoby według jednej z jej wersji

OPIS:
opis w przygotowaniu

ZASTOSOWANIE:
opis w przygotowaniu

 

GET
/v1/person/{id}
Pobierz rozszerzone metadane osoby według identyfikatora obiektu

OPIS:
Końcówka umożliwia pobranie metadanych o osobie na podstawie jej identyfikatora – objectId (= mongoId, personId). Aby pobrać dane osoby niezbędne jest wprowadzenie X-App-Id, X-App-Token w nagłówkach (headers) oraz objectId osoby w żądaniu. 

Żądanie zwróci metadane osoby. Dane osoby, jakie są zwracane w tym żądaniu to objectId (mongoId) osoby, imię, nazwisko, informacje dotyczące aktualnego zatrudnienia (identyfikator oraz nazwa zatrudniającej instytucji), numer ORCID przypisany do osoby (o ile osoba ta powiązała konta PBN, ORCID i POL-on) oraz powiązane publikacje (publikacje, w których wskazano tę osobę jako autora, redaktora, itp.)


ZASTOSOWANIE:
opis w przygotowaniu