Servicios web de VoiceForm

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

• Si no hay coincidencia de nombre de VoiceForm, se crea un VoiceForm nuevo.
• Si hay una coincidencia de nombre de VoiceForm, no se crea un VoiceForm nuevo.

Se puede importar un VoiceForm con o sin pasos de VoiceForm. Esto permite que un técnico cree pasos de VoiceForm más tarde, desde el servidor de VoiceCheck.

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

• Si el nombre de VoiceForm no existe en VoiceCheck, no se arrojan detalles en la respuesta.
• Si hay un VoiceForm, el servicio web puede actualizar solo el nombre del VoiceForm.
• Si el VoiceForm no hace referencia a ninguna otra entidad en VoiceCheck, se puede eliminar. De lo contrario, no se permite eliminar el VoiceForm.

Crear detalles de VoiceForm

Servicio web REST

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

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

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 “VoiceForm 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 VoiceForm con parámetros válidos en el cuerpo.

LEER DETALLES DE VOICEFORM

SERVICIO WEB REST

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

URL: <http o https>://<host>:<port>/VoiceCheck/services/voiceform/{voiceformname}

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 VOICEFORM

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

URL: <http o https>://<host>:<port>/VoiceCheck/services/voiceform/update/{voiceformname}/{newvoiceformname} ​

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.

ELIMINAR DETALLES DE VOICEFORM

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

URL: <http o https>://<host>:<port>/VoiceCheck/services/voiceform/{voiceformname}

Método: ELIMINAR

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

Administrar imágenes

SERVICIO WEB REST

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

URL: <http o https>://<VoiceCheckIP>:<port>/VoiceCheck/services/imageService/<Directory/Folder Name><Directory/Folder Name>.....<photo filename with extension>

Método: OBTENER

Parámetro: Ruta de imagen en el sistema del archivo con el nombre de la imagen (el parámetro se envía en la URL)

Tipo de contenido: (en blanco)

Respuesta: Si es correcto, estado HTTP 200. Cuando no se encuentra la foto, el servicio genera una WebAppplicationException con estado HTTP 404 No encontrado.

Autenticación básica: nombre de usuario y contraseña de VoiceCheck

ELEMENTOS DE ENTRADA

PROPIEDAD	TIPO	OBLIG.	DEFINICIÓN	VALIDACIÓN
voiceformname	Cadena	Sí	El nombre del VoiceForm	Debe ser único en VoiceCheck