Reserva Listar
Este mensaje devuelve la lista de reservas que cumplen los criterios de búsqueda especificados en el mensaje de petición.
ReservaListarPeticion
ReservaListarPeticion: mensaje de petición del estado de un conjunto de reservas a partir de una fecha.
Elemento | O | Tipo de datos | Restricciones | Descripción |
ideses | S | String | Longitud máxima: 40 | Identificador único de sesión |
codtou | S | String |
| Código de TTOO |
fecini | C | Date |
| Fecha inicio |
fecfin | C | Date |
| Fecha fin |
chkcan | C | Date | Ver definición | Indica las reserva canceladas |
chkcre | C | Check | Ver definición | Indica las reservas creadas |
chksal | C | Check | Ver definición | Indica una referencia a salida |
chkfac | C | Check | Ver definición | Indica si la acción es sobre elementos facturados |
chkmod | C | Check | Ver definición | Indica las reservas modificadas |
nombre | C | String | Longitud máxima: 50 | Nombre del pasajero |
priape | C | String | Longitud máxima: 100 | Primer apellido del pasajero |
segape | C | String | Longitud máxima: 100 | Segundo apellido del pasajero |
pasapt | C | String | Longitud máxima: 20 | Pasaporte o NIF de un pasajero |
refage | C | String | Longitud máxima: 100 | Referencia de la agencia |
codzge | C | String | Longitud máxima: 50 | Código de zona geográfica |
codser | C | String[] | Longitud máxima 10 | Código de servicio |
codtse | C | String | Longitud máxima: 5 | Código de tipo de servicio |
codemp | C | String | Longitud máxima: 10 | Código de empresa o grupo de agencias a las que pertenece el usuario |
codusu | C | String | Longitud máxima: 15 | Código de usuario |
cupest | C | Enumeration |
ND CE DS OP PC CM VL AN FA | Estado del cupo. ND: no disponible. CE: cerrado. DS: disponible. OP: opción. PC: en petición. CM: confirmado. VL: venta libre. AN: anulado. FA: facturado. |
traduc | C | Enumeration[] | codcas, codcha, codcia, coddiv, codemp, codloc, codnot, codral, codsca, codsmo, codsup, codtse, codusu, codzge, cupest, desele, grpcas, nomzge, refnot, subtse, tipdoc, tippag, zgeori | Campos a traducir en la respuesta. Para cada campo se puede indicar sólo el nombre, o el nombre más almohadilla (#). En caso de sólo poner el nombre traducirá la descripción; si también se pone la almohadilla traducirá además el código. |
numrst | C | Integer | Valor mínimo: 10 Valor máximo: 1.000 | Número de resultados que se desean en la respuesta. Si el número de resultados es mayor que este valor paginará |
locata | C | String[] | Longitud máxima: 30 | Localizador de la reserva |
indpag | C | Integer | Valor mínimo: 0 Valor máximo: 10.000 | Índice de la página |
Comentarios: hay una opción de elección entre tres partes: una agrupación de elementos que va de fecini a numrst,el elemento locata y el elemento indpag.Es decir, o hay el elemento locata, o hay el elemento indpag o hay el resto de elementos. Si no están ni locata, ni indpag, son obligatorios fecini y fecfin.Todos los demás son opcionales.
Paginación: para que la respuesta del listado nos realice paginación se lo debemos indicar en el valor del elemento numrst.Se indica un valor por el cual, si la respuesta tiene un número de resultados mayor, entonces hará páginas del número marcado en numrst. Por ejemplo: si informamos numrst con el valor de 20 y la respuesta nos da 44, entonces nos hará dos páginas de 20 y una de 4.
Ejemplo de mensaje de petición de listar reservas con el filtro de fechas. Nos debe devolver todas las reservas que se hayan realizado entre la fecha inicio y fecha fin indicados.
<ReservaListarPeticion>
<ideses>XML#17#442106373838493</ideses>
<codtou>HTT</codtou>
<fecini>22/06/2011</fecini>
<fecfin>26/06/2011</fecfin>
<numrst>20</numrst>
</ReservaListarPeticion>
ReservaListarRespuesta
ReservaListarRespuesta: mensaje de respuesta del estado de un conjunto de reservas a partir de una fecha.
Elemento | O | Tipo de datos | Restricciones | Descripción |
ideses | S | String | Longitud máxima: 40 | Identificador único de sesión |
codtou | S | String |
| Código de TTOO |
estres | N | Estres[] | Ver definición | Ver definición |
numpag | N | Integer | Valor mínimo: 0 Valor máximo: 1.000 | Número de página actual |
totpag | N | Integer | Valor mínimo: 0 Valor máximo: 10.000 | Número de páginas o si faltan páginas por cargar |
totrst | N | Integer | Valor mínimo: 0 Valor máximo: 1.000.000 | Total de resultados |
error | N | error (Grupo) | Ver definición | Ver definición |
Comentarios: los campos para realizar la paginación (numpag,totpag y totrst)forman parte de un grupo único. Los campos son opcionales, pero si hay uno están todos.
Paginación: si en la petición se ha informado el campo numrst (Ver explicación),entonces en la respuesta nos vendrán informados los tres campos antes indicados.
Siguiendo con el ejemplo de antes (44 resultados y numrst con valor 20) los valores de los campos de paginación de resultado serían para totrst 44; totpag 3 (en 3 páginas se verán todos los resultados) y numpag valdrá 1, 2 o 3 según la página donde nos encontremos.
Sub elemento Estres: estado de una reserva.
Elemento | O | Tipo de datos | Restricciones | Descripción |
locata | S | String | Longitud máxima: 30 | Localizador de la reserva |
refage | N | String | Longitud máxima: 100 | Referencia de la agencia |
cupest | S | Enumeration | ND CE DS OP PC CM VL AN FA | Estado del cupo. ND: no disponible. CE: cerrado. DS: disponible. OP: opción. PC: en petición. CM: confirmado. VL: venta libre. AN: anulado. FA: facturado. |
codemp | S | String | Longitud máxima: 10 | Código de empresa o grupo de agencias a las que pertenece el usuario |
codusu | S | String | Longitud máxima: 15 | Código de usuario |
feccre | S | DateTime |
| Fecha de creación |
fecini | S | DateTime |
| Fecha inicio |
fecfin | S | DateTime |
| Fecha fin |
fecmod | N | DateTime |
| Fecha de modificación |
feclim | N | DateTime |
| Fecha límite de reserva |
desbre | N | String | Longitud máxima: 4.000 | Descripción breve del producto |
coddiv | S | Enumeration | EUR, USD, GBP, EGP, MXN, CHF | Código de divisa. Se utilizan los códigos ISO 4217 para las divisas de las que, actualmente, sólo se aceptan las enumeradas. |
cambio | N | Double | Valor mínimo: 0 Valor máximo: 1.000.000 | Cambio con el que se calcula el precio |
impnoc | S | Double | Valor mínimo: 0 Valor máximo: 100.000 | Importe de no comisionable |
impcom | S | Double | Valor mínimo: 0 Valor máximo: 100.000 | Importe comisionable |
percon | S | Percon | Ver definición | Ver definición |
respas | S | Respas[] | Ver definición | Ver definición |
Utilizado en:
ReservaListarRespuesta
Mensaje de respuesta de listar reservas:
<ReservaListarRespuesta>
<ideses>XML#17#442106373838493</ideses>
<codtou>HTT</codtou>
<estres>
<locata>123456</locata>
<cupest>CM</cupest>
<codemp>HTT</codemp>
<codusu>91</codusu>
<feccre>02/06/2011</feccre>
<fecini>22/06/2011</fecini>
<impnoc>0</impnoc>
<impcom>22,06</impcom>
<percon>
<nombre>Teodoro</nombre>
<priape>Villar</priape>
<tel>915015471</tel>
</percon>
<respasid="1">
<fecnac>05/01/1981</fecnac>
</respas>
<respasid="2">
<fecnac>05/01/1981</fecnac>
</respas>
<respasid="3">
<fecnac>05/01/1981</fecnac>
</respas>
<respasid="4">
<fecnac>05/01/1981</fecnac>
</respas>
<respasid="5">
<fecnac>05/01/1981</fecnac>
</respas>
</estres>
</ReservaListarRespuesta>