API CRMWeb

Protocolo público API CRMWeb

V 1.0 Enero 2023

Introducción y contacto

Esta documentación describe el conjunto de métodos del servicio web desarrollado por Ofimática Jaén SL con el objetivo de realizar la integración con el sistema OfiCrm.

Url de acceso al servicio web: http://crmweb.ofi.es/ServicioIntegracionExterno.svc?wsdl

El objetivo de este servicio web, es el acceso vía XML, a obtener información y a poder subir al sistema información propia hacia OfiCrm.

En la siguiente documentación se describe la estructura de los mensajes a enviar en cada método, así como la respuesta obtenida en cada uno de ellos. Además se adjuntan ejemplo de cada uno de ellos.

Para cualquier duda y aspecto a comentar durante su uso, puede contactar con nosotros de Lunes a Viernes, desde las 09:00 hasta las 14:00 y de 16:00 a 19:00 en el siguiente número de teléfono 953 280 144.

WebService

Métodos disponibles para la integración con el Web service OfiCRM:

Servicio Descripción
GetClients Obtención de todos los clientes para la agencia solicitada que se encuentran pendientes de descarga.
SetClients Subida de clientes hacia el sistema de OfiCrm
SetClientEstadoActualizado Establece al cliente como descargado.
SetClienteCodigoActualizado Establece al cliente como actualizado, actualizando el código interno del sistema del que se ha realizado la descarga.
GetExpedientes Obtiene los expedientes marcados para descarga en el sistema de OfiCrm.
SetExpedientes Subida de expedientes hacia el sistema de OfiCrm.
SetExpedienteEstadoActualizado Establece el expediente como descargado.
SetExpedienteNumExpedienteActualizado Establece el expediente como actualizado, actualizando el código interno del sistema del que se ha realizado la descarga.
GetClienteById Obtiene un cliente determinado consultando por Id del sistema de OfiCRM.

GetClients

En este apartado se describe la petición y la respuesta para la obtención de los clientes que se encuentran pendientes de sincronizar. Se indicará un código de agencia para indicar de quien son los clientes a obtener.

Request

Campo Cardinalidad Descripción
GetClients Elemento root de la petición para obtener los clientes pendientes de sincronizar.
Login 1 Elemento root del login
1. Password 1 Contraseña
2. UserName 1 Usuario de acceso
CodeAgency 1 Código de Agencia de al que se va a obtener los clientes
Delegation 1 (Opcional)Delegación

Response

Campo Cardinalidad Descripción
GetClientsResponse 1 Elemento root de la respuesta
1. Errors 1 Descripción del error en el caso de que hubiera ocurrido alguno
2. Success 1 True si OK, False si hay algún error
3. TypeError 1 Tipo de error ocurrido
4. Warnings 0 No se debe de tener en cuenta via XML
5. ListaClientes 0..N Lista de clientes obtenida como resultado de la búsqueda
5.1 AdmiteEmail 1 S/N
5.2 Apellidos 1 Apellidos del cliente
5.3 Cargo 1 Cargo del cliente
5.4 CodigoInterno 1 Codigo de la aplicación con la que se ha sincronizado el cliente. Es el campo que establece la relación con la aplicación de sincronización.
5.5 CodigoPostal 1 Codigo Postal
5.6 Contacto 1 Persona de contacto del cliente
5.7 Delegacion 1 Delegacion
5.8 Direccion 1 Direccion
5.9 Email 1 Email
5.10 Fax 1 Fax
5.11 ID 1 Identificador en OfiCrmWeb
5.12 IdAgencia 1 Id de la agencia
5.13 IdAgenciaCentral 1 Id de la central de la agencia
5.14 IdEmpresaGrupo 1 Id del grupo
5.15 Lista Pasajeros 0..N Lista de pasajeros/empleados del cliente
5.15.1 Apellidos 1 Apellidos
5.15.2 Cargo 1 Cargo
5.15.3 Departamento 1 Departamento
5.15.4 DNI 1 Dni
5.15.5 FechaNacimiento 1 Fecha de nacimiento (yyyyMMdd)
5.15.6 Fijo 1 Telefono fijo
5.15.7 Id 1 Identificador en OfiCrm
5.15.8 Inscripciones 1 Si tiene expedientes true/false
5.15.9 Movil 1 Teléfono móvil
5.15.10 Nombre 1 Nombre
5.15.11 NumPaxOfi 1 Identificador en la aplicación de sincronización
5.15.12 Observaciones 1 Observaciones
5.15.13 Telefono 1 Teléfono
5.16 Localidad 1 Localidad
5.17 Movil1 1 Movil campo 1
5.17 Movil2 1 Movil campo 2
5.17 Nif 1 Nif del cliente
5.18 Nombre 1 Nombre del cliente
5.19 Observaciones 1 Observaciones
5.20 Obsoleto 1 Si esta obsoleto o no true/false
5.21 Pais 1 Pais
5.22 Provincia 1 Provincia
5.23 Razon Social 1 Razón social del cliente
5.24 Telefono 1 Teléfono
5.25 Web 1 Url de la página web

Ejemplo request

Ejemplo response

GetExpedientes

En este apartado se describe la petición y la respuesta para la obtención de los expedientes de OfiCrm pendientes de sincronizar hacia la palicación solicitante.

Se tiene que tener en cuenta que un expediente esta formado por una lista de servicios, los cuales pueden ser de los siguientes tipos:

1 Hoteles
2 Avion
3 Otros
4 Paquetes
5 Coches
6 Cruceros
7 Tren
8 Autobus
9 Restaurante
10 Seguros
11 Barco

Request

Campo Cardinalidad Descripción
GetExpedientes Elemento root de la petición para obtener los expedientes pendientes de sincronizar.
Login 1 Elemento root del login
1. Password 1 Contraseña
2. UserName 1 Usuario de acceso
IdAgencia 1 Código de Agencia de al que se va a obtener los clientes

Response

Campo Cardinalidad Descripción
GetExpedientesResponse 1 Elemento root de la respuesta
1. Errors 1 Descripción del error en el caso de que hubiera ocurrido alguno
2. Success 1 True si OK, False si hay algún error
3. TypeError 1 Tipo de error ocurrido
4. Warnings 0 No se debe de tener en cuenta via XML
5. ListaExpedintes 0..N Lista de expedientes obtenida como resultado de la búsqueda
5.1 Chd 1 Niños
5.2 Cliente 1 Entidad cliente vista anteriormente. Nos va a indicar toda la información del cleinte del expediente.
5.3 Descripcion 1 Descipcion del expediente
5.4 Destino 1 Destino genérico del expediente.
5.5 Estado 1 Si está cancelado el valor es 4 y sino es 1
5.6 Situacion 1 Si está cancelado es 35 y sino 0
5.7 ExpOfi 1 Identificado de la aplicacion de destino donde se sincroniza
5.8 Fecha 1 DateTime con la fecha de Creacion
5.9 FechaLLegada 1 Fecha de llegada del expediente
5.10 FechaSalida 1 Fecha salida del expediente
5.11 ID 1 Identificador en OfiCrmWeb
5.12 IdAgencia 1 Id de la agencia
5.13 IdAgenciaCentral 1 Id de la central de la agencia
5.14 IdEmpresa 1 Id del cliente en OfiCrm
5.15 IdSucursal 1 Id de la sucursal en OfiCrm
5.16 IdUsuario 1 Id del usuario del expediente
5.17 Importe Bruto 1 Importe bruto del expediente
5.17 Importe Neto 1 Importe neto del expediente
5.18 Lista Servicios 0..N Lista de servicios del expediente
5.18.1 Categoria 1 Categoria del Hotel
5.18.2 CodSincro 1 Identificador del servicio en la aplicacion que lo sincroniza.
5.18.3 Descripcion 1 Descripcion del Servicio
5.18.4 Descuento 1 Importe de descuento
5.18.5 Destino 1 Destino del Servicio
5.18.6 DestinoVuelo 1 Destino del servicio en Avion
5.18.7 Estado 1 2 - Borrado 0 -Abierto
5.18.8 FechaDesde 1 Fecha desde del servicio
5.18.9 FechaHasta 1 Fecha hastadel servicio
5.18.10 Gastos de Gestión 1 Importe de gastos de gestión
5.18.11 Id 1 Identificador del servicio
5.18.12 ImporteBruto 1 Importe bruto del servicio
5.18.13 ImporteNeto 1 Importe neto del servicio
5.18.14 ListaBilletes 0..N Lista de billetes en el caso de Avion y tren
5.18.14.1 Descripcion 1 Descripcion
5.18.14.2 Id 1 Identificador del Billete
5.18.14.3 Segmentos 0..N Segmentos/ trayectos del billete
5.18.14.3.1 Clase 1 Clase del vuelo
5.18.14.3.2 Compañia 1 Compañia del vuelo
5.18.14.3.3 Destino 1 Destino del vuelo
5.18.14.3.4 Fecha LLegada 1 Fecha llegada del vuelo
5.18.14.3.5 Fecha Salida 1 Fecha salida del vuelo
5.18.14.3.6 Id 1 Identificados del trayecto del vuelo
5.18.14.3.7 NumVuelo 1 Número del vuelo
5.18.14.3.8 Salida 1 Destino de salida del vuelo
5.18.14.3.9 Situación 1 Situación del vuelo
5.18.14.4 NombrePasajero 1 Nombre pasajero vuelo
5.18.14.5 NumAdultos 1 Número de adultos
5.18.14.6 NumBillete 1 Numero de billete
5.18.14.7 NumNiños 1 Número de niños
5.18.14.8 TotalBruto 1 Importe Bruto
5.18.14.9 TotalNeto 1 Importe neto
5.18.15 NumAdultos 1 Número de adultos
5.18.16 NumNiños 1 Número de niños
5.18.17 NumPax 1 Número de pasajeros
5.18.15 NumServicioOfi 1 Número de servicio en la aplicación de sincronización.
5.18.16 NumeroHabitaciones 1 Número de habitaciones
5.18.17 Origen 1 Origen del servicio
5.18.17 OrigenVuelo 1 Origen del servicio de vuelo
5.18.18 Prestatario 1 Descripcion del prestatario del servicio
5.18.19 Regimen 1 Regimen del servicio
5.18.20 SalidaVuelo 1 Salida del servicio de vuelo
5.18.21 TextoLibre 1 Texto del servicio
5.18.22 TextoPresentacion 1 Texto del servicio
5.18.23 TipoHab 1 Tipo de habitación del servicio
5.18.24 TipoServicio 1 Tipo del servicio. Ya indicado arriba.
5.18.25 TipoVehiculo 1 Tipo de coche en los rent a car
5.19 Localizador 1 localizador del expediente
5.20 NumPax 1 Numero de pasajerosde expediente
5.21 Observaciones 1 Observaciones del expediente
5.22 OrigenSincro 1 3 - Externo
5.23 Situacion 1 Situacion del expediente
5.24 TipoExpediente 1 Tipo de expediente
5.25 Titulo 1 Título de expediente
5.26 Usuario 1 Usuario del expediente

Ejemplo request

Ejemplo response

SetExpedientes

En este apartado se describe la petición y la respuesta para la subida de expedientes hacia OfiCrm.

Request

Campo Cardinalidad Descripción
SetExpedientes Elemento root de la petición para obtener los expedientes pendientes de sincronizar.
Login 1 Elemento root del login
1. Password 1 Contraseña
2. UserName 1 Usuario de acceso
3.Expediente 1 Nodo root con la información del expediente a subir. Tendrá la misma caracteristicas que cuando se obtiene un expediente.

Response

Campo Cardinalidad Descripción
SetExpedienteResponse 1 Elemento root de la respuesta
1. Errors 1 Descripción del error en el caso de que hubiera ocurrido alguno
2. Success 1 True si OK, False si hay algún error
3. TypeError 1 Tipo de error ocurrido
4. Warnings 0 No se debe de tener en cuenta via XML
5. Id 1 Identificador del cliente creado en OfiCrm
6. ListaCodigosPax 1 Lista de los codigo creados en CRM con los de la aplicacion de sincronización.
6.1 IdPax 1 Identificador
7.2 NumPaxOfi 1 Identificador en el sistema origen.

Ejemplo request

Ejemplo response

SetClient

En este apartado se describe la petición y la respuesta para la subida de clientes hacia OfiCrm.

Request

Campo Cardinalidad Descripción
SetClient Elemento root de la petición para obtener los expedientes pendientes de sincronizar.
Login 1 Elemento root del login
1. Password 1 Contraseña
2. UserName 1 Usuario de acceso
3.Cliente 1 Nodo root con la información del cliente a subir. Tendrá la misma caracteristicas que cuando se obtiene un cliente.

Response

Campo Cardinalidad Descripción
SetClientResponse 1 Elemento root de la respuesta
1. Errors 1 Descripción del error en el caso de que hubiera ocurrido alguno
2. Success 1 True si OK, False si hay algún error
3. TypeError 1 Tipo de error ocurrido
4. Warnings 0 No se debe de tener en cuenta via XML
5. Id 1 Identificador del cliente creado en OfiCrm
6. ListaCodigosPax 0..N Lista de claves de los pasajeros del cliente, para establecer equivalencias.
6.1 IdPax 1 Identificador
6.2 NumPaxOfi 1 Identificador en el sistema origen.

Ejemplo request

Ejemplo response

SetClientEstadoActualizado

En este apartado se describe la petición y la respuesta para actualizar al clinte como descargado en OfiCrm.

Request

Campo Cardinalidad Descripción
SetClientEstadoActualizado Elemento root de la petición.
Login 1 Elemento root del login
1. Password 1 Contraseña
2. UserName 1 Usuario de acceso
3.ID 1 Identificador de Cliente de CRM a actualizar como descargado.

Response

Campo Cardinalidad Descripción
SetClientEstadoResponse 1 Elemento root de la respuesta
1. Errors 1 Descripción del error en el caso de que hubiera ocurrido alguno
2. Success 1 True si OK, False si hay algún error
3. TypeError 1 Tipo de error ocurrido
4. Warnings 0 No se debe de tener en cuenta via XML

Ejemplo request

Ejemplo response

SetClienteCodigoActualizado

En este apartado se describe la petición y la respuesta para actualizar el ID de Cliente con el que se ha sincronizado.

Request

Campo Cardinalidad Descripción
SetClienteCodigoActualizado Elemento root de la petición.
Login 1 Elemento root del login
1. Password 1 Contraseña
2. UserName 1 Usuario de acceso
3.ID 1 Identificador de Cliente de CRM a actualizar.
4.CodigoInterno 1 Identificador de Cliente en la aplicacion que se va a actualizar en OfiCm.

Response

Campo Cardinalidad Descripción
SetClienteCodigoActualizadoResponse 1 Elemento root de la respuesta
1. Errors 1 Descripción del error en el caso de que hubiera ocurrido alguno
2. Success 1 True si OK, False si hay algún error
3. TypeError 1 Tipo de error ocurrido
4. Warnings 0 No se debe de tener en cuenta via XML
5. ID 1 Identificador

Ejemplo request

Ejemplo response

SetExpedienteEstadoActualizado

En este apartado se describe la petición y la respuesta para actualizar al expediente como descargado en OfiCrm.

Request

Campo Cardinalidad Descripción
SetExpedienteEstadoActualizado Elemento root de la petición.
Login 1 Elemento root del login
1. Password 1 Contraseña
2. UserName 1 Usuario de acceso
3.IdExpedienteCrmWeb 1 Identificador de Expediente de CRM a actualizar como descargado.
4.OrigenSincro 1 Origen del expediente 3 - Externo.

Response

Campo Cardinalidad Descripción
SetExpedienteEstadoActualizadoResponse 1 Elemento root de la respuesta
1. Errors 1 Descripción del error en el caso de que hubiera ocurrido alguno
2. Success 1 True si OK, False si hay algún error
3. TypeError 1 Tipo de error ocurrido
4. Warnings 0 No se debe de tener en cuenta via XML

Ejemplo request

Ejemplo response

SetExpedienteNumExpedienteActualizado

En este apartado se describe la petición y la respuesta para actualizar los valores de sincronización en OfiCrm, para asi establecer las equivalencias.

Request

Campo Cardinalidad Descripción
SetExpedienteNumExpedienteActualizado Elemento root de la petición para obtener los expedientes pendientes de sincronizar.
Login 1 Elemento root del login
1. Password 1 Contraseña
2. UserName 1 Usuario de acceso
3.IdCrmWeb 1 Identificador del Expediente de CRM a actualizar.
4.ListaIdentificadoresServicios 0..N Nodo root para indicar la equivalencia de los servicios del Expediente de CRM a actualizar.
4.1.Id 1 Identificador en CRM.
4.2.IdSecundario 1 Identificador en CRM.
4.3.NumOfi 1 Identificador en la aplicación de sincronización.
4.4.OrigenSincro 1 3-Externo.
4.5.TipoServicio 1 Tipo de Servicio (A- Avion,...).
5.NumExpediente 1 Identificador del Expediente en la aplicación de sincronización.

Response

Campo Cardinalidad Descripción
SetClientEstadoResponse 1 Elemento root de la respuesta
1. Errors 1 Descripción del error en el caso de que hubiera ocurrido alguno
2. Success 1 True si OK, False si hay algún error
3. TypeError 1 Tipo de error ocurrido
4. Warnings 0 No se debe de tener en cuenta via XML

Ejemplo request

Ejemplo response