Services Web VoiceForm

VoiceCheck expose un service Web qui permet la création d’un VoiceForm, essentiellement une importation de données. Ce service Web permet de créer de nouveaux VoiceForms et de mettre à jour ou de supprimer des VoiceForms existants sur le serveur VoiceCheck. Lorsque ce service Web est invoqué, VoiceCheck valide le système comme suit :

• S’il n’y a aucun nom de VoiceForm correspondant, un nouveau VoiceForm est créé.
• S’il y a un nom de VoiceForm correspondant, aucun nouveau VoiceForm n’est créé.

Un VoiceForm peut être importé avec ou sans étapes du VoiceForm. Cela permet à un technicien de créer les étapes du VoiceForm ultérieurement, à partir du serveur VoiceCheck.

Lorsque VoiceCheck reçoit ce message de lecture, de mise à jour et de suppression de VoiceForms, les validations suivantes sont prises en considération :

• Si le nom du VoiceForm n’existe pas dans VoiceCheck, aucun détail n’est retourné dans la réponse.
• Si le VoiceForm existe, seul son nom peut être mis à jour par le service Web.
• Si le VoiceForm ne fait référence à aucune autre entité dans VoiceCheck, il peut être supprimé. Sinon, 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 tel que décrit dans le schéma contenu dans le fichier WADL. Les éléments sont décrits dans le tableau d’éléments d’entrée.

Réponse : Si la demande aboutit, état HTTP 200 avec la charge utile «  VoiceForm enregistré  ». En cas de défaillance, le système renvoie une erreur. Tout code d’état HTTP autre que 200 ou 204 est considéré comme étant une erreur. Si possible, le système hôte doit retourner un corps de message pour les erreurs.

Paramètres POST

Un fichier VoiceForm contenant des paramètres valides dans le corps du message.

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 réussite, état HTTP 200 avec ou sans corps de message. En cas de défaillance, 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 réussite, état HTTP 200 avec ou sans corps de message. En cas de défaillance, 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 réussite, état HTTP 200 avec ou sans corps de message. En cas de défaillance, 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>://<VoiceCheckIP>:<port>/VoiceCheck/services/imageService/<Nom du répertoire/dossier><Nom du répertoire/dossier>.....<nom de fichier de la photo avec extension>

Méthode : GET

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

Type de contenu : (vide)

Réponse : en cas de réussite, état HTTP 200. Si la photo est introuvable, le service génère une erreur WebApplicationException avec l’état État HTTP 404 introuvable.

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	Le nom du VoiceForm	Doit être unique dans VoiceCheck