Descargar de Reservas en OfiViaje

Protocolo público integración de reservas online

V 1.0 Mayo 2019

Introducción y contacto

Esta documentación describe los métodos web a desarrollar por un tercero, para que una aplicación Ofi puede descargar reservas on-line mediante peticiones POST de otro sistema.

El objetivo de este servicio web, es el de permitir la descarga de reservas vía XML hacía un programa Ofi.

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 a desarrollar

Las operaciones que deben de estar disponibles a fin de poder descargar reservas son los siguientes:

Servicio	Descripción
Listado de Reservas	Método para obtener una lista de reservas pendientes de descarga
Descarga de Reserva	Método para obtener una de reserva en concreto pendiente de descarga
Reserva Descargada	Método para indicar que una de reserva ya ha sido descargada y no se debe de volver a descargar

Es aconsejable la existencia de dos entornos TEST y LIVE

Lista de Reservas

En este apartado se describe la petición y la respuesta de descarga de lista de reservas a partir de un usuario, contraseña y un margen de fechas.

De manera que el sistema debe de devolver una lista de reservas con datos mínimos que coincidan con los criterios de búsqueda seleccionados.

Request

Campo	Cardinalidad	Tipo	Descripción
DameReservasPendientesDeDescarga	1		Elemento root de la petición de descarga de reservas.
1. usuario	1	string	Usuario para login.
2. contraseña	1	string	Contraseña para login.
3. fechaDesde	1	dateTime	Fecha desde la cual se solicitan las reservas, podría ser fecha de salida de la reserva / Fecha de alta de la reserva.
4. fechaHasta	1	dateTime	Fecha hasta la cual se solicitan las reservas, se basa en el mismo campo que la fecha desde.

Response

Campo	Cardinalidad	Tipo	Descripción
DameReservasPendientesDeDescargaResponse	1
DameReservasPendientesDeDescargaResult	1
1. Error	0..1		Este nodo aparece en caso de que se produzca alguna incidencia al descargar la lista de reservas
1.1. Descripcion	1	string	Descripción de la incidencia que se ha producido en la descarga de reservas
2. ReservasPendientesDeValidar	0..1
2.1 ResumenReservaAgencia	1..N		Nodo que se mostrara por cada reserva pendiente de descarga
2.1.1 IdExpediente	1	string	Identificador de la reserva en su sistema
2.1.2 Localizador	1	string	Localizador de la reserva
2.1.3 FechaReserva	1	string	Fecha de la reserva
2.1.4 Contacto	1	string	Nombre del pasajero de la reserva
2.1.5 Telefono	1	string	Teléfono del pasajero de la reserva
2.1.6 Servicios	1		Desglose de los servicios de la reserva
2.1.6.1 ResumenServicioAgencia	1..N
2.1.6.1.1 Tipo	1	string	Tipo de servicios*
2.1.6.1.2 Proveedor	1	string	Nombre del proveedor en su sistema
2.1.6.1.3 Localizador	1	string	Localizador del proveedor para dicho servicio
2.1.6.1.4 Descripcion	1	string	Descripción del servicio
2.1.6.1.5 FechaInicio	1	dateTime	Fecha de inicio del servicio
2.1.6.1.6 FechaFin	1	dateTime	Fecha Fin del servicio
2.1.6.1.7 Cif	1	string	Cif del proveedor

Ejemplo request

Ejemplo response

Descarga de Reservas

En este apartado se describe la petición y la respuesta de descarga de una reserva a partir de un usuario, contraseña y un localizador.

De manera que el sistema debe de devolver los datos de dicha reserva.

Request

Campo	Cardinalidad	Tipo	Descripción
DameReservaAgencia	1		Elemento root de la petición de descarga de reservas.
1. usuario	1	string	Usuario para login.
2. contraseña	1	string	Contraseña para login.
3. localizador	1	string	Localizador de la reserva a descargar.

Response

Campo	Cardinalidad	Tipo	Descripción
DameReservaAgenciaResponse	1		Elemento root de la respuesta de búsqueda de vuelos
DameReservaAgenciaResult	1
1. Error	0..1		Este nodo aparece en caso de que se produzca alguna incidencia al descargar la reserva
1.1. Descripcion	1	string	Descripción de la incidencia que se ha producido en la descarga de la reserva
2. ReservaAgencia	0..1
2.1 IdentificacionReserva	1
2.1.1 Localizador	1	string	Localizador de la reserva
2.1.2 Estado	1	string	Estado de la reserva OK / C - Cancelada / A - Anulada
2.1.3 EstadoEnvio	1	string	Estado de la reserva, siempre Alta
2.1.4 FechaReserva	1	dateTime	Fecha de la reserva
2.1.5 CodigoAgencia	1	string	Código identificativo del cliente en su sistema
2.2 Cliente	1
2.2.1 Nombre	1	string	Nombre del Cliente / Agencia de la reserva
2.2.2 Email	1	string	Email
2.2.3 Telefono	1	string	Teléfono del Cliente / Agencia de la reserva
2.2.4 TipoDocumento	1	string	Identifica el documento que se envía en el nodo Documento, puede ser D-DNI o P-Pasaporte
2.2.5 Documento	1	string	Documento identificativo del Cliente / Agencia de la reserva
2.3 Pasajeros	1
2.3.1 Pasajero	1..N
2.3.1.1 Nombre	1	string	Nombre del pasajero de la reserva
2.3.1.2 Apellidos	1	string	Apellidos del pasajero de la reserva
2.3.1.3 Email	1	string	Email
2.3.1.4 Telefono	1	string	Teléfono del pasajero de la reserva
2.3.1.5 Movil	1	string	Móvil del pasajero de la reserva
2.3.1.6 TipoDocumento	1	string	Identifica el documento que se envía en el nodo Documento, puede ser D-DNI o P-Pasaporte
2.3.1.7 NumeroDocumento	1	string	Documento identificativo del pasajero de la reserva
2.3.1.8 FechaCaducidadDocumento	1	dateTime	Fecha de caducidad del Documento identificativo del pasajero de la reserva
2.3.1.9 FechaNacimiento	1	dateTime	Fecha de nacimiento del pasajero
2.3.1.10 NivelEdadPax	1	string	Nivel de edad del pasajero (A)dulto / (N)iño / (B)ebé / (M)ayor
2.3.1.11 CodigoPais	1	string	Código ISO del país
2.3.1.12 Pais	1	string	Nombre del país
2.4 Servicios	1		Desglose de los servicios de la reserva
2.4.1 ServicioReserva	1..N
2.4.1.1 Tipo	1	string	Tipo de servicios*
2.4.1.2 Descripcion	1	string	Descripción del Servicio
2.4.1.3 Regimen	1	string	Régimen del servicio
2.4.1.4 TotalPaxAdultos	1	integer	Número total de pasajeros adultos del servicio
2.4.1.5 TotalPaxNiñosYBebes	1	integer	Número total de pasajeros no adultos del servicio
2.4.1.6 Prestatario	1		Datos del proveedor que presta el servicio
2.4.1.6.1 Nombre	1	string
2.4.1.6.2 Direccion	1	string
2.4.1.6.3 CodPostal	1	string
2.4.1.6.4 Poblacion	1	string
2.4.1.6.5 Provincia	1	string
2.4.1.6.6 Pais	1	string
2.4.1.6.7 Provincia	1	string
2.4.1.6.8 Cif	1	string
2.4.1.7 Localizador	1	string	Localizador del proveedor
2.4.1.8 ConfirmadaPor	1	string
2.4.1.9 FechaConfirmacion	1	dateTime
2.4.1.10 FechaInicio	1	dateTime	Fecha de inicio del servicio
2.4.1.11 FechaFin	1	dateTime	Fecha de finalización del servicio
2.4.1.12 DesgloseHabitaciones	0..1		Desglose de habitaciones del servicio
2.4.1.12.1 DesgloseHabitacion	1..N
2.4.1.12.1.1 IdHabitacion	1	string	Identificador del tipo de habitación de su sistema
2.4.1.12.1.2 Descripcion	1	string
2.4.1.12.1.3 Unidades	1	integer	nº de habitaciones
2.4.1.13 ValoracionServicio	1
2.4.1.13.1 Venta	1
2.4.1.13.1.1 ExentoImpuesto	1	boolean	Indica si está sujeto a IVA o Exento del mismo
2.4.1.13.1.2 ImporteComisionable	1	double
2.4.1.13.1.3 ImporteNoComisionable	1	double
2.4.1.13.1.4 ImporteAjuste	1	double	Importe de gastos de gestión aplicados
2.4.1.13.1.5 ImporteUATP	1	double	Importe que se ha pagado directamente por el cliente final al proveedor
2.4.1.13.1.6 PagoDirecto	1	boolean
2.4.1.13.2 Coste	1
2.4.1.13.2.1 ImporteComisionable	1	double
2.4.1.13.2.2 ImporteNoComisionable	1	double
2.4.1.14 DatosAdicionales	0..1
2.4.1.14.1 DatosAdicionales	1..N		Itinerarío del servicio
2.4.1.14.1.1 Fecha	1	string
2.4.1.14.1.2 Regimen	1	string
2.4.1.14.1.3 Descripcion	1	string
2.5 Valoracion	1
2.5.1 TotalVenta	1	double
2.5.2 TotalCoste	1	double
2.5.3 TotalGastosGestion	1	double
2.6 Cobros	0..1
2.6.1 Cobro	1..N		Cobros realizados en la reserva
2.6.1.1 Descripcion	1	string
2.6.1.2 Fecha	1	dateTime
2.6.1.3 Importe	1	double
2.6.1.4 Concepto	1	string
2.6.1.5 DocumentoCobro	1	string
2.7 Billetes	0..1		Desglose de billetes de la reserva
2.7.1 Billete	1..N
2.7.1.1 CodigoCompañia	1	string
2.7.1.2 NumeroBillete	1	string
2.7.1.3 Conexionado	1	boolean	Indica si es un billete conexionado con su anterior, en el caso de ser conexionado el billete principal deberá de llevar todos los importes
2.7.1.4 Trayecto	1	string
2.7.1.5 Valoracion	1
2.7.1.5.1 Venta	1
2.7.1.5.1.1 ExentoIva	1	boolean
2.7.1.5.1.2 ImporteComisionable	1	double
2.7.1.5.1.3 ImporteSf	1	double
2.7.1.5.1.4 ImporteTasasExentas	1	double
2.7.1.5.1.5 ImporteTasasSujetas	1	double
2.7.1.5.1.6 ImporteUATP	1	double
2.7.1.5.2 Coste	1
2.7.1.5.2.1 ImporteComisionable	1
2.7.1.5.2.2 ImporteTasasExentas	1
2.7.1.5.2.3 ImporteTasasSujetas	1

Ejemplo request

Ejemplo response

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<DameReservaAgenciaResponse xmlns="http://tempuri.org/">
			<DameReservaAgenciaResult>
				<ReservaAgencia>
					<IdentificacionReserva>
						<Localizador>4101.41.2054</Localizador>
						<Estado>OK</Estado>
						<EstadoEnvio>Alta</EstadoEnvio>
						<FechaReserva>2019-01-02T00:00:00</FechaReserva>
						<CodigoAgencia>43010412797</CodigoAgencia>
					</IdentificacionReserva>
					<Cliente>
						<Nombre>Jose Manuel Millan</Nombre>
						<Email>jm@ejemplo1.es<Email></Email>
						<Telefono>953280144<Telefono></Telefono>
						<TipoDocumento>D</TipoDocumento>
						<Documento>77481526J<Documento></Documento>
					</Cliente>
					<Pasajeros>
						<Pasajero>
							<Nombre>Jose Manuel</Nombre>
							<Apellidos>Millan</Apellidos>
							<Email>jm@ejemplo1.es<Email></Email>
							<Telefono>953280144<Telefono></Telefono>
							<Movil>956253299<Movil></Movil>
							<TipoDocumento>D</TipoDocumento>
							<NumeroDocumento>77481526J</NumeroDocumento>
							<FechaCaducidadDocumento>0001-01-01T00:00:00</FechaCaducidadDocumento>
							<FechaNacimiento>1975-02-06T00:00:00</FechaNacimiento>
							<NivelEdadPax>A</NivelEdadPax>
							<CodigoPais>ESP</CodigoPais>
							<Pais>España</Pais>				
						</Pasajero>
						<Pasajero>
							<Nombre>Feliciana</Nombre>
							<Apellidos>Robledo</Apellidos>
							<Email></Email>
							<Telefono></Telefono>
							<Movil>758223655<Movil></Movil>
							<TipoDocumento>D</TipoDocumento>
							<NumeroDocumento></NumeroDocumento>
							<FechaCaducidadDocumento>0001-01-01T00:00:00</FechaCaducidadDocumento>
							<FechaNacimiento>1979-11-20T00:00:00</FechaNacimiento>
							<NivelEdadPax>A</NivelEdadPax>
							<CodigoPais></CodigoPais>
							<Pais>España</Pais>							
						</Pasajero>
					</Pasajeros>
					<Servicios>
						<ServicioReserva>
							<Tipo>P</Tipo>
							<Descripcion>Arabia al Completo - salida 16 marzo</Descripcion>
							<Regimen>SP</Regimen>
							<TotalPaxAdultos>2</TotalPaxAdultos>
							<TotalPaxNiñosYBebes>0</TotalPaxNiñosYBebes>
							<Prestatario>
								<Nombre>Mayorista de Viajes</Nombre>
								<Direccion></Direccion>
								<CodPostal></CodPostal>
								<Poblacion></Poblacion>
								<Provincia></Provincia>
								<Cif></Cif>
							</Prestatario>							
							<Localizador>041002054-190251</Localizador>
							<ConfirmadaPor></ConfirmadaPor>
							<FechaConfirmacion>2019-02-25T00:00:00</FechaConfirmacion>
							<FechaInicio>2019-03-16T00:00:00</FechaInicio>
							<FechaFin>2019-03-30T00:00:00</FechaFin>
							<DesgloseHabitaciones>
								<DesgloseHabitacion>
									<IdHabitacion>2</IdHabitacion>
									<Descripcion>Doble estandar</Descripcion>
									<Unidades>1</Unidades>
								</DesgloseHabitacion>
							</DesgloseHabitaciones>
							<ValoracionServicio>
								<Venta>
									<ExentoImpuesto>true</ExentoImpuesto>
									<ImporteComisionable>3090.24</ImporteComisionable>
									<ImporteNoComisionable>649.76</ImporteNoComisionable>
									<ImporteAjuste>0</ImporteAjuste>
									<ImporteUATP>0</ImporteUATP>
									<PagoDirecto>false</PagoDirecto>
								</Venta>
								<Coste>
									<ImporteComisionable>3090.24</ImporteComisionable>
									<ImporteNoComisionable>649.76</ImporteNoComisionable>
								</Coste>
							</ValoracionServicio>
							<DatosAdicionales>
								<DatosAdicionales>
									<Fecha>6/03 - 0/03</Fecha>
									<Regimen></Regimen>
									<Descripcion>Visado</Descripcion>
								</DatosAdicionales>
								<DatosAdicionales>
									<Fecha>30/03/2019</Fecha>
									<Regimen></Regimen>
									<Descripcion>Vuelos Vuelta</Descripcion>
								</DatosAdicionales>
								<DatosAdicionales>
									<Fecha>6/03 - 0/03</Fecha>
									<Regimen></Regimen>
									<Descripcion>Seguro de Cancelación y asistencia Plus De 0-2000 €</Descripcion>
								</DatosAdicionales>
								<DatosAdicionales>
									<Fecha>7/03 - 0/03</Fecha>
									<Regimen>MP</Regimen>
									<Descripcion>Arabia al Completo 13n PRIMERA</Descripcion>
								</DatosAdicionales>
								<DatosAdicionales>
									<Fecha>6/03 - 7/03</Fecha>
									<Regimen></Regimen>
									<Descripcion>Vuelos IDA</Descripcion>
								</DatosAdicionales>
							</DatosAdicionales>
						</ServicioReserva>
					</Servicios>
					<Valoracion>
						<TotalVenta>3740</TotalVenta>
						<TotalCoste>3740</TotalCoste>
						<TotalGastosGestion>0</TotalGastosGestion>
					</Valoracion>
					<Cobros>
						<Cobro>
							<CodFormaPago></CodFormaPago>
							<Descripcion></Descripcion>
							<Fecha>2019-05-06T00:00:00</Fecha>
							<Importe>174</Importe>
							<Concepto>Jose Manuel Millan</Concepto>
							<DocumentoCobro>041002058</DocumentoCobro>
						</Cobro>
					</Cobros>
				</ReservaAgencia>
			</DameReservaAgenciaPorDelegacionAgenciaResult>
		</DameReservaAgenciaPorDelegacionAgenciaResponse>
	</soap:Body>
</soap:Envelope>

*Tabla de Tipos de Servicios

Id	Descripción
Av	Avión
Ba	Barco
Bu	Autobús / Transfer
Ci	Paquetes / Circuitos
Ht	Hotel / Estancias
Ot	Otros
Rc	Alquiler de vehículos
Rt	Restaurante
Sg	Seguros
Tr	Tren

Reserva Capturada

En este apartado se describe la petición y la respuesta del método que indica que la reserva ha sido capturada.

Request

Campo	Cardinalidad	Tipo	Descripción
ValidarReserva	1		Elemento root de la petición.
1. Usuario	1	string	Usuario para login.
2. Contraseña	1	string	Contraseña para login
3. Localizador	1	string	Localizador que se indica que reserva la reserva que se está marcando como descargada.

Ejemplo request

Response

Campo	Cardinalidad	Tipo	Descripción
ValidarReservaResponse	1		Elemento root de la petición.
1. ValidarReservaResult	1	boolean	Indica si se ha marcado la reserva como ya descargada.