README.md

Search API

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

• /api/cse?q=math
• /api/cse?q=math&hl=fr&searchSite=actu.epfl.ch
• /api/cse?q=math&hl=en&sort=date&searchType=image

People

Endpoint

GET /api/ldap

Parameters

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

Examples

• /api/ldap?q=278890
• /api/[email protected]&hl=en

People (CSV Export)

Endpoint

GET /api/ldap/csv

Parameters

Name	Type	Comments
q	String	Query

Examples

• /api/ldap/csv?q=jango

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

• /api/ldap/suggestions?q=math
• /api/ldap/suggestions?q=william&limit=3

Address

Endpoint

GET /api/address

Parameters

Name	Type	Comments
q	String	Query (sciper)

Examples

• /api/address?q=278890

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

• /api/unit?q=fsd
• /api/unit?q=vpo&hl=en
• /api/unit?q=13030
• /api/unit?acro=vpo

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

• /api/unit/csv?q=isas-fsd&hl=en

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

• /api/unit/suggestions?q=isas&hl=en

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

• /api/graphsearch?q=math&limit=20
• /api/graphsearch?q=vetterli&doctype=person
• /api/graphsearch?q=lts&doctype=unit

Documentation

See Confluence.

Contributing

See Contributing.