Show/hide List Operations Expand Operations

Events

GET /api/events

List of all events (scope: public)

Documentation
Sandbox

Documentation

This endpoint gives you a list of events.

Parameters

Parameter	Type	Required?	Format	Description
category	string	false	culture/sport/soiree/formation/autre	Filter by the chosen category
after	number	false	YYYY-MM-DD HH:mm:ss	Filter by begin date after the given date
before	number	false	YYYY-MM-DD HH:mm:ss	Filter by begin date before the given date
organization	number	false		Filter by organization ID
privacy	number	false		Filter by event privacy : public events = 100, private events = 200 (student only), orga events = 300 (member of at least 1 organization), member event = 400 (member of the organization)
fields	string	false	title category begin end isAllDay location description privacy orga	Get required fields only, increase performances

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/events/{id}

Get event details (scope: public)

Documentation
Sandbox

Documentation

This endpoint gives you details of an event.

Requirements

Name	Requirement	Type	Description
id		mixed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/public/events

List of all public events (privacy <= 200). Do not require requests to have oauth credentials (scope: external)

Documentation
Sandbox

Documentation

This endpoint gives you a list of public events.

Parameters

Parameter	Type	Required?	Format	Description
category	string	false	culture/sport/soiree/formation/autre	Filter by the chosen category
after	number	false	YYYY-MM-DD HH:mm:ss	Filter by begin date after the given date
before	number	false	YYYY-MM-DD HH:mm:ss	Filter by begin date before the given date
organization	number	false		Filter by organization login
fields	string	false	title category begin end isAllDay location description privacy orga	Get required fields only, increase performances

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

OAuth

GET|POST /api/oauth/authorize

Display the authorization page for user to allow a given application

Documentation
Sandbox

Documentation

To access private user data, you need his/her authorization. This endpoint is an HTML page that ask the current logged user if (s)he wants to accept your application. If (s)he doesn't, (s)he is redirected to EtuUTT. I f(s)he does, (s)he is redirected to your application URL with the parameter code.

Let's take a small example:

Your application "MyApp" (reidrect URL: http://myapp.com) wants to access private data of the current user. To do so, you need to redirect user to this page:

/api/oauth/authorize?response_type=code&client_id=<your_client_id>&scope=public%20private_user_account&state=xyz

If the user accept the application, he will be redirected to http://myapp.com/?code=<authorization_code>.

And using this code (in the parameter code), you are now able to get an access_token using /api/oauth/token.

If an error occured on the page and the client_id is provided, the user will be redirect to: http://myapp.com/?error=<error_type>&error_description=<error_description> so you can handle the problem.

Parameters

Parameter	Type	Required?	Description
client_id	string	true	Your client ID (given in your developper panel)
scope	string	false	List of the scopes you need for the token, separated by spaces, for instance: `public private_user_account`. If not provided, grant only access to public scope.
response_type	string	true	Must be `code` (only authorization_code is supported for the moment)
state	string	true	Must be `xyz` (only authorization_code is supported for the moment)

Input

Parameters

= -

Method Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET|POST /api/oauth/client-create

Display the authorization page for user to generate new client credential for client applciations (android app for instance)

Documentation
Sandbox

Documentation

Classic Oauth2 auth cannot be used for a client application (android app for instance) because it would require to store the app_secret in the local code of the application wich would make it not really secret.

To solve this problem, you can redirect the user to this page https://etu.utt.fr/api/oauth/client-create?name=Name of your app&device=Android OnePlus 5&device_uid=ABCDEFGXYZ&scope=public private_user_account (via a webview). User will authenticate and then be redirected to https://etu.utt.fr/redirect?client_id=XXXXX&client_secret=YYYY. This URI is invalid and will show nothing, but you can easily detect it from you application, close the webview and parse the uri to get the generated client_id and client_secret.

Once you got those parameters you can send them to /api/oauth/token with grant_type=client_credentials to get a token that you can use with the whole api

In case of failure, user will be redirected to: https://etu.utt.fr/redirect?error=authentification_canceled&error_message=L\'utilisateur a annulé l\'authentification.

Parameters

Parameter	Type	Required?	Description
name	string	true	Name of the application that will be shown for the granting page. (3 to 32 characters)
device	string	true	Name of the device (please try to be explicit by giving a lot of details: OS, Brand, model, etc.) (3 to 128 characters)
device_uid	string	true	Universal ID of the device: try to give here and ID that will no change if the application is reinstalled but is different for all devices. If you don't have something like this, you can generate a hash from all device data you got. (3 to 128 characters)
scope	string	false	List of the scopes you need for the token, separated by spaces, for instance: `public private_user_account`. If not provided, grant only access to public scope.

Input

Parameters

= -

Method Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/oauth/token

Create a OAuth access token using given grant_type

Documentation
Sandbox

Documentation

Create an access_token to use the API.

There are three methods to create an access_token:

authorization_code
refresh_token
client_credentials

These methods are called the the grant types. The required parameters of the endpoint depends on the chosen grant type.

Parameters

Parameter	Type	Required?	Description
grant_type	string	true	The grant type to use to create the access_token.
scopes	string	false	List of the scopes you need for the token, separated by spaces, for instance: `public private_user_account`. If not provided, grant only access to public scope.
code	string	false	The authorization_code generated with /api/oauth/authorize. Required if grant_type == 'authorization_code'.
refresh_token	string	false	The refresh_token provided on the first access_token retrieval. Required if grant_type == 'refresh_token'.
client_id	string	false	Your Client ID (given in your developper panel). Required if not using Basic Authentification.
client_secret	string	false	Your Client Secret Token (given in your developper panel). Required if not using Basic Authentification.

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Organization - Public data

GET DEPRECATED /api/orgas

Use /api/public/orgas instead. List of the orgas (scope: public)

Documentation
Sandbox

Documentation

Deprecated, please don't use it anymore.

List of all the organizations in EtuUTT (display only public data).

Filters

Name

Information

name

Datatype

string

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET DEPRECATED /api/orgas/{login}

Use /api/public/orgas/{login} instead. View a single organisation (scope: public)

Documentation
Sandbox

Documentation

Deprecated, please don't use it anymore.

View a single organization informations, embeding members.

Requirements

Name	Requirement	Type	Description
login

Parameters

Parameter	Type	Required?	Format	Description
login	string	true		User login

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/public/listorgas
- Simple list of the orgas (scope: public)
- Documentation
- Sandbox
Documentation

List of all the organizations in EtuUTT (display only some data).
Input

Headers
= -

Content
= Replaces header if set
Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/public/orgas

List of the orgas (scope: public)

Documentation
Sandbox

Documentation

List of all the organizations in EtuUTT (display only public data).

Filters

Name

Information

name

Datatype

string

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/public/orgas/{login}

View a single organisation (scope: public)

Documentation
Sandbox

Documentation

View a single organization informations, embeding members.

Requirements

Name	Requirement	Type	Description
login

Parameters

Parameter	Type	Required?	Format	Description
login	string	true		Organization login

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/public/orgas/{login}/members

List of a given organization members (scope: public)

Documentation
Sandbox

Documentation

View a given organization members and their associated informations.

Requirements

Name	Requirement	Type	Description
login

Parameters

Parameter	Type	Required?	Format	Description
login	string	true		Organization login

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

UEs

GET /api/ues

List of all ues (scope: public)

Documentation
Sandbox

Documentation

To access an UE's information, you need to know the slug of that UE. For exemple, TN02's slug is "tn02".

This endpoint gives you a list of ue's

Parameters

Parameter	Type	Required?	Format	Description
category	string	false	cs/tm/ec/me/ct/st/master	Filter by the chosen category
automne	number	false	0/1	Filter ues by automne/not automne
printemps	number	false	0/1	Filter ues by printemps/not printemps

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/ues/{slug}

Details of an UE (scope: public)

Documentation
Sandbox

Documentation

You can get all the informations of an UE with this endpoint, using the UE's slug.

Requirements

Name	Requirement	Type	Description
slug		mixed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/ues/{slug}/comments

comments of an UE (scope: public and is student)

Documentation
Sandbox

Documentation

You can get all UE's comments with this endpoint, using the UE's slug.

Requirements

Name	Requirement	Type	Description
slug		mixed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/ues/{slug}/reviews

reviews of an UE (scope: public and is student)

Documentation
Sandbox

Documentation

You can get all UE's reviews with this endpoint, using the UE's slug.

Requirements

Name	Requirement	Type	Description
slug		mixed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

User - Private data

GET /api/private/user/account
- Get the public and private informations about the current user
- Documentation
- Sandbox
Documentation

Once you connected the user with EtuUTT, you will want to retrieve informations about him / her.

This endpoint allows you to retrieve such informations.

It's more complete than /api/public/user/account as it includes private data (it requires scope private_user_account).

Be careful with the privacy of the data you access: please use the privacy informations to limit access in your application.
Input

Headers
= -

Content
= Replaces header if set
Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line
GET /api/private/user/courses
- Courses list of a given user (scope: private), in case of private schedule
- Documentation
- Sandbox
Input

Headers
= -

Content
= Replaces header if set
Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line
GET /api/private/user/organizations
- Get the list of organizations of the current user and its permissions in them
- Documentation
- Sandbox
Documentation

This endpoint list you the organizations the current user are in and the permission he or she has in these organizations.
Input

Headers
= -

Content
= Replaces header if set
Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/private/user/push-token

Set the expo token that will be used to send push notifications to the device (scope: public)

Documentation
Sandbox

Documentation

Store the expo token in database.

Parameters

Parameter	Type	Required?	Format	Description
token	string	true		Expo token

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/private/user/schedule
- Get the schedule of the current user
- Documentation
- Sandbox
Input

Headers
= -

Content
= Replaces header if set
Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

User - Public data

GET /api/public/user/account
- Get the public informations about the current user
- Documentation
- Sandbox
Documentation

Once you connected the user with EtuUTT, you will want to retrieve informations about him / her.

This endpoint allows you to retrieve such informations.

It only includes public informations (so you don't need scope private_user_account to access this endpoint). For more complete informations, use private_user_account scope and use endpoint /api/private/user/account.
Input

Headers
= -

Content
= Replaces header if set
Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/public/users

List of the users (scope: public)

Documentation
Sandbox

Filters

Name

Information

firstname

Datatype

string

lastname

Datatype

string

phone

Datatype

string

name

Datatype	string
Description	Search in firstname, lastname or fullname

mail

Datatype	string
Description	Search in mail or personalMail

formation

Datatype	string
Description	Search by diploma (master, engineer, ...)

branch

Datatype

string

level

Datatype

string

speciality

Datatype

string

is_student

Datatype

boolean

wantsJoinUTTDiscord

Datatype

boolean

bde_member

Datatype

boolean

student_id

Datatype

integer

multifield

Datatype	string
Description	Search between firstname, lastname, fullname, login, student_id, nickname, and emails

Parameters

Parameter	Type	Required?	Format	Description
embed	string	false		Embed foreign entities in the users data (available: badges)

Input

Filters

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/public/users/image/{avatar}

Renvoie la photo d'un utilisateur (scope: public)

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
avatar

Parameters

Parameter	Type	Required?	Format	Description
login	string	true		User login

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/public/users/{login}

View a single user (scope: public)

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
login

Parameters

Parameter	Type	Required?	Format	Description
login	string	true		User login

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/public/users/{login}/badges

Badges list of a given user (scope: public)

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
login

Parameters

Parameter	Type	Required?	Format	Description
login	string	true		User login

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/public/users/{login}/courses

Courses list of a given user (scope: public)

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
login

Parameters

Parameter	Type	Required?	Format	Description
login	string	true		User login

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET DEPRECATED /api/users

Use /api/public/users instead. List of the users (scope: public)

Documentation
Sandbox

Filters

Name

Information

firstname

Datatype

string

lastname

Datatype

string

branch

Datatype

string

level

Datatype

string

speciality

Datatype

string

is_student

Datatype

boolean

bde_member

Datatype

boolean

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET DEPRECATED /api/users/{login}

Use /api/public/users/{login} instead. View a single user (scope: public)

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
login

Parameters

Parameter	Type	Required?	Format	Description
login	string	true		User login

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

EtuUTT API endpoints reference

Events

GET /api/events

Documentation

Parameters

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/events/{id}

Documentation

Requirements

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/public/events

Documentation

Parameters

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

OAuth

GET|POST /api/oauth/authorize

Documentation

Parameters

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET|POST /api/oauth/client-create

Documentation

Parameters

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/oauth/token

Documentation

Parameters

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Organization - Public data

GET DEPRECATED /api/orgas

Documentation

Filters

Filters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET DEPRECATED /api/orgas/{login}

Documentation

Requirements

Parameters

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/public/listorgas

Documentation