Services Web de VoiceForm

VoiceCheck expose un service Web qui permet de créer un VoiceForm (essentiellement une importation de données). Ce service Web permet de créer des VoiceForms, de mettre à jour et de supprimer les VoiceForms existants sur le serveur VoiceCheck. Lorsque ce service Web est invoqué, VoiceCheck valide le système pour les opérations suivantes :

• S'il n'existe pas de nom de VoiceForm correspondant, un nouveau VoiceForm est créé.
• S'il existe un nom de VoiceForm correspondant, aucun nouveau VoiceForm n'est créé.

Un VoiceForm peut être importé avec ou sans étapes de VoiceForm. Le technicien est ainsi en mesure de créer les étapes du VoiceForm ultérieurement, à partir du serveur VoiceCheck.

Lorsque VoiceCheck reçoit ce message pour la lecture, la mise à jour et la suppression de VoiceForms, les validations suivantes sont prises en compte :

• Si le nom du VoiceForm n'existe pas dans VoiceCheck, aucun détail n'est renvoyé dans la réponse.
• Si le VoiceForm existe, le service Web peut uniquement mettre à jour le nom du VoiceForm.
• Si le VoiceForm ne fait pas référence à une autre entité dans VoiceCheck, il peut être supprimé. Dans le cas contraire, la suppression du VoiceForm n'est pas autorisée.

Créer les détails du VoiceForm

Service Web REST

WADL : <http ou https>://<hôte>:<port>/VoiceCheck/services/voiceform?_wadl

URL : <http ou https>://<hôte>:<port>/VoiceCheck/services/voiceform

Méthode : POST

Content-Type : application/json;charset=UTF-8

Corps du message : JSON comme indiqué dans le schéma WADL. Les éléments sont décrits dans le tableau des éléments d'entrée.

Réponse : en cas de succès, HTTP Status 200 avec Payload « VoiceForm enregistré ». En cas d'échec, le système renvoie une erreur. Tout code de statut HTTP autre que 200 ou 204 est considéré comme une erreur. Dans la mesure du possible, le système hôte doit renvoyer un corps pour les erreurs.

Paramètres POST

Un fichier VoicePlan contenant des paramètres valides dans le corps.

LIRE LES DÉTAILS DU VOICEFORM

SERVICE WEB REST

WADL : <http ou https>://<hôte>:<port>/VoiceCheck/services/voiceform?_wadl

URL : <http ou https>://<hôte>:<port>/VoiceCheck/services/voiceform/{voiceformname}

Méthode : GET

Content-Type : application/json;charset=UTF-8

Réponse : en cas de succès, HTTP Status 200 avec ou sans corps. En cas d'échec, le système renvoie une erreur.

METTRE À JOUR LES DÉTAILS DU VOICEFORM

WADL : <http ou https>://<hôte>:<port>/VoiceCheck/services/voiceform?_wadl

URL : <http ou https>://<hôte>:<port>/VoiceCheck/services/voiceform/update/{voiceformname}/{newvoiceformname}

Méthode : POST

Content-Type : application/json;charset=UTF-8

Réponse : en cas de succès, HTTP Status 200 avec ou sans corps. En cas d'échec, le système renvoie une erreur.

SUPPRIMER LES DÉTAILS DU VOICEFORM

WADL : <http ou https>://<hôte>:<port>/VoiceCheck/services/voiceform?_wadl

URL : <http ou https>://<hôte>:<port>/VoiceCheck/services/voiceform/{voiceformname}

Méthode : DELETE

Réponse : en cas de succès, HTTP Status 200 avec ou sans corps. En cas d'échec, le système renvoie une erreur.

Gérer les images

SERVICE WEB REST

WADL : <http ou https>://<hôte>:<port>/VoiceCheck/services/imageService?_wadl

URL : <http ou https>://<IPVoiceCheck>:<port>/VoiceCheck/services/imageService/<Répertoire/Nom du dossier><Répertoire/Nom du dossier>.....<nom du fichier photo avec extension>

Méthode : GET

Paramètre : chemin de l'image dans le système de fichiers avec le nom de l'image (le paramètre est envoyé dans l'URL)

Content-Type : (vide)

Réponse : en cas de succès, statut HTTP 200. Lorsque la photo est introuvable, le service génère une WebApplicationException avec le statut « HTTP Status 404 Not Found ».

Authentification de base : nom d'utilisateur et mot de passe VoiceCheck

ÉLÉMENTS D'ENTRÉE

PROPRIÉTÉ	TYPE	OBLIGATOIRE	DÉFINITION	VALIDATION
voiceformname	Chaîne	Oui	Nom du VoiceForm	Doit être unique dans VoiceCheck