Skip to content

Latest commit

 

History

History
188 lines (125 loc) · 4.03 KB

README.md

File metadata and controls

188 lines (125 loc) · 4.03 KB

EPFL People API

EPFL People API.

Build Status Coverage Status Dependencies Status Apache License 2.0 NPM Version


Install

npm i epfl-people-api --save

Usage

const epflPeopleApi = require('epfl-people-api');

epflPeopleApi.findBySciper(128871, 'en').then(function(person) {
  console.log(person.name);      //=> 'Duratti'
  console.log(person.firstname); //=> 'Lindo'
  console.log(person.office);    //=> 'INN 018'
  console.log(person.position);  //=> 'Computer Scientist'
}).catch(function(err) {
  console.log(err);
});

epflPeopleApi.findByEmail('lindo.duratti@epfl.ch', 'en').then(function(person) {
  console.log(person.firstname); //=> 'Lindo'
  console.log(person.sciper);    //=> '128871'
  console.log(person.phones);    //=> '+41 21 6934553'
  console.log(person.unit);      //=> 'EXAPP'
}).catch(function(err) {
  console.log(err);
});

epflPeopleApi.find('Oryshchuk', 'en').then(function(list) {
  console.log(list[0].firstname); //=> 'Anastasiia'
}).catch(function(err) {
  console.log(err);
});

epflPeopleApi.hasPhoto(128871).then(function(hasPhoto) {
  console.log(hasPhoto); //=> False
}).catch(function(err) {
  console.log(err);
});

epflPeopleApi.getPhotoUrl(278890).then(function(url) {
  console.log(url); //=> https://people.epfl.ch/private/common/photos/links/278890.jpg
}).catch(function(err) {
  console.log(err);
});

API

.findBySciper(sciper, locale)

Type: function

Returns a Promise with a person as parameter.

sciper

Type: number

6-digit unique EPFL identification number.

locale

Type: string
Default: en

Supported locales are English (en) and French (fr).

.findByEmail(email, locale)

Type: function

Returns a Promise with a person as parameter.

email

Type: string

A valid email address.

locale

Type: string
Default: en

Supported locales are English (en) and French (fr).

.find(q, locale)

Type: function

Returns a Promise with a list of person as parameter.

q

Type: string

The term to look for.

locale

Type: string
Default: en

Supported locales are English (en) and French (fr).

.hasPhoto(sciper)

Type: function

Returns a Promise with a boolean as parameter.

sciper

Type: number

6-digit unique EPFL identification number.

.getPhotoUrl(sciper)

Type: function

Returns a Promise with a string as parameter.

sciper

Type: number

6-digit unique EPFL identification number.

See also

Contributing

Contributions are always welcome.

See Contributing.

Developer

License

Apache License 2.0

Original work (c) ECOLE POLYTECHNIQUE FEDERALE DE LAUSANNE, Switzerland, VPSI, 2017-2018.
Modified work (c) William Belle, 2018-2020.

See the LICENSE file for more details.