Services Web VoicePlan

VoiceCheck expose un service Web qui permet la création d’un VoicePlan, essentiellement l’importation de données. Ce service Web permet de créer de nouveaux VoicePlans et de mettre à jour ou de supprimer des VoicePlans 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 VoicePlan correspondant, un nouveau VoicePlan est créé.
  • S’il y a un nom de VoicePlan correspondant, aucun nouveau VoicePlan n’est créé.
  • Un VoicePlan sans description, VoiceForm ni étapes de section est considéré comme étant non valide et n’est pas créé.
  • Aucun VoicePlan n’est créé si le VoiceForm associé au VoicePlan est introuvable sur le serveur VoiceCheck.

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

  • Si le nom du VoicePlan n’existe pas dans VoiceCheck, aucun détail n’est retourné dans la réponse.
  • Si le VoicePlan existe, seul son nom peut être mis à jour par le service Web.
  • Un VoicePlan peut être supprimé même s’il fait référence à une entité dans VoiceCheck.

Créer les détails du VoicePlan

Service Web REST

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

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

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 «  VoicePlan 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 VoicePlan contenant des paramètres valides dans le corps du message.

LIRE LES DÉTAILS du VoicePlan

SERVICE WEB REST

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

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

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 VoicePlan

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

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

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.

Paramètres POST

Un fichier VoicePlan contenant des paramètres mis à jour dans le corps du message.

SUPPRIMER LES DÉTAILS du VoicePlan

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

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

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.

ÉLÉMENTS D’ENTRÉE

PROPRIÉTÉ TYPE OBLIGATOIRE DÉFINITION VALIDATION
planIdentifier

Chaîne

Oui Le nom du VoicePlan Doit être unique dans VoiceCheck