Servicios Formiik. Versión 1.2 (Draft) Fecha de Creación: Enero 16, 2012

Transcripción

1 Servicios Formiik Versión 1.2 (Draft) Autores: Pablo Monroy Fecha de Creación: Enero 16,

2 Servicios Formiik Formiik expone sus Servicios Web para que sus clientes puedan desplegar las órdenes de trabajo para que sus operadores puedan recabar la información usada en sus procesos de negocio. Así mismo les solicita a sus Clientes que construyan sus propios Servicios Web para que Formiik pueda entregar las respuestas de la información recabada por sus operadores desde sus dispositivos móviles. El Cliente usa los Servicios de Formiik Formiik usa los Servicios del Cliente Cliente

3 Servicios Web SOAP que expone Formiik Mensajes a Operadores Nombre del servicio Parámetros Tipo de Dato QueueMessageToUserName QueueMessageToUserNames clientid productid username Sender Content isimportant clientid productid usernames Sender Content isimportant [] Requerido? Descripción Dato Valor de retorno Identificador con el cual será reconocido el cliente Identificador con el que se reconocerá la aplicación del cliente Usuario al que se le enviará el mensaje Texto que describe quién es el remitente Texto del contenido de mensajes Valores permitidos: si ó no Identificador con el cual será reconocido el cliente Identificador con el que se reconocerá la aplicación del cliente Arreglo de s con los usuarios a los que se les enviará el mensaje Texto que describe quién es el remitente Texto del contenido de mensajes Valores permitidos: si ó no Descripción servicio Este servicio envía mensajes a un usuario en específico. Devuelve vacío si no hay error, si existe error devuelve una excepción. Este servicio envía mensajes a una lista de usuarios. Devuelve vacío si no hay error, si existe error devuelve una excepción.

4 Agregar Órdenes Nombre del servicio Parámetros Tipo de Dato Requerido? Descripción Dato Valor de retorno Identificador con el cual será reconocido clientid String el cliente Identificador con el AddWorkOrdersXML que se reconocerá la void productid String aplicación del cliente XML con N número de ordenes para workorders String agregar. Descripción servicio Este servicio envía un conjunto de órdenes. XML con N número de ordenes para agregar Parámetro Formato expirationdate cancellationdate Parámetro Estado Calle Colonia Municipio Ciudad Codigo Postal MM/DD/AAAA HH:MM:SS (24 hrs.) MM/DD/AAAA HH:MM:SS (24 hrs.) Requerido? Nombre

5

6 Cancelar Órdenes Nombre del servicio Parámetros Tipo de Dato Requerido? Descripción Dato Valor de retorno Identificador con el cual será clientid reconocido el cliente Identificador con el que se CancelWorkOrdersXML reconocerá la aplicación del void productid cliente XML con N número de cancelorders ordenes a cancelar. Descripción servicio Este servicio sirve para cancelar un conjunto de órdenes y borrarlas del dispositivo móvil. XML con N número de ordenes a cancelar

7 Actualizar Órdenes Nombre del servicio Parámetros Tipo de Dato Requerido? Descripción Dato Valor de retorno Identificador con el cual será clientid reconocido el cliente Identificador con el que se UpdateWorkOrdersXML reconocerá la aplicación del void productid cliente XML con N número de ordenes workorders a actualizar. Descripción servicio Este servicio sirve para actualizar los datos de las órdenes. NOTA: Es obligatorio enviar todos los datos que se enviaron en la orden original. XML con N número de ordenes para actualizar Parámetro Formato expirationdate cancellationdate Parámetro Estado Calle Colonia Municipio Ciudad Codigo Postal MM/DD/AAAA HH:MM:SS (24 hrs.) MM/DD/AAAA HH:MM:SS (24 hrs.) Requerido? Nombre

8

9 Actividad del Operador Nombre del servicio Parámetros Tipo de Dato GetUserActivity Client Users initialdate finaldate Requerido? Descripción Dato Valor de retorno Identificador con el cual será reconocido el cliente XML con los usuarios de los que se requiera el reporte de actividad. Fecha inicial del reporte. Fecha final del reporte. Descripción servicio Este servicio envía el reporte de la actividad de los usuarios. Devuelve el XML de la actividad. XML con la información del operador

10 Servicios Web REST que expone el Cliente Autenticación de Usuarios Simple Nombre del servicio ValidateUserForDevice ValidateUserSimple Parámetros XML Descripción Tipo de Dato Requerido? Descripción Dato Valor de retorno Descripción servicio username Usuario firmado password serialnumber Contraseña con la que se firmará el usuario Número de serie del dispositivo username Usuario firmado password Contraseña con la que se firmará el usuario String String Permite el ingreso al sistema por dispositivo. Devuelve vacío si es un usuario válido de lo contrario se retorna el error del acceso (p.e. "username no registrado", "password incorrecto"). Permite el ingreso al sistema por web. Devuelve vacío si es un usuarío válido de lo contrario se retorna el error del acceso (p.e. "username no registrado", "password incorrecto"). Autenticación de Usuarios que regresan Grupo y Rol Nombre del servicio ValidateUserForDeviceReturnGr oup Parámetros XML Parámetros Tipo de Dato Requerido? Descripción Dato Valor de retorno Descripción servicio username Usuario firmado password serialnumber Contraseña con la que se firmará el usuario Número de serie del dispositivo String Permite el ingreso al sistema por dispositivo. Si es válido el usuario devuelve con XML con el grupo y rol al que pertenece ese usuario, si es inválido devuelve con la excepción.

11 ValidateUserSimpleReturnGroup Devuelve con XML con el grupo y rol al que pertenece ese usuario (Valor de retorno) username Usuario firmado password Contraseña con la que se firmará el usuario String Permite el ingreso al sistema por web. Si es válido el usuario devuelve con XML con el grupo y rol al que pertenece ese usuario, si es inválido devuelve con la excepción. Actualización de Catálogos Nombre del servicio GetUserCatalog Parámetros XML Este XML contiene los catálogos para el usuario (Valor de retorno) Parámetros Tipo de Dato username password Requerido? Descripción Dato Valor de retorno Descripción servicio Usuario por el que se limitará la búsqueda Contraseña con la que se firmará el usuario String Devuelve los catálogos al dispositivo en una cadena de texto que contiene el XML. Este XML contiene los catálogos para ese usuario, por ejemplo puede implicar código postal y colonias de la zona a la que está asignado el usuario.

12 Recepción de Respuestas Nombre del servicio SendWorkOrderToClient Parámetros XML Tipo de Dato Requerido? Descripción Dato Descripción servicio Identificador de la externalid NO orden con que se envió Fecha en que se synchronizationdate NO sincronizó el dispositivo para bajar la orden externaltype NO Tipo de la forma assignedto NO xmlresponse NO initialdate NO enddate NO initiallatitude NO initiallongitude NO endlatitude NO endlongitude NO Identificador de la persona que respondió la orden Respuestas que se generaron Fecha y hora en que se comenzó a contestar la orden. Fecha y hora en que se terminó de contestar la orden. Latitud de posición en que se comenzó a contestar la orden Longitud de posición en que se comenzó a contestar la orden Latitud de posición en que se terminó de contestar la orden Longitud de posición en que se terminó de contestar la orden Se reciben las respuestas de los dispositivos.

13 Actualizar Orden Nombre del servicio Parámetros Tipo de Dato Requerido? Descripción Dato Valor de retorno Descripción servicio UpdateWorkOrder xmlupdateorder Datos de búsqueda. Se reciben los datos de búsqueda (Parámetros) Se reciben los datos de búsqueda, estos datos deben de coincidir con los datos marcados en el formulario como de búsqueda, ej. RFC, Nombre, Apellidos. Además de estos datos se recibirá el tipo de formulario para que el servicio sepa que regresar. Este servicio de regresará un que contiene un XML con datos con los que se prellenara la solicitud, los tags del XML deben de coincidir con las que se definieron en el formulario, entre estos datos regresará el número de solicitud asignado. Regresará un que contiene un XML con datos con los que se pre-llenara la solicitud (Valor de retorno)

14 Informe de Errores Nombre del servicio Parámetros Tipo de Dato Requerido? Descripción Dato Valor de retorno Descripción servicio xmlerrors Errores que se generaron. Recibe que contiene un XML con los errores que se hayan generado en los métodos SetErrors AddWorkOrdersXML, CancelWorkOrdersXML y UpdateWorkOrdersXML. Devuelve cadena vacía si no hubo error o la excepción del error. Se reciben los datos de los errores (Parámetros)