API Group

Vue d’ensemble

L’API Group permet de gerer les groupes de Fess. Vous pouvez creer, mettre a jour et supprimer des groupes.

URL de base

/api/admin/group

Liste des endpoints

Methode Chemin Description
GET/PUT /settings Obtention de la liste des groupes
GET /setting/{id} Obtention d’un groupe
POST /setting Creation d’un groupe
PUT /setting Mise a jour d’un groupe
DELETE /setting/{id} Suppression d’un groupe

Obtention de la liste des groupes

Requete

GET /api/admin/group/settings
PUT /api/admin/group/settings

Parametres

Parametre Type Requis Description
size Integer Non Nombre d’elements par page (par defaut : 20)
page Integer Non Numero de page (commence a 0)

Reponse

{
  "response": {
    "status": 0,
    "settings": [
      {
        "id": "group_id_1",
        "name": "Engineering",
        "gidNumber": 1000
      },
      {
        "id": "group_id_2",
        "name": "Sales",
        "gidNumber": 1001
      }
    ],
    "total": 5
  }
}

Obtention d’un groupe

Requete

GET /api/admin/group/setting/{id}

Reponse

{
  "response": {
    "status": 0,
    "setting": {
      "id": "group_id_1",
      "name": "Engineering",
      "gidNumber": 1000
    }
  }
}

Creation d’un groupe

Requete

POST /api/admin/group/setting
Content-Type: application/json

Corps de la requete

{
  "name": "Marketing",
  "gidNumber": 1002
}

Description des champs

Champ Requis Description
name Oui Nom du groupe
gidNumber Non Numero d’ID du groupe

Reponse

{
  "response": {
    "status": 0,
    "id": "new_group_id",
    "created": true
  }
}

Mise a jour d’un groupe

Requete

PUT /api/admin/group/setting
Content-Type: application/json

Corps de la requete

{
  "id": "existing_group_id",
  "name": "Marketing Team",
  "gidNumber": 1002,
  "versionNo": 1
}

Reponse

{
  "response": {
    "status": 0,
    "id": "existing_group_id",
    "created": false
  }
}

Suppression d’un groupe

Requete

DELETE /api/admin/group/setting/{id}

Reponse

{
  "response": {
    "status": 0,
    "id": "deleted_group_id",
    "created": false
  }
}

Exemples d’utilisation

Creation d’un nouveau groupe

curl -X POST "http://localhost:8080/api/admin/group/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "Product Team",
       "gidNumber": 2000
     }'

Obtention de la liste des groupes

curl -X GET "http://localhost:8080/api/admin/group/settings" \
     -H "Authorization: Bearer YOUR_TOKEN"

Informations complementaires