Apis de carga de servicios en Swagger
Antes de empezar...
Es importante desinstalar la versión anterior de la App Evidence e instalar la nueva versión.
Para descargar el aplicativo Evidence: http://e.ubiqo.net
En éste manual se ejemplifica la visualización real de las API en la plataforma UBIQO y sus respectivas relaciones.
Todos los métodos incluyen basic authentication
Autenticación Bearer
Habilitar Autorización
- Presione el botón “Authorize” ubicado en la parte superior derecha.
Ingresar Token
- A continuación ingrese el valor conforme a la siguiente estructura, colocando la palabra ‘Bearer’ + espacio + Token (El token es proporcionado por Ubiqo)
Bearer TOKENUBIQO |
|---|
Asignar Servicios
POST /v1/AsignaServicios
Crea y asigna servicios a cuentas de plataforma Ubiqo y/o directamente a dispositivos Evidence en especifico.
 | A continuación se muestra la estructura del json que se deberá llenar de acuerdo a cada tipo de valor solicitado. Recuerde que la ruta se estará generando tomando como punto de inicio el 1er servicio y como punto final el último servicio, el resto de servicios se ordenarán en base a la ruta más optima. |
|---|
Ejemplo de descripción del Json Asignar Servicios
A continuación se muestra un ejemplo de la equivalencia de los datos visualizados en la plataforma de Ubiqo.
{ "titulo": "Actividad 1", "descripcion": "Visita a cliente", "direccion": "Prol. Bernardo Quintana 28, Alamos 2da Secc, 76160 Santiago de Querétaro, Qro. México", "latitud": 20.6065641, "longitud": -100.3810742, "idInterno": "10001", "idFormularios": [ 1824 ], |  |
|---|---|
"usuarioAdministra": "Supervisor", "tags": [ "Sur" ], | ---> Cuenta a la que se asignarán las actividades. |
"idPerfilCargaValoresDefault": 0, "aliasMovil": "Evidence 01", "referencias": "Casa Blanca" } | ---> Dispositivo Evidence al que se le asignará la actividad. |
Respuestas al ejecutar el proceso Asignar servicios
Al ejecutar la asignación arrojará como respuesta cualquiera de los siguientes escenarios.
Código 500
Ocurrió un error durante el procesamiento, verifique que la estructura de la información sea la correcta.
Código 200
Se crearon y asignaron con éxito los servicios enviados.
Estatus de Carga de Servicios
GET /v1/ConsultaEstadoCarga/{keyCarga}
Permite conocer el estatus de carga de los servicios enviados, por medio de una llave de carga.
Eliminar todas las actividades asignadas sin iniciar
Limpieza de Actividades
POST /v1/EliminarTodasAsignadasSinIniciar
Elimina todas las actividades asignadas a todos los dispositivos del cliente que aún no hayan sido iniciadas. Es una llamada directa: no requiere parámetros en el cuerpo de la solicitud.
Estatus que se eliminan: | |||
|---|---|---|---|
| |||
Parámetros | | ||
Nombre | Tipo | Requerido | Descripción |
---- | ---- | No | Esta API no recibe parámetros. Actúa sobre todas las actividades sin iniciar del cliente autenticado. |
Eliminar actividades sin iniciar por dispositivo
Limpieza de Actividades
POST /v1/EliminaAsignadasSinIniciarPorDispositivo
Elimina únicamente las actividades sin iniciar que estén asignadas a los dispositivos que se especifiquen en la solicitud. El resto de los dispositivos no se ven afectados.
| Parámetros | | ||
|---|---|---|---|---|
| Nombre | Tipo | Requerido | Descripción |
[ 100, 101, 102, ] | idDispositivo | array de strings | Si | Lista de IDs de los dispositivos. Son los identificadores únicos generados por la plataforma Ubiqo. |
Eliminar actividades sin iniciar por lista de actividades
Limpieza de Actividades
POST /v1/EliminaAsignadasSinIniciar
Elimina actividades asignadas sin iniciar por id interno del cliente.
| Parámetros | | ||
|---|---|---|---|---|
| Nombre | Tipo | Requerido | Descripción |
[ “XXX002”, “XXX003”, “XXX004”, ] | idInterno | array de strings | Si | ID interno definido por el cliente para esa actividad. |
Advertencia crítica: pérdida de datos en modo offline
Limpieza de Actividades
Antes de ejecutar cualquiera de las tres APIs anteriores, considera lo siguiente:
Si una actividad fue iniciada o finalizada mientras el dispositivo no tenía conexión a Internet, ejecutar cualquiera de estas APIs puede provocar la pérdida de esa información.
Mientras los cambios no se sincronicen, la plataforma mostrará la actividad con el estado "Sin iniciar", aunque el usuario ya la haya comenzado o concluido desde el dispositivo.
Para evitar la pérdida de información:
Espera a que el dispositivo recupere la conexión para que las actividades se sincronicen y actualicen su estado a "En proceso", "Enviando" o el que corresponda. Si es posible, inicia las actividades únicamente cuando el dispositivo tenga conexión a Internet.
Una vez que las actividades estén sincronizadas, podrás ejecutar estas APIs sin afectar la información registrada.