Civilités des contacts

Les routes de lecture sont accessibles à tout utilisateur authentifié. La création, la modification et la suppression nécessitent le privilège admin_contacts.

Lister les civilités

Route

GET /rest/civilities

Retour

Code HTTP	Type	Description
200	object	Objet contenant la liste civilities

{
  "civilities": [
    {"id": 1, "label": "Monsieur", "abbreviation": "M."}
  ]
}

Créer une civilité

Route

POST /rest/civilities

Body

Valeur	Type	Obligatoire	Description
label	string	Oui	Libellé de la civilité
abbreviation	string	Oui	Abréviation de 1 à 16 caractères

{
  "label": "Docteur",
  "abbreviation": "Dr"
}

Retour

Code HTTP	Description	Exemple
200	Civilité créée	{"id": 4}
400	Body absent ou champs invalides	{"errors":"Body label is empty or not a string"}
403	Privilège insuffisant	{"errors":"Service forbidden"}

Consulter une civilité

Route

GET /rest/civilities/{id}

Paramètre d’URL	Type	Description
id	integer	Identifiant de la civilité

Retour

Code HTTP	Description
200	Civilité
400	Identifiant invalide ou civilité inexistante

{"id": 4, "label": "Docteur", "abbreviation": "Dr"}

Modifier une civilité

Route

PUT /rest/civilities/{id}

Le paramètre id est un entier. Le body est identique à celui de la création.

Retour

Code HTTP	Description
204	Civilité modifiée, sans contenu
400	Identifiant, body ou champ invalide
403	Privilège insuffisant

Supprimer une civilité

Route

DELETE /rest/civilities/{id}

Le paramètre id est un entier. La civilité est retirée des contacts qui l’utilisent avant sa suppression.

Retour

Code HTTP	Description
204	Civilité supprimée, sans contenu
400	Identifiant invalide
403	Privilège insuffisant