ADE-ESIEE

Run with Docker

1) Run `docker build -t python3/ade-esiee .`
2) Run `docker run -d -p 5000:5000 -v $(pwd):/src --name ade-esiee python3/ade-esiee`

To reload sources files after edition just do `docker restart ade-esiee`

After that yo can use standard docker command

Informations

This is an API to make different things with ESIEE's logins by POST requests:

• Generate automatically calendar
• Generate Calendar with username, password and date
• Get Groups JSON
• Get Agenda with Groups
• Get marks
• Get absences
• Get appreciations

Calendar

Generate Calendar with username, password and date :

An activity is composed of:

The name of the activity (mainly the subject name).
The starting time of the activity.
The ending time of the activity.
The rooms where the activity take place.
The name of the professor.

Typical request is make on /api/ade-esiee/calendar/ url
The POST requests's arguments are :

   {
     username,
     password,
     day,
     month
   }
   

This result in the following JSON template:

  {
    "name"       : "String",
    "start"      : "Date",
    "end"        : "Date",
    "rooms"      : "Room",
    "prof"       : "Name"
  }
  

Get groups JSON

A group is composed of:

The code of the groups on Aurion.

Typical request is make on /api/ade-esiee/groups/ url
The POST requests's arguments are :

   {
     username,
     password
   }
   

The result is a list of Strings which are groups code on Aurion.

Get Agenda with groups

An activity is composed of:

The name of the activity (mainly the subject name).
The starting time of the activity.
The ending time of the activity.
The rooms where the activity take place.
The name of the professor.

Typical request is make on /api/ade-esiee/agenda/ url
The POST requests's arguments are :
- Groups argument is getting by call precedent function.

   {
     groups
   }
   

This result in the following JSON template:

  {
    "name"       : "String",
    "start"      : "Date",
    "end"        : "Date",
    "rooms"      : "Room",
    "prof"       : "Name"
  }
  

Get Agenda with ESIEE id or Mail

An activity is composed of:

The name of the activity (mainly the subject name).
The starting time of the activity.
The ending time of the activity.
The rooms where the activity take place.
The name of the professor.

Typical request is make on /api/ade-esiee/agenda/ url
The POST requests's arguments are :

   {
     "mail"     : "String" (mail or id)
   }
   

This result in the following JSON template:

  {
    "name"       : "String",
    "start"      : "Date",
    "end"        : "Date",
    "rooms"      : "Room",
    "prof"       : "Name"
  }
  

Marks

A mark is composed of:

The year of the mark.
The unite code of the mark.
The natural name of the unite.
The mark.
The coefficient of the mark.

Typical request is make on /api/ade-esiee/marks/ url
The POST requests's arguments are :

   {
     username,
     password
   }
   

This result in the following JSON template:

  {
    "year"       : "String",
    "unite"      : "Unite Code",
    "name"       : "Unite natural name",
    "mark"       : "float",
    "coeff"      : "float"
  }
  

Absences

An absence is composed of:

The date of the absence.
The time of the absence.
The unite code of the absence.
The natural name of the unite.
The professor of the course.
The type of the course.
The number of hours.
The reason.

Typical request is make on /api/ade-esiee/absences/ url
The POST requests's arguments are :

   {
     username,
     password
   }
   

This result in the following JSON template:

  {
    "date"       : "String",
    "hours"      : "String",
    "unite_code" : "Unite Code",
    "name"       : "Unite natural name",
    "prof"       : "String",
    "type"       : "String",
    "number"     : "String",
    "reason"     : "String"
  }
  

Appreciations

An appreciation is composed of:

The year of the appreciation.
The period of the appreciation.
The text of the appreciation.

Typical request is make on /api/ade-esiee/appreciation/ url
The POST requests's arguments are :

   {
     username,
     password
   }
   

This result in the following JSON template:

  {
    "year"       : "String",
    "period"      : "String",
    "appreciation" : "String"
  }
  

Author : Wallerand DELEVACQ