Servicios web de VoicePlan

VoiceCheck expone un servicio web que permite la creación de un VoicePlan, que esencialmente es una importación de datos. Este servicio web permite crear nuevos VoicePlans así como actualizar y eliminar los VoicePlans existentes desde el servidor de VoiceCheck. Cuando se usa este servicio web, VoiceCheck valida el sistema para lo siguiente:

  • Si no hay una coincidencia de nombre de VoicePlan, se crea un VoicePlan nuevo.
  • Si hay una coincidencia de nombre de VoicePlan, no se crea un VoicePlan nuevo.
  • Un VoicePlan sin descripción, VoiceForm y pasos de sección no se considera válido y no se crea.
  • Un VoicePlan no se crea si el VoiceForm asociado con el VoicePlan no se encuentra en el servidor de VoiceCheck.

Cuando VoiceCheck recibe este mensaje para leer, actualizar y eliminar VoicePlans, se tienen en consideración las siguientes validaciones:

  • Si el nombre de VoicePlan no existe en VoiceCheck, no se arrojan detalles en la respuesta.
  • Si el VoicePlan existe, el servicio web puede actualizar solo el nombre del VoicePlan.
  • Se puede eliminar un VoicePlan incluso si hace referencia a alguna entidad en VoiceCheck.

Crear detalles de VoicePlan

Servicio web REST

WADL: <http o https>://<host>:<port>/VoiceCheck/services/voiceplan?_wadl

URL: <http o https>://<host>:<port>/VoiceCheck/services/voiceplan

Método: PUBLICAR

Tipo de contenido: application/json;charset=UTF-8

Cuerpo del mensaje: JSON como se indica en el esquema en WADL. Los elementos se describen en la tabla de elementos de entrada.

Respuesta: Cuando es correcto, estado HTTP 200 con carga útil “VoicePlan guardado”. Cuando falla, el sistema arroja un error. Cualquier código de estado HTTP distinto a 200 o 204 se considera un error. Cuando es posible, el sistema host debe arrojar un cuerpo para los errores.

Parámetros de PUBLICAR

Un archivo VoicePlan con parámetros válidos en el cuerpo.

LEER DETALLES DE VoicePlan

SERVICIO WEB REST

WADL: <http o https>://<host>:<port>/VoiceCheck/services/voiceplan?_wadl

URL: <http o https>://<host>:<port>/VoiceCheck/services/voiceplan/{planIdentifier}

Método: OBTENER

Tipo de contenido: application/json;charset=UTF-8

Respuesta: Cuando es correcto, estado HTTP 200 con o sin un cuerpo. Cuando falla, el sistema arroja un error.

ACTUALIZAR DETALLES DE VoicePlan

WADL: <http o https>://<host>:<port>/VoiceCheck/services/voiceplan?_wadl

URL: <http o https>://<host>:<port>/VoiceCheck/services/voiceplan/update/

Método: PUBLICAR

Tipo de contenido: application/json;charset=UTF-8

Respuesta: Cuando es correcto, estado HTTP 200 con o sin un cuerpo. Cuando falla, el sistema arroja un error.

Parámetros de PUBLICAR

Un archivo VoicePlan con parámetros actualizado en el cuerpo.

ELIMINAR DETALLES DE VoicePlan

WADL: <http o https>://<host>:<port>/VoiceCheck/services/voiceplan?_wadl

URL: <http o https>://<host>:<port>/VoiceCheck/services/voiceplan/{planIdentifier}

Método: ELIMINAR

Respuesta: Cuando es correcto, estado HTTP 200 con o sin un cuerpo. Cuando falla, el sistema arroja un error.

ELEMENTOS DE ENTRADA

PROPIEDAD TIPO OBLIG. DEFINICIÓN VALIDACIÓN
planIdentifier

Cadena

Sí El nombre de VoicePlan Debe ser único en VoiceCheck