Osoby (person-controller)
person-controller – REST 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.
UWAGA: rozszerzono wyniki zwracane przez końcówkę o dane dotyczące archiwalnego zatrudnienia w danej jednostce (atrybut „from”; atrybut „to”) oraz o informację, czy dana osoba jest uczestnikiem szkoły doktorskiej (atrybut „phdStudent”: o wartości true, gdy osoba jest uczestnikiem szkoły doktorskiej i wartości false dla osoby zatrudnionej w jednostce i nie będącej uczestnikiem szkoły doktorskiej)
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.
UWAGA: rozszerzono wyniki zwracane przez końcówkę o dane dotyczące archiwalnego zatrudnienia w danej jednostce. Dodano węzeł „archivalEmployments” o następujących atrybutach: { „institutionId” : ObjectId(„5e70918b878c28a04737de34”), „uuidInstitution” : „dbdda9a7-f6f7-44e8-af1d-9863e2256ca3”, „from” : ISODate(„1972-09-30T23:00:00.000Z”), „to” : ISODate(„2012-09-29T22:00:00.000Z”), „institutionDisplayName” : „Politechnika Wrocławska”, „areas” : [], „uuidPerson” : „1647d6b4-4241-4b32-a6d4-22a59eb2dfbb”, „phdStudent” : false }
Dane dotyczące archiwalnego zatrudnienia zwracane są wyłącznie jeśli zatrudnienie miało miejsce w jednostce, która odpytuje API. Jeśli w ramach jednostki osoba nie posiada archiwalnego zatrudnienia lub też posiada archiwalne zatrudnienia w innej jednostce informacje o tym zatrudnieniu nie są zwracane.
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).
UWAGA: rozszerzono wyniki zwracane przez końcówkę o dane dotyczące archiwalnego zatrudnienia w danej jednostce. Dodano węzeł „archivalEmployments” o następujących atrybutach: { „institutionId” : ObjectId(„5e70918b878c28a04737de34”), „uuidInstitution” : „dbdda9a7-f6f7-44e8-af1d-9863e2256ca3”, „from” : ISODate(„1972-09-30T23:00:00.000Z”), „to” : ISODate(„2012-09-29T22:00:00.000Z”), „institutionDisplayName” : „Politechnika Wrocławska”, „areas” : [], „uuidPerson” : „1647d6b4-4241-4b32-a6d4-22a59eb2dfbb”, „phdStudent” : false }
Dane dotyczące archiwalnego zatrudnienia zwracane są wyłącznie jeśli zatrudnienie miało miejsce w jednostce, która odpytuje API. Jeśli w ramach jednostki osoba nie posiada archiwalnego zatrudnienia lub też posiada archiwalne zatrudnienia w innej jednostce informacje o tym zatrudnieniu nie są zwracane.
ZASTOSOWANIE:
opis w przygotowaniu
| GET /v1/person/version/{version} |
Pobierz metadane osoby według jednej z jej wersji |
OPIS:
opis w przygotowaniu
UWAGA: rozszerzono wyniki zwracane przez końcówkę o dane dotyczące archiwalnego zatrudnienia w danej jednostce. Dodano węzeł „archivalEmployments” o następujących atrybutach: { „institutionId” : ObjectId(„5e70918b878c28a04737de34”), „uuidInstitution” : „dbdda9a7-f6f7-44e8-af1d-9863e2256ca3”, „from” : ISODate(„1972-09-30T23:00:00.000Z”), „to” : ISODate(„2012-09-29T22:00:00.000Z”), „institutionDisplayName” : „Politechnika Wrocławska”, „areas” : [], „uuidPerson” : „1647d6b4-4241-4b32-a6d4-22a59eb2dfbb”, „phdStudent” : false }
Dane dotyczące archiwalnego zatrudnienia zwracane są wyłącznie jeśli zatrudnienie miało miejsce w jednostce, która odpytuje API. Jeśli w ramach jednostki osoba nie posiada archiwalnego zatrudnienia lub też posiada archiwalne zatrudnienia w innej jednostce informacje o tym zatrudnieniu nie są zwracane.
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.)
UWAGA: rozszerzono wyniki zwracane przez końcówkę o dane dotyczące archiwalnego zatrudnienia w danej jednostce. Dodano węzeł „archivalEmployments” o następujących atrybutach: { „institutionId” : ObjectId(„5e70918b878c28a04737de34”), „uuidInstitution” : „dbdda9a7-f6f7-44e8-af1d-9863e2256ca3”, „from” : ISODate(„1972-09-30T23:00:00.000Z”), „to” : ISODate(„2012-09-29T22:00:00.000Z”), „institutionDisplayName” : „Politechnika Wrocławska”, „areas” : [], „uuidPerson” : „1647d6b4-4241-4b32-a6d4-22a59eb2dfbb”, „phdStudent” : false }
Dane dotyczące archiwalnego zatrudnienia zwracane są wyłącznie jeśli zatrudnienie miało miejsce w jednostce, która odpytuje API. Jeśli w ramach jednostki osoba nie posiada archiwalnego zatrudnienia lub też posiada archiwalne zatrudnienia w innej jednostce informacje o tym zatrudnieniu nie są zwracane.
ZASTOSOWANIE:
opis w przygotowaniu