Introduction Glossaire Guide utilisateur
Guide administrateur fonctionnel Guide administrateur technique Prérequis pour Maarch Courrier Installation Script de migration Exploitation Mise en oeuvre de docker Architecture technique Architecture du produit Architecture d'un projet type Description du modèle de données Description des webservices Pièces jointes Bannettes Contacts Entités Export et fiche de liaison Groupes Notes Courriers Utilisateurs Types de courrier

Création d'un utilisateur

Route

POST /rest/users

Paramètres

Body
Valeur Type Obligatoire valeur par défaut Description
userId string Oui Login
firstname string Oui Prénom
lastname string Oui Nom
initials string Non Initiales
mail string Oui Email
phone string Non Numéro de téléphone
mode string Non "standard" "standard", "rest", "root_invisible" ou "root_visible"
Exemple
{
    "userId" : "bwayne",
    "firstname" : "Bruce",
    "lastname" : "Wayne",
    "mail" : "bruce.wayne@wcorp.com",
    "phone" : "+33120212223"
}

Retour

Code Http Type Description Exemple
200 array L'utilisateur a bien été créé ['id' => 21]
400 array Un paramètre obligatoire est manquant ['errors' => 'Bad Request']
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']

Modification d'un utilisateur

Route

PUT /rest/users/{id}

Le paramètre id de la route représente l'identifiant technique (users.id) de l'utilisateur à modifier

Paramètres

Body
Valeur Type Obligatoire valeur par défaut Description
firstname string Oui Prénom
lastname string Oui Nom
initials string Non Initiales
mail string Oui Email
phone string Non Numéro de téléphone
mode string Non "standard" "standard", "rest", "root_invisible" ou "root_visible"
Exemple
{
    "firstname" : "Bruce",
    "lastname" : "Wayne",
    "mail" : "bruce.wayne@wcorp.com",
    "phone" : "+33120212223"
}

Retour

Code Http Type Description Exemple
204 array L'utilisateur a bien été modifié
400 array Un paramètre obligatoire est manquant ['errors' => 'Bad Request']
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']

Ajout d'un groupe

Route

POST /rest/users/{id}/groups

Le paramètre id de la route représente l'identifiant technique (users.id) de l'utilisateur à modifier

Paramètres

Body
Valeur Type Obligatoire valeur par défaut Description
groupId string Oui Identifiant du groupe à ajouter (usergroups.group_id)
Exemple
{
    "groupId" : "ELU"
}

Retour

Code Http Type Description Exemple
200 array La modification a bien été prise en compte
400 array Un paramètre obligatoire est manquant ['errors' => 'Bad Request']
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']

Suppression d'un groupe

Route

DELETE /rest/users/{id}/groups/{groupId}

Le paramètre id de la route représente l'identifiant technique (users.id) de l'utilisateur à modifier.
Le paramètre groupId représente l'identifiant (usergroups.group_id) du groupe à supprimer

Retour

Code Http Type Description Exemple
200 array La modification a bien été prise en compte
400 array Un paramètre obligatoire est manquant ['errors' => 'Bad Request']
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']

Ajout d'une entité

Route

POST /rest/users/{id}/entities

Le paramètre id de la route représente l'identifiant technique (users.id) de l'utilisateur à modifier

Paramètres

Body
Valeur Type Obligatoire valeur par défaut Description
entityId string Oui Identifiant (entities.entity_id) de l'entité à ajouter
Exemple
{
    "entityId" : "PJS"
}

Retour

Code Http Type Description Exemple
200 array La modification a bien été prise en compte
400 array Un paramètre obligatoire est manquant ['errors' => 'Bad Request']
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']

Suppression d'une entité

Route

DELETE /rest/users/{id}/entities/{entityId}

Le paramètre id de la route représente l'identifiant technique (users.id) de l'utilisateur à modifier.
Le paramètre entityId représente l'identifiant (entities.entity_id) de l'entité à supprimer

Retour

Code Http Type Description Exemple
200 array La modification a bien été prise en compte
400 array Un paramètre obligatoire est manquant ['errors' => 'Bad Request']
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']

Liste des utilisateurs

Route

GET /rest/users

Retour

Code Http Type Description Exemple
200 array liste des utilisateurs
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']
Exemple
{
  "users": [
    {
      "id": 9,
      "user_id": "bboule",
      "firstname": "Bruno",
      "lastname": "BOULE",
      "status": "OK",
      "mail": "bruno.boule@mail.org",
      "mode": "standard"
    },
    {...}
  ]
}

results matching ""

    No results matching ""