KIU_GetTravelerAPIInfo
Objetivo
El método permite solicitar los datos de API (Advanced Passenger Information) en caso que el destino requiera esta condición. Los datos deben completarse durante el proceso de aceptación del pasajero. La respuesta devuelve un XHTML a partir del cual se puede construir un formulario con los parámetros de cada dato que se requiere.
KIU_GetTravelerAPIInfoRQ
Ejemplo del Mensaje KIU_GetTravelerApiInfoRQ
KIU_GetTravelerAPIInfoRQ
<?xml version="1.0" encoding="UTF-8"?>
<KIU_GetTravelerAPIInfoRQ EchoToken="1" TimeStamp="2012-04-20T15:45:07-03:00" Target="Production" Version="3.0" SequenceNmbr="1" PrimaryLangID="en-us">
<!-- POS/Source: Mandatorio en todos sus componentes -->
<POS>
<Source AgentSine="AEP00XXSM" TerminalID="AEP00XX816" ISOCountry="AR" />
</POS>
<!-- Mandatorio -->
<FlightInfo FlightRPH="1">
<CarrierInfo>
<!-- Mandatorio -->
<OperatingAirline>
<CarrierCodeID>XX</CarrierCodeID>
<CarrierShortName>LINEAS AEREAS XX</CarrierShortName>
<FlightNumber>9030</FlightNumber>
</OperatingAirline>
</CarrierInfo>
<!-- Departure information: Mandatorio -->
<DepartureInformation>
<!-- BoardingPoint: Mandatorio -->
<BoardingPoint>EZE</BoardingPoint>
<!-- DepartureDate: Opcional -->
<DepartureDate>2017-01-03</DepartureDate>
</DepartureInformation>
<!-- ArrivalInformation: Opcional -->
<ArrivalInformation>
<BoardingOff>MIA</BoardingOff>
</ArrivalInformation>
</FlightInfo>
<PassengerFlightInfo>
<AirTravelerInfo>
<!-- PassengerInfo: Mandatorio / RPH: Mandatorio --->
<PassengerInfo PsgrRPH="001">
<!-- PsgrPRH debe ser el valor UPID que es el psgrRPH que proviene de la respuesta de KIU_AirTravellerCheckInRS -->
<!-- PassengerName: Mandatorio -->
<PassengerName>
<!-- GivenName: Mandatorio -->
<GivenName>MICHELE</GivenName>
<!-- Surname: Mandatorio -->
<Surname>ABATE</Surname>
</PassengerName>
</PassengerInfo>
</AirTravelerInfo>
</PassengerFlightInfo>
<BookingInformation>
<BookingReferenceID>
<!-- Mandatorio -->
<ID>CGWGGL</ID>
<!-- Mandatorio -->
</BookingReferenceID>
</BookingInformation>
</KIU_GetTravelerAPIInfoRQ>
Elementos del Mensaje KIU_GetTravelerAPIInfoRQ
- POS: Elemento que agrupa la información del Punto de Venta desde el cual se realiza la petición.
- Source: Contenedor de los datos del Punto de Venta o POS.
- AgentSine: Alfanumérico [9]. Identificador del agente que realiza la petición.
- TerminalID: Alfanumérico [10]. Código identificador del dispositivo desde el que se realiza la petición.
- ISOCountry: Alfabético [2]. Código ISO del país desde donde se realiza la petición.
- Source: Contenedor de los datos del Punto de Venta o POS.
- FlightInfo: Mandatorio. Repetitivo. Elemento complejo que agrupa la información del vuelo sobre el cual se deben agregar datos de API.
- CarrierInfo: Mandatorio. Elemento que agrupa la informacion singular de vuelo.
- CarrierCodeID: Alfanumérico [2]. Código ISO de línea aérea.
- CarrierShortName: Alfanumérico [30]. Nombre Marketing de la línea aérea.
- FligthNumber: Entero [4]. Número de vuelo.
- DepartureInformation: Mandatorio. Elemento que agrupa la información de partida del vuelo.
- BoardingPoint: Alfabético [3]. Código ISO del aeropuerto de salida.
- DepartureDate: Opcional. Fecha de partida del vuelo.
- ArrivalInformation: Opcional. Elemento que agrupa la información de arribo del vuelo.
- BoardingOff: Alfabético [3]. Código ISO del aeropuerto de arribo.
- CarrierInfo: Mandatorio. Elemento que agrupa la informacion singular de vuelo.
- PassengerFlightInfo: Mandatorio. Elemento complejo que agrupa la información puntual del pasajero.
- AirTravelerInfo: Mandatorio. Información de pasajero que requiere API.
- PassengerInfo: Mandatorio. Elemento que agrupa la información puntual del pasajero que requiere API.
- PsgrRPH: Entero [4]. Mandatorio. Número de referencia único del pasajero generado por el sistema KIU y que proviene de la respuesta de KIU_AirTravellerCheckinRS.
- PassengerName: Mandatorio. Elemento que agrupa la información de identidad y nombres del pasajero.
- GivenName: Mandatorio. Primer nombre del pasajero.
- Surname: Mandatorio. Apellido del pasajero.
- PassengerInfo: Mandatorio. Elemento que agrupa la información puntual del pasajero que requiere API.
- AirTravelerInfo: Mandatorio. Información de pasajero que requiere API.
- BookingInformation: Mandatorio. Elemento que agrupa la información de la reserva que contiene al pasajero.
- BookingReferenceID: Elemento que se refiere al código de reserva generado por el sistema KIU.
- ID: Mandatorio. Alfabético [6]. Código de reserva.
- BookingReferenceID: Elemento que se refiere al código de reserva generado por el sistema KIU.
KIU_GetTravelerAPIInfoRS
Ejemplo del Mensaje KIU_GetTravelerAPIInfoRS
KIU_GetTravelerAPIInfoRS
<?xml version="1.0" encoding="UTF-8"?>
<KIU_GetTravelerAPIInfoRS EchoToken="1" TimeStamp="2016-12-06T20:27:54+00:00" Target="Production" Version="3.0" SequenceNmbr="1">
<Success />
<BookingInformation>
<BookingReferenceID>
<ID />
</BookingReferenceID>
</BookingInformation>
<APIInformation>
<APIFormMask>
<BirthDate>
<extra />
<length>7</length>
<status>-</status>
<value>DDMMMYY</value>
</BirthDate>
<BirthPlace>
<extra />
<length>3</length>
<status>-</status>
<value></value>
</BirthPlace>
<CityAddress>
<length>35</length>
<status>-</status>
<value></value>
</CityAddress>
<CityDoc>
<length>35</length>
<status>-</status>
<value></value>
</CityDoc>
<Command>
<length>2</length>
<status>-</status>
<value></value>
</Command>
<CountryAddress>
<length>3</length>
<status>-</status>
<value></value>
</CountryAddress>
<CountryDoc>
<length>3</length>
<status>-</status>
<value></value>
</CountryDoc>
<CountryOfRes>
<extra />
<length>3</length>
<status>-</status>
<value></value>
</CountryOfRes>
<DestAddress>
<length>35</length>
<status>-</status>
<value></value>
</DestAddress>
<DestCity>
<length>35</length>
<status>-</status>
<value></value>
</DestCity>
<DestCountryAddress>
<length>3</length>
<status>-</status>
<value></value>
</DestCountryAddress>
<DestStateAddress>
<length>35</length>
<status>-</status>
<value></value>
</DestStateAddress>
<DestZipAddress>
<length>17</length>
<status>-</status>
<value></value>
</DestZipAddress>
<EmergContName>
<length>21</length>
<status>-</status>
<value></value>
</EmergContName>
<EmergContTel>
<length>16</length>
<status>-</status>
<value></value>
</EmergContTel>
<ExpDate>
<extra />
<length>7</length>
<status>-</status>
<value>DDMMMYY</value>
</ExpDate>
<FirstName>
<extra />
<length>35</length>
<status>-</status>
<value>MICHELE </value>
</FirstName>
<Gender>
<extra />
<length>2</length>
<multivalues>
<item0>
<code>00</code>
<text>M</text>
</item0>
<item1>
<code>01</code>
<text>F</text>
</item1>
<item2>
<code>02</code>
<text>U</text>
</item2>
</multivalues>
<status>-</status>
<value>00</value>
</Gender>
<IssueDate>
<length>7</length>
<status>-</status>
<value>DDMMMYY</value>
</IssueDate>
<Nationality>
<extra />
<length>3</length>
<status>-</status>
<value></value>
</Nationality>
<NumDoc>
<extra />
<length>35</length>
<status>-</status>
<value></value>
</NumDoc>
<Others>
<length>2</length>
<status>-</status>
<value></value>
</Others>
<OthersCity>
<length>35</length>
<status>-</status>
<value></value>
</OthersCity>
<OthersCountry>
<length>3</length>
<status>-</status>
<value></value>
</OthersCountry>
<OthersExpDate>
<length>7</length>
<status>-</status>
<value>DDMMMYY</value>
</OthersExpDate>
<OthersIssueDate>
<length>7</length>
<status>-</status>
<value>-</value>
</OthersIssueDate>
<OthersNum>
<length>35</length>
<status>-</status>
<value></value>
</OthersNum>
<PrimResAddress>
<length>35</length>
<status>-</status>
<value></value>
</PrimResAddress>
<SecondName>
<extra />
<length>35</length>
<status>-</status>
<value></value>
</SecondName>
<StateAddress>
<length>35</length>
<status>-</status>
<value></value>
</StateAddress>
<SurName>
<extra />
<length>70</length>
<status>-</status>
<value>ABATE </value>
</SurName>
<TypeDoc>
<extra />
<length>2</length>
<multivalues>
<item0>
<code>00</code>
<text>P</text>
</item0>
<item1>
<code>01</code>
<text>V</text>
</item1>
<item2>
<code>02</code>
<text>A</text>
</item2>
<item3>
<code>03</code>
<text>C</text>
</item3>
<item4>
<code>04</code>
<text>I</text>
</item4>
<item5>
<code>05</code>
<text>AC</text>
</item5>
<item6>
<code>06</code>
<text>IP</text>
</item6>
<item7>
<code>07</code>
<text>M</text>
</item7>
</multivalues>
<status>-</status>
<value>00</value>
</TypeDoc>
<VisaCity>
<length>35</length>
<status>-</status>
<value></value>
</VisaCity>
<VisaCountry>
<length>3</length>
<status>-</status>
<value></value>
</VisaCountry>
<VisaExpDate>
<length>7</length>
<status>-</status>
<value>DDMMMYY</value>
</VisaExpDate>
<VisaIssueDate>
<length>7</length>
<status>-</status>
<value>DDMMMYY</value>
</VisaIssueDate>
<VisaNum>
<length>35</length>
<status>-</status>
<value></value>
</VisaNum>
<ZipAddress>
<length>17</length>
<status>-</status>
<value></value>
</ZipAddress>
</APIFormMask>
<Comando>
<extra />
<value>@_PA</value>
</Comando>
<Errors>
<extra />
<value />
</Errors>
<FormMode>
<extra />
<value>P</value>
</FormMode>
<FormType>
<extra />
<value>C</value>
</FormType>
<Header>
<extra />
<value>XX 099620161207EZEMIA O6A99902200320071 END</value>
</Header>
<RecLoc>
<extra />
<value>CGWGGL</value>
</RecLoc>
<SecuenciaPax>
<extra />
<value>001</value>
</SecuenciaPax>
<Title>
<extra />
<value>Advanced Passenger Information. MASK / C-P</value>
</Title>
<TypePax>
<extra />
<value>PAX: CGWGGL 1</value>
</TypePax>
<Version_pax>
<extra />
<value>001</value>
</Version_pax>
<arrobas>
<extra />
<value>099</value>
</arrobas>
</APIInformation>
</KIU_GetTravelerAPIInfoRS>
Elementos del mensaje KIU_GetTravelerAPIInfoRS
La respuesta se compone de los campos que se requieren para construir el formulario de API. Estos campos son dinámicos dependiendo de la API y pueden variar del presente ejemplo.
- Success: Elemento que anuncia el estado de la respuesta desde la API. En caso de error, se devuelve el nodo "error".
- BookingInformation: Elemento que agrupa la información de la reserva que contiene al pasajero.
- ID: Código de la reserva.
- APIInformation: Elemento que agrupa toda la información de API requerida.
- APIFormMask: Elemento que agrupa la información para construir la mascara de API. Enumera cada campo donde se requiere información. La lógica es tipo XHTML.
- BirthDate: Este elemento contiene el nombre del campo a desplegar.
- Extra: Elemento alfanumérico. Este campo esta contemplado para futuras implementaciones.
- length: Numérico. Extensión máxima permitida.
- Status: Estado del campo. Si el mismo tiene información y cumple la condición o la informacion ingresada contiene un error, el cuál se indica con X.
- BirthDate: Este elemento contiene el nombre del campo a desplegar.
- APIFormMask: Elemento que agrupa la información para construir la mascara de API. Enumera cada campo donde se requiere información. La lógica es tipo XHTML.
Existen otros elementos relacionados tomando en consideración el tipo de campo a construir o bien si el mismo tiene contenido pre-configurado o pre-populado.
- Value: Contiene un valor a desplegar en el campo. Este puede venir pre-populado del sistema o pre-cargado desde la reserva.
- Multivalues: Este elemento se usa para enumerar las opciones dentro de una lista desplegable (DropDown)
- Item: El elemento contiene la descripción de los valores a ofrecer como opciones de selección, el mismo tiene una lógica numérica creciente. Es un elemento repetitivo al que se le asigna un número de orden tipo lista.
- Code: Código del objeto a desplegar.
- Text: Texto a desplegar asociado al código. Ejemplo (PP; Pasaporte)
- Status: El elemento toma valor en la respuesta de KIU_TravellerApiInfoRS. Indica si el campo contiene un error con X.
- Item: El elemento contiene la descripción de los valores a ofrecer como opciones de selección, el mismo tiene una lógica numérica creciente. Es un elemento repetitivo al que se le asigna un número de orden tipo lista.
- Comando: Elemento de uso interno de la API, NO DEBE SER MODIFICADO.
- Extra: Este campo esta contemplado para futuras implementaciones.
- Value: Valor que no debe ser modificado en el request de KIU_TravellerApiInfoRQ.
- Errors: Elemento que agrupa y describe error de campo. Toma valor en KIU_TravellerApiInfoRS.
- Extra: Este campo esta contemplado para futuras implementaciones.
- Value: Descripción de error.
- FormMode: Elemento determina el modo de formulario.
- Extra: Este campo esta contemplado para futuras implementaciones.
- Value: Tipo de mascara de acuerdo al tipo de API que se procese. Valores (P: Pasajero; C: Crew)
- FormType: Elemento que determina el tipo de formulario a presentar.
- Extra: Este campo esta contemplado para futuras implementaciones.
- Value: Valor que determina el tipo de mascara: (B: Basic, C: Completa).
- Header: Elemento que informa el encabezado a desplegar en la mascara.
- Extra: Este campo esta contemplado para futuras implementaciones.
- Value: Valor que proviene del sistema de Check-in de KIU Res. NO SE DEBE MODIFICAR.
- RecLoc: Elemento que contiene información de código de reserva donde se encuentran los pasajeros.
- Extra: Este campo esta contemplado para futuras implementaciones.
- Value: Alfanumérico [6]. Código de reserva.
- SecuenciaPax: Número de orden del pasajero.
- Extra: Este campo esta contemplado para futuras implementaciones.
- Value: Numérico [4]. Contiene el número de secuencia del pasajero. Es un ID asignado por el sistema de Check-in de KIU Res.
- Title: Elemento que contienen el título de la mascara. Proviene del sistema de Check-in de KIU Res.
- Extra: Este campo esta contemplado para futuras implementaciones.
- Value: Alfanumérico [30]. Contiene el título de la mascara.
- TypePax: Elemento que agrupa informacion de la reserva del pasajero.
- Extra: Este campo esta contemplado para futuras implementaciones.
- Value: Alfanumérico. Información de cantidad de pasajeros y código de reserva donde se encuentran.
- Version_pax: Elemento que informa ID de identificación del pasajero para el proceso de Check-in.
- Extra: Este campo esta contemplado para futuras implementaciones.
- Value: Numérico. Entero. Número de ID del pasajero asignado por el sistema.
- Arrobas: Elemento de uso interno.
- Extra: Este campo esta contemplado para futuras implementaciones.
- Value: Información de uso interno para el sistema de Check-in (no modificar)