Web Services - Les utilisateurs

View the English version.

Description

Chaque ressource est un utilisateur.

URI	<url_de_base>/api/feed/utilisateurs
Catégorie	http://schemas.holydis.com/tsq/2010#utilisateurs
Disponible en écriture	Oui

Paramètres spécifiques

Paramètre	Description
nomCompte	Filtre les utilisateurs avec le nom de compte spécifié.

Eléments

Elément	Description	En écriture
nomCompte	Le nom du compte utilisateur.	Obligatoire
email?	L'email de l'utilisateur s'il est renseigné.
authentificationParMdp	L'activation de l'authentification par mot de passe en sus si le SSO est activé.
modeDateConnexion	La date de référence : DERNIERE_SELECTION pour Dernière date sélectionnée ou SERVEUR pour Date du jour (date du serveur).	Par défaut, c'est la valeur DERNIERE_SELECTION
dateReference	La dernière date de référence sélectionnée par l'utilisateur.	Par défaut, c'est la date du jour.
timeZoneId	L’identifiant de fuseau horaire par défaut. Exemple : Europe/Paris. Pour lire les données en fonction du fuseau horaire de Europe/Lisbonne, il faut ajouter en en-tête de la requête le paramètre User-TimeZoneId avec comme valeur l’identifiant du fuseau de Lisbonne, en l’occurrence Europe/Lisbonne. En l’absence du paramètre en en-tête, les données sont renvoyées brutes (dans le fuseau horaire de la ressource).	L'écriture se fait toujours dans le fuseau horaire de la ressource.
timeZonesId	L’identifiant des fuseaux horaires activés.	L'écriture se fait toujours dans le fuseau horaire de la ressource.

Exemples de requêtes

Lecture

Lire tous les utilisateurs

GET /[URI_de_base]/api/feed/utilisateurs

Lire l’utilisateur dont l’identifiant en base est 18000

GET /[URI_de_base]/api/feed/utilisateurs/18000

Exemple de résultat XML de la requête

Exemple de résultat JSON de la requête

Lire l’utilisateur dont le nom du compte est Sophie

GET /[URI_de_base]/api/feed/utilisateurs?nomCompte=Sophie

Ecriture

Ajouter un utilisateur

POST /[URI_de_base]/api/feed/utilisateurs

Exemple de fichier XML en entrée

Exemple de fichier JSON en entrée

Modifier l’utilisateur dont l’identifiant en base est 15000

PUT /[URI_de_base]/api/feed/utilisateurs/15000

Supprimer l’utilisateur dont l’identifiant en base est 15000

DELETE /[URI_de_base]/api/feed/utilisateurs/15000

Messages d'erreur fonctionnels

• Erreur 400 Le nom du compte utilisateur est déjà référencé
• Erreur 400 Le nom du compte utilisateur doit être renseigné
• Erreur 400 Le fuseau par défaut doit être compris dans la liste des fuseaux activés