Skip to content

Utilisateur

Ce endpoint permet la manipulation des utilisateurs du systeme. A noter que toutes les manipulations des utilisateurs demande un jeton d'authentification et un droit d'acces.

Obtenir tous les utilisateurs

Endpoint : 

GET /utilisateurs

Authentification : Requise

Paramètres de requête :
- role (optionnel) : ALL, ADMIN, MODERATEUR, UTILISATEUR (défaut: ALL)

Exemple :

GET /utilisateurs?role=ADMIN

Réponse (200 OK) :

[
  {
    "id": 1,
    "prenom": "Jean",
    "nom": "Dupont",
    "courriel": "jean.dupont@example.com",
    "role": "UTILISATEUR",
    "created_at": "2024-01-01T00:00:00",
    "updated_at": "2024-01-01T00:00:00"
  },
  ...
]

Obtenir un utilisateur par ID

Endpoint : `

GET /utilisateurs/{id}

Authentification : Requise

Paramètres de chemin :
- id (requis) : ID de l'utilisateur

Exemple :

GET /utilisateurs/1

Réponse (200 OK) :

{
  "id": 1,
  "prenom": "Jean",
  "nom": "Dupont",
  "courriel": "jean.dupont@example.com",
  "role": "UTILISATEUR",
  "created_at": "2024-01-01T00:00:00",
  "updated_at": "2024-01-01T00:00:00"
}

Erreurs :
- 404 Not Found : Utilisateur non trouvé

Exemple de réponse d'erreur :

{
  "message": "l'id 999"
}

Obtenir un utilisateur par courriel

Endpoint : 

GET /utilisateurs/courriel/{courriel}

Authentification : Requise

Paramètres de chemin :
- courriel (requis) : Adresse courriel de l'utilisateur

Exemple :

GET /utilisateurs/courriel/jean.dupont@example.com

Réponse (200 OK) :

{
  "id": 1,
  "prenom": "Jean",
  "nom": "Dupont",
  "courriel": "jean.dupont@example.com",
  "role": "UTILISATEUR",
  "created_at": "2024-01-01T00:00:00",
  "updated_at": "2024-01-01T00:00:00"
}

Erreurs :
- 404 Not Found : Utilisateur non trouvé

Exemple de réponse d'erreur :

{
  "message": "le courriel inexistant@example.com"
}

Codes de statut HTTP

L'API utilise les codes de statut HTTP standards :

  • 200 OK : Requête réussie
  • 201 Created : Ressource créée avec succès
  • 204 No Content : Requête réussie, pas de contenu à retourner
  • 400 Bad Request : Requête mal formée ou données invalides
  • 401 Unauthorized : Authentification requise ou token invalide
  • 404 Not Found : Ressource non trouvée
  • 500 Internal Server Error : Erreur serveur