Skip to content

epfl-si/search-api

Repository files navigation

Search API

Test Status Build Status Coverage Status Node.js

Google Custom Search

Endpoint

GET /api/cse

Parameters

Name Type Comments
hl String Sets the user interface language.
q String Query
siteSearch String Specifies a given site which should be included.
searchType String Specifies the search type: image. If unspecified, results are limited to webpages.
start Number The index of the first result to return. The default number of results per page is 10.
sort String The sort expression to apply to the results.

Examples

People

Endpoint

GET /api/ldap

Parameters

Name Type Comments
q String Query
hl String Sets the user interface language.

Examples

People (CSV Export)

Endpoint

GET /api/ldap/csv

Parameters

Name Type Comments
q String Query

Examples

People suggestions

Endpoint

GET /api/ldap/suggestions

Parameters

Name Type Comments
q String Query
limit Number Sets the number of suggestions. Default and max is 10.

Examples

Address

Endpoint

GET /api/address

Parameters

Name Type Comments
q String Query (sciper)

Examples

Unit

Endpoint

GET /api/unit

Parameters

Name Type Comments
q String Query (acronym, name or ID)
acro String Specifies an exact unit acronym. If specified, q is ignored.
hl String Sets the user interface language.

Examples

Unit (CSV Export)

Only allowed via EPFL intranet or VPN.

Endpoint

GET /api/unit/csv

Parameters

Name Type Comments
q String acronym (should be the exact name)
hl String Sets the user interface language.

Example

Unit suggestions

Endpoint

GET /api/unit/suggestions

Parameters

Name Type Comments
q String Query
limit Number Sets the number of suggestions. Default and max is 10.

Example

EPFL Graph

Endpoint

GET /api/graphsearch

Parameters

Name Type Comments
q String Query
doctype String Values : concept, course, lecture, mooc, person, publication, unit
limit Number Sets the number of entries on a page. Default is 10. Max is 100.

Examples

Documentation

See Confluence.

Contributing

See Contributing.