Servicios web de Asignación
VoiceCheck expone un servicio web que permite la creación de un—, que esencialmente es una importación de datos. Este servicio web permite crear nuevas asignaciones, así como actualizar y eliminar las asignaciones existentes desde el servidor de VoiceCheck.
Una asignación especifica una lista de secciones que se deben realizar y cada sección contiene una lista de pasos que se deben realizar. Cada paso hace referencia a una definición de un paso habilitado para voz desde un VoiceForm.
Este servicio se puede usar para actualizaciones de la asignación y la creación de nuevas asignaciones. Cuando VoiceCheck recibe este mensaje del servicio web, lo revisa para ver si existen coincidencias en el sistema:
- Si no existe una Id. de asignación que coincida y tampoco una Id. de trabajo que coincida en el sistema, se crea una asignación nueva.
- Si existe una Id. de asignación que coincide y la asignación existente está en un estado disponible (no se ha iniciado en VoiceCheck), se reemplaza la asignación existente. Si la asignación está en otro estado, la importación falla.
- Si no existe una Id. de asignación que coincida, pero hay una Id. de trabajo que coincide y la asignación que está relacionada con dicha Id. de trabajo está en un estado completo, se reemplaza la asignación existente. Si la asignación existente está en otro estado, la importación falla. Esta validación permite reutilizar las Id. de trabajo para actualizaciones de la asignación.
Cuando VoiceCheck recibe este mensaje para leer, actualizar y eliminar asignaciones, se tienen en consideración las siguientes validaciones:
- Verificar que la asignación en curso no se puede eliminar con REST en un servidor http
- Verificar que la asignación asignada a un operador y todavía sin iniciar se debe eliminar con REST en un servidor http
- Verificar que la asignación en estado disponible y no asignada a ningún operador se puede eliminar con REST en un http
- Verificar que una asignación terminada al 100 % no se puede eliminar con REST en un http
- Verificar que una asignación cerrada se puede eliminar con REST en un servidor http
- Verificar que una asignación que se volvió a abrir no se puede eliminar con Rest en un servidor http
- Verificar que se capture el avance de la asignación con REST en un servidor http
VoiceCheck indica a los técnicos que realicen cada sección en el orden señalado en el campo sectionsToPerform y solicita los pasos de acuerdo con la secuencia especificada por la propiedad sequenceCounter. Los pasos se pueden enviar en cualquier orden en el mensaje del servicio web; VoiceCheck los ordena según la propiedad sequenceCounter.
Detalles de Crear asignación
Servicio web REST
WADL: <http o https>://<host>:<port>/VoiceCheck/services/assignments?_wadl
URL: <http o https>://<host>:<port>/VoiceCheck/services/assignments
Método: PUBLICAR
Cuerpo del mensaje: XML como se indica en el esquema en WADL, cuyos elementos se describen en las siguientes tablas.
Respuesta: Si es correcto, estado HTTP 204 (sin contenido) con un cuerpo vacío. Cuando falla, el sistema arroja un error. Consulte Manejo de fallas de datos de asignación para obtener más información.
Servicio web SOAP
WSDL: <http o https>://<host>:<port>/VoiceCheck/services/AssignmentService?wsdl
Punto final de servicio: <http o https>://<host>:<port>/VoiceCheck/services/AssignmentService
Operación: createAssignment
Entrada: Un objeto de una sola asignación, como se describe en las siguientes tablas.
Salida: Si es correcto, el sistema devuelve una respuesta vacía como se define en WSDL. Cuando falla, el sistema arroja un error. Consulte Manejo de fallas de datos de asignación para obtener más información.
LEER DETALLES DE LA Asignación
SERVICIO WEB REST
WADL: <http o https>://<host>:<port>/VoiceCheck/services/assignments?_wadl
URL: <http o https>://<host>:<port>/VoiceCheck/services/assignments/Default/{assignmentId}
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.
ELIMINAR DETALLES DE LA Asignación
SERVICIO WEB REST
WADL: <http o https>://<host>:<port>/VoiceCheck/services/assignments?_wadl
URL: <http o https>://<host>:<port>/VoiceCheck/services/assignments/Default/{assignmentId}
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
| Asignación: encabezado | ||||
|---|---|---|---|---|
| Propiedad | Tipo | Obligatorio | Definición | Validación |
| siteName | cadena | sí | El nombre del sitio. | Debe coincidir con un nombre de sitio existente en VoiceCheck. |
| assignmentId | cadena | sí | Identificador único para esta asignación dentro del sitio especificado. | Debe ser único para cada asignación en VoiceCheck, a menos que el registro del servicio web esté actualizando una asignación existente en estado disponible. |
| workId | cadena | sí | Identificador único que el usuario ingresará para solicitar el trabajo. | Debe ser único para cada asignación en VoiceCheck. |
| metadata | lista de pares de clave-valor | no | Una lista de información de paso adicional acerca de la asignación que se enviará de vuelta a el sistema host en el mensaje Publicar resultados de asignación. | Sin validación. VoiceCheck no usa estos datos de paso. |
| operatorId | cadena | no | Identificador único del técnico que se relacionará con esta asignación. | Si se especifica, el valor debe coincidir con una Id. de operador existente. |
| voiceFormName | cadena | sí | El nombre del VoiceForm desde el cual se deben buscar las definiciones de los pasos habilitados para voz para stepsToPerform. | Debe coincidir con un nombre de VoiceForm existente en VoiceCheck. |
| voiceFormVer | Cadena | No | Versión de VoiceForm existente en el sistema | Si se especifica, el valor debe coincidir con una versión existente de VoiceForm. |
| sectionsToPerform | lista de objetos de la sección | sí | Una lista de secciones que se deben realizar, organizadas en el orden que se deben llevar a cabo. Consulte la definición de sección a continuación. | Se debe especificar al menos una sección. |
| Asignación: sección | ||||
|---|---|---|---|---|
| Propiedad | Tipo | Obligatorio | Definición | Validación |
| sectionId | cadena | sí | Un identificador de la sección. La propiedad sectionId debe ser única dentro de la asignación. | Debe ser única dentro de la asignación. |
| sectionDescription | cadena | sí |
Descripción de la sección que se va a realizar. Esta VoiceApplication dice este valor como la descripción de la sección cuando un técnico inicia una nueva sección en el flujo de trabajo. |
|
| sectionIsPart | booleano | sí | Las operaciones en el sistema host se categorizan de acuerdo a si son una pieza o no lo son. Si la operación es una pieza, este campo contiene un valor verdadero, de lo contrario, es falso. Las secciones que son piezas tienen un comportamiento personalizado relacionado con ellas. | |
| partNumber | lista separada por comas | no * |
El número de pieza. Si existen varios números de pieza conocidos para la misma pieza, se deben enviar en una lista separa por comas (no espacios) en este campo. Por ejemplo: 100234,100345,100456 Si se prevé que el material de inspección contenga más de una de la misma pieza, debe crear dos secciones de pieza idénticas (con la misma entrada partNumber) en la asignación. * Obligatorio cuando sectionIsPart = verdadero. |
|
| partDescription | cadena | no * |
El nombre de la pieza. * Obligatorio cuando sectionIsPart = verdadero. |
|
| stepsToPerform | lista de objetos del paso | sí |
Un conjunto de pasos que se deben realizar, enviados en cualquier orden Consulte la definición de paso a continuación. |
Se debe especificar al menos un paso. |
| bucle | Booleano | No | Determina si la sección es una sección de bucle | Solo puede ser verdadero o falso. |
| loopingPrompt | Cadena | No | Mensaje que se le muestra al usuario para confirmar si quiere realizar otra iteración de bucle de esta sección. | Si "bucle" = verdadero "loopingPrompt" debe tener un valor de texto (no nulo ni " ") |
| Asignación: paso | ||||
|---|---|---|---|---|
| Propiedad | Tipo | Obligatorio | Definición | Validación |
| sequenceCounter | cadena numérica | sí |
Número único asignado al paso que determina el orden en que se realiza el paso dentro de la sección. El sistema convierte este valor a un número para ordenar los pasos. |
Debe ser numérico. Debe ser único dentro de la sección. |
| stepId | cadena | sí | Un identificador del paso que se debe realizar desde el VoiceForm. | Debe existir en el VoiceForm al que hace referencia esta asignación. |
| isMandatory | booleano | sí |
Una marca que indica si este paso es obligatorio. Valores válidos: verdadero = el paso es obligatorio falso = el paso no es obligatorio Tenga en cuenta que si se establece como obligatorio, VoiceApplication no permitirá que el técnico responda con "no corresponde". |
Debe contener uno de los valores válidos. |
| promptData | lista de pares de clave-valor | no | Una lista de valores que se deben sustituir por tokens variables en este mensaje de ayuda e indicación del paso. | Sin validación. |
| metadata | lista de pares de clave-valor | no | Una lista de información de paso adicional acerca del paso que se enviará de vuelta al sistema host. en el mensaje Publicar resultados de asignación. | Sin validación. VoiceCheck no usa estos datos de paso. |
Reglas de validación adicionales: Los mensajes de importación createAssignment están sujetos a reglas de validación adicionales para pasos dependientes e Id. de pantalla. VoiceCheck comprueba cada paso que se va a importar con las definiciones del paso de VoiceForm existentes para validar lo siguiente:
- Si un paso hace referencia a otro paso como una Id. de pantalla, que dicho paso de referencia se encuentre en la importación de la asignación.
- Si un paso tiene condiciones que dependen de otro paso, que dicho paso de referencia se encuentre en la importación de la asignación y que siga las reglas para las dependencias de paso. Consulte Reglas para las dependencias de paso.