Skip to content

Latest commit

 

History

History
423 lines (311 loc) · 5 KB

INTRA.md

File metadata and controls

423 lines (311 loc) · 5 KB
Raw

Blueprint Intra

Route : https://api.epiteks.xyz/intra/

Routes

POST /login

Connection to the API

Parameters : None

Body :

{
    "login": "login_x",
    "password": "UNIXPWD"
}

Response :

{
    "token": "xxx"
}

or if there's an error :

{
    "error": "xxx"
}

GET /infos

Get informations from your intranet homepage

Parameters :

  • token : 42

Response :

{...}

GET /planning

Get your planning

Parameters :

  • token : 42
  • start : YYYY-MM-DD (Default: Today)
  • end : YYYY-MM-DD (Default: Today + 6 days)

Response :

{...}

GET /projects

Get all your projects

Parameters :

  • token : 42
  • start: YYYY-MM-DD (Default: Today)
  • end: YYYY-MM-DD (Default: Today + 6 days)

Response :

[
    {...}
]

GET /project

Get project info

Parameters :

  • token : 42
  • year : YYYY
  • module : X-XXX-XXX-X
  • instance : XXX-X-X
  • acti : acti-XXXXXX

Response :

{...}

POST /project

Suscribe to project

Parameters :

  • token : 42
  • year : YYYY
  • module : X-XXX-XXX-X
  • instance : XXX-X-X
  • acti : acti-XXXXXX

Response :

{...}

DELETE /project

Unuscribe to project

Parameters :

  • token : 42
  • year : YYYY
  • module : X-XXX-XXX-X
  • instance : XXX-X-X
  • acti : acti-XXXXXX

Response :

{...}

GET /project/files

Get project files

Parameters :

  • token : 42
  • year : YYYY
  • module : X-XXX-XXX-X
  • instance : XXX-X-X
  • acti : acti-XXXXXX

Response :

{...}

GET /project/marks

Get project marks

Parameters :

  • token : 42
  • year : YYYY
  • module : X-XXX-XXX-X
  • instance : XXX-X-X
  • acti : acti-XXXXXX

Response :

{...}

GET /allmodules

Get all modules

Parameters :

  • token : 42
  • year : 2014
  • location : [FR/PAR, FR/BDX, FR/LIL, FR/LYN, FR/MAR, FR/MPL, FR/NCY, FR/NAN, FR/NCE, FR/PAR, FR/REN, FR/STG, FR/TLS]
  • course : [bachelor/classic, bachelor/tek1ed, bachelor/tek2ed]

Response :

{...}

GET /modules

Get user modules

Parameters :

  • token : 42
  • login : login_x

Response :

{...}

GET /module

Get module infos

Parameters :

  • token : 42
  • year : YYYY
  • module : X-XXX-XXX-X
  • instance : XXX-X-X

Response :

{...}

POST /module

Subscribe to module

Parameters :

  • token : 42
  • year : YYYY
  • module : X-XXX-XXX-X
  • instance : XXX-X-X

Response :

{...}

DELETE /module

Unsubscribe to module

Parameters :

  • token : 42
  • year : YYYY
  • module : X-XXX-XXX-X
  • instance : XXX-X-X

Response :

{...}

GET /module/registered

Get registered users to module

Parameters :

  • token : 42
  • year : YYYY
  • module : X-XXX-XXX-X
  • instance : XXX-X-X

Response :

{...}

GET /event

Get event infos

Parameters :

  • token : 42
  • year : 2014
  • module : X-XXX-XXX
  • instance : XXX-X-X
  • acti : acti-XXXXXX
  • event : event-XXXXXX

Response :

{...}

POST /event

Subscribe to event

Parameters :

  • token : 42
  • year : 2014
  • module : X-XXX-XXX
  • instance : XXX-X-X
  • acti : acti-XXXXXX
  • event : event-XXXXXX

Response :

{...}

DELETE /event

Unsubscribe to event

Parameters :

  • token : 42
  • year : 2014
  • module : X-XXX-XXX
  • instance : XXX-X-X
  • acti : acti-XXXXXX
  • event : event-XXXXXX

Response :

{...}

GET /event/registered

Get registered users to event

Parameters :

  • token : 42
  • year : 2014
  • module : X-XXX-XXX
  • instance : XXX-X-X
  • acti : acti-XXXXXX
  • event : event-XXXXXX

Response :

{...}

GET /marks

Get marks

Parameters :

  • token : 42

Response :

{...}

GET /messages

Get messages

Parameters :

  • token : 42

Response :

{...}

GET /alerts

Get alerts

Parameters :

  • token : 42

Response :

{...}

GET /photo

Get photo url

Parameters :

  • token : 42
  • login : login_x

Response :

{...}

POST /token

Validate token

  • token : 42
  • year : 2014
  • module : X-XXX-XXX-X
  • instance : XXX-X-X
  • acti : acti-XXXXXX
  • event : event-XXXXXX
  • tokenvalidationcode : XXXXXXXX

Response :

{...}

GET /trombi

Get a list of students

Parameters :

  • token : 42
  • year : 2014
  • location : [FR/PAR, FR/BDX, FR/LIL, FR/LYN, FR/MAR, FR/MPL, FR/NCY, FR/NAN, FR/NCE, FR/PAR, FR/REN, FR/STG, FR/TLS]
  • course : [bachelor/classic, bachelor/tek1ed, bachelor/tek2ed]
  • promo : tekX
  • offset : 43

Response :

{...}

GET /user

Get a student's information

Parameters :

  • token : 42
  • user : login_x

Response :

{...}

GET /user/files

Get your documents

Parameters :

  • token : 42
  • user : login_x
  • folder : folderName
  • raw : [true, false]

Response

{...}