api.raml 1.32 KB
#%RAML 1.0
title: API d'Etunicorn
baseUri: https://etunicorn.plil.net/{version}/
version: v1
/login:
  post:
    description: Instancie une nouvelle connexion
    queryParameters: 
      login:
        displayName: Login Polytech
        type: string
        required: true
      password:
        displayName: Mot de passe Polytech
        type: string
        required: false
    responses: 
      200:
        description: Authentification réussie
        body:
          application/json:
            example:
              {
                "token": "ooT6zahdura7vaethuiph1ugiph6co",
                "expire": 1485607703
              }
      401:
        description: Authentication échouée
/personne:
  get:
   description: Obtenir la liste des persones
   responses: 
     200:
       body:
          application/json:
            example:
              [
                {
                  "idPersonne": 42,
                  "idCarte": "AAAAA",
                  "naissance": "1997-02-14",
                  "solde": 1337,
                  "loginPoly": "gbontoux"
                }
              ]
  put:
    description: Ajoute un nouvel étudiant
    queryParameters:
      idCarte:
        displayName: ID de la carte NFC
        type: string
        required: false
      naissance:
        displayName: Date de naissance