professional end-to-end management for

HOTEL CHAINS
holiday / urban / resorts

API OPERATIONS RESERVATIONS

SPECIFICATIONS

Review 2.2

Gremi Sabaters, 21
Edificio Naranja. Oficina B 35
Polígono de Son Castelló
07009 Palma de Mallorca

T. 871.93.2000
[email protected]
AVALON API OPERATIONS RESERVATIONS SPECIFICATIONS

NEWS

REVIEW 2.2

• Added new field in LSReservaCliente

o Parentesco

REVIEW 2.1

• New authentication system implemented.

REVIEW 2

• Added new field in LSReservaCliente

o Traveler part

REVIEW 1.9

• New field upgradeable in LSReservas structure:

o LSReservasCliente: PreCheckIn

REVIEW 1.8

• New reservation method

o PostReservationCheckOut

REVIEW 1.7

• Fix for search by room and hotel code.

• Missed field in LSReservas structure:
o LSReservaCliente: PreCheckIn (read-only field, can’t be modified on update methods)

REVIEW 1.6

• New reservation method

o GetAwaReservationAll
• Added new field in reservations response
o State

REVIEW 1.5

• Missed field in PostAWAReservationGuests and PostAWAReservationComments reponse:

Unspecified warning message
• Added mandatory fields for LSReservaCliente in PostAWAReservationGuests.

REVIEW 1.4

• Data type mistake in LSReservaCliente: fields Imagen and Firma must be base64string instead of byte[].
• Data type mistake in LSImageInfo: field Imagen must be base64string instead of byte[].
• Data type mistake in LSSignatureInfo: field Firma must be base64string instead of byte[].
• New method to get mandatory fields at pre-check in.

REVIEW 1.3

• New fields in LSReservas structure: Reserva and Linea

• New method to update customer image
• New method to update reservation comments

REVIEW 1.2
AVALON API OPERATIONS RESERVATIONS SPECIFICATIONS

• New ways to search reservations

REVIEW 1.1

• Date format of URL parameters

REVIEW 1.0

• Initial review
AVALON API OPERATIONS RESERVATIONS SPECIFICATIONS

CONTENT

AUTHENTICATION
X-API-KEY

RESERVATIONS
Reservations Pending to Check In or Checked In
Reservations Pending to Check In
Reservations Checked In
All reservations states
Reservations per room
Update reservation comments
Reservation Check Out

CLIENTS
Update customer data
Update information gathering agreement
Update customer image

AUTHENTICATION

A new authentication system has been implemented to access the Web API. This system is configurable by the client,
so you must contact your clients to determine which installations it is necessary to use authentication and which
installations it is not required.

To implement authentication in your system, you must include the following data in the requests you make:

x-api-key

Header
Key: x-api-key Value:250a825d89b14fdb9d54100ea55e0fad6c5f1e8bafaa47b4b1fadfc72816c5c1
Example
AVALON API OPERATIONS RESERVATIONS SPECIFICATIONS

RESERVATIONS

The following describes the methods to obtain hotel reservations data.

RESERVATIONS (PENDING TO CHECK IN OR CHECKED IN)

…/AWWebAPI/api/aw/awa/GetAWAReservation?Hotel=[...]&Localizador=[...] …

RESERVATIONS (PENDING TO CHECK IN)

…/AWWebAPI/api/aw/awa/GetAWAReservationPCI?Hotel=[...]&Localizador=[...] …

RESERVATIONS (ALL STATES)

…/AWWebAPI/api/aw/awa/GetAWAReservationAll?Hotel=[...]&Localizador=[...] …

RESERVATIONS (CHECKED IN)

…/AWWebAPI/api/aw/awa/GetAWAReservationCI?Hotel=[...]&Localizador=[...] …

Parameters that accept these four previous methods are the following:

Hotel Required
Localizador Locator
Bono Voucher
Apellido Surname
Email
FechaEntrada yyyy-mm-dd Check-In date
FechaSalida yyyy-mm-dd Check-Out date

In addition to the Hotel, it is necessary to indicate at least one more parameter in order to obtain the result.
In the locator we can indicate the itself locator, the number of reserve or the reserve with line on format RESERVE-LINE

RESERVATIONS PER ROOM

…/AWWebAPI/api/aw/awa/GetAWAReservationByRoom?Hotel=[...]&Habitacion=[...]

Parameters accepted by this method are the following (GET):

Hotel Required
Habitación Required Room

Previous methods always return response code 200(OK), whose content adjust to the following structure, taking into
account that if there has been any error it will be indicated in the Warning field:

LSReservas Lista (ReservaMasterAWA) Reservations

HotelFactura nvarchar(20) Invoicing Hotel
Reserva nvarchar(20) Reservation Code
Localizador nvarchar(50) Locator
EntidadNegocio nvarchar(20) Business Entity

LSReservaHabAWA Lista (ReservaHabAWA) Reservation rooms (lines)

Linea int Reservation Line Number
Referencia nvarchar(20) Reference
Habitacion nvarchar(20) Room
EstadoGOB nvarchar(20) Sate of the room according to Houskeeping
Estado int State : 0:Confirmed; 1:InHouse; 2:CheckOut; 3:NoShow;
4:Cancelled
AVALON API OPERATIONS RESERVATIONS SPECIFICATIONS
AD int Adults
JR int Juniors
NI int Children
CU int Baby Cribs
FechaEntrada datetime Check-In date
FechaSalida datetime Check-Out date
LlegadaVuelo nvarchar(20) Arrival flight
LlegadaDia datetime Arrival date
SalidaVuelo nvarchar(20) Departure flight
SalidaDia datetime Departure date
Comentarios nvarchar(2000) Remarks
Canal nvarchar(20) Channel code
Segmento nvarchar(20) Segment code
Tarifa nvarchar(20) Rate code
Oferta nvarchar(20) Offer code
THFactura nvarchar(20) Invoice room type code
THUso nvarchar(20) Room type code
RegimenFactura nvarchar(20) Invoice meal plan code
RegimenUso nvarchar(20) Meal plan code
AltaFecha datetime Registration date

LSReservaCliente Lista (ReservaCliente) Guests of the room

NumeroCliente int Guest number
TipoPersona byte 0:AD; 1:JR; 2:NI ;3:CU
FechaEntrada datetime Check-In date
FechaSalida datetime Check-Out date
Estado byte State 0:Reservation; 1:In-House; 2:Check-Out; 3:No Show;
4:Canceled
Nombre nvarchar(50) Name
Apellido1 nvarchar(50) Surname 1
Apellido2 nvarchar(50) Surname 2
Email nvarchar(100)
FechaNacimiento datetime Birthdate
PaisNacimiento nvarchar(20) Country of birth
TipoDocumento nvarchar(20) Document type
IDDocumento nvarchar(20) Document ID
FechaExpedicion datetime Date of issue
Edad int Age
IdiomaDocumentos int Documents language 0:Ninguno; 1:ca; 2:de; 3:en; 4:es;
5:esDO; 6:esMX; 7:fr; 8:it; 9:nl; 10:pt; 11:tr
FechaAltaFID datetime Membership discharge date
FechaBajaFID datetime Membership leaving date
Comentarios nvarchar(500) Remarks
TipoCliente nvarchar(20) Guest type
Sexo byte Sex 0:Male; 1:Female
AceptaInfo bool Keep informed
ParteViajeros int Traveler part
Imagen base64string Image
Firma base64string Signature
PreCheckIn bool Pre-Check In

DC Objeto (DatosComunicacion)
Descripcion nvarchar(50) Description
Direccion nvarchar(50) Address
CodigoPostal nvarchar(20) Postal code
Poblacion nvarchar(50) City
Provincia nvarchar(30) Province/County
ComunidadAutonoma nvarchar(20) Autonomous community
Pais nvarchar(20) Country
ApartadoCorreos nvarchar(20) Post office box
Telefono nvarchar(30) Telephone number
TelefonoMovil nvarchar(30) Mobile number
Fax nvarchar(30)
EMail nvarchar(100)

Warning nvarchar(MAX)

Note: If fields Locator or Reference don’t have a value will be use values of Reservation and Line respectively.
Note: When specified the room value, the hotel value will filter by hotel code.
AVALON API OPERATIONS RESERVATIONS SPECIFICATIONS

UPDATE RESERVATION COMMENTS

…/AWWebAPI/api/aw/awa/PostAWAReservationComments

The structure (ReservaMasterAWA) is the same as that of the previous section, but in this case, to identify the reservation
in Avalon it is only necessary to send the fields that are detailed below:

Hotel nvarchar(20)
LSReservas Lista (ReservaMasterAWA) Reservations
HotelFactura nvarchar(20) Invoicing Hotel
Reserva nvarchar(20) Reservation Code
Localizador nvarchar(50) Locator
EntidadNegocio nvarchar(20) Business Entity

LSReservaHabAWA Lista (ReservaHabAWA) Reservation rooms (lines)

Linea int Reservation Line Number
Referencia nvarchar(20) Reference
Comentarios nvarchar(2000) Comments
… Not necessary

LSReservaCliente Lista (ReservaCliente) Guests of the room

… Not necessary

Once the reservation is identified, the comments sent will be updated.

The hotel code indicated first is the reference hotel, to which must belong all the reservations included in the POST.

The reservation too can be search using the locator as reserve and reference as line.
Then we have 3 possibilities:
• Locator with reference
• Locator with line (putting on reference)
• Reserve (putting on locator) with line

This method always return response code 200(OK), whose content adjust to the following structure, taking into account
that if there has been any error it will be indicated in the Warning field:

Response
Warning nvarchar(MAX) Warning

CHECK OUT RESERVATION

…/AWWebAPI/api/aw/awa/PostAWAReservationCheckOut

To make the checkOut of a reservation you must send a JSON specifying the hotel, reservation and reservation line

Hotel nvarchar(20) Hotel

Reserva nvarchar(20) Reservation Code
LineaReserva int ReservationLine

Note: We apply the same logic that Avalon does in CO (The reservation must exist, the reservation must not have
pending invoices, etc...)
AVALON API OPERATIONS RESERVATIONS SPECIFICATIONS

CLIENTS

The following describes the methods to obtain customers data from hotel reservations. When dealing with POST method
the information is not sent through parameters in the URL, it must be introduced in the body of the request.

UPDATE CUSTOMER DATA

…/AWWebAPI/api/aw/awa/PostAWAReservationGuests

The structure (ReservaMasterAWA) is the same as that of the previous section, but in this case, to identify the reservation
in Avalon it is only necessary to send the fields that are detailed below:

Hotel nvarchar(20)
LSReservas Lista (ReservaMasterAWA) Reservations
HotelFactura nvarchar(20) Invoicing Hotel
Reserva nvarchar(20) Reservation Code
Localizador nvarchar(50) Locator
EntidadNegocio nvarchar(20) Business Entity

LSReservaHabAWA Lista (ReservaHabAWA) Reservation rooms (lines)

Linea int Reservation Line Number
Referencia nvarchar(20) Reference
… Not necessary

LSReservaCliente Lista (ReservaCliente) Guests of the room

NumeroCliente int Guest number
TipoPersona byte 0:AD; 1:JR; 2:NI ;3:CU
Edad int Age (if it already had value)
… Data to be updated, see the previous section

Once the reservation is identified, all the fields sent to the list LSReservaCliente will be updated.

The hotel code indicated first is the reference hotel, to which must belong all the reservations included in the POST.

The reservation too can be search using the locator as reserve and reference as line.
Then we have 3 possibilities:
• Locator with reference
• Locator with line (putting on reference)
• Reserve (putting on locator) with line

This method always return response code 200(OK), whose content adjust to the following structure, taking into account
that if there has been any error it will be indicated in the Warning field:

Response
Warning nvarchar(MAX) Warning

UPDATE INFORMATION GATHERING AGREEMENT

…/AWWebAPI/api/aw/awa/PostAWAGuestsAssent

Hotel nvarchar(20)
LSEMailInfo Lista (EMailInfo)
EMail nvarchar(100)
AceptaInformacion bool Keep informed

UPDATE CUSTOMER IMAGE

AVALON API OPERATIONS RESERVATIONS SPECIFICATIONS

…/AWWebAPI/api/aw/awa/PostAWAGuestImage

Hotel nvarchar(20)
LSImageInfo Lista (ImageInfo)
TipoDocumento nvarchar(20) Document type
NumeroDocumento nvarchar(20) Document number
Imagen base64string Image
AVALON API OPERATIONS RESERVATIONS SPECIFICATIONS

UPDATE CUSTOMER SIGNATURE

…/AWWebAPI/api/aw/awa/PostAWAGuestSignature

Hotel nvarchar(20)
LSSignatureInfo Lista (SignatureInfo)
TipoDocumento nvarchar(20) Document type
NumeroDocumento nvarchar(20) Document number
Firma base64string Signature

This update methods always return response code 200(OK), taking into account that if there has been any error it will
be indicated in the Warning field.

GET MANDATORY FIELDS PRE-CHECK IN

…/AWWebAPI/api/aw/awa/GetAWAMandatoryFieldsPCI?Hotel=[...]

In this case, the parameters accepted by this method are the following (GET):

Hotel nvarchar(20)

This method always return response code 200(OK), whose content adjust to the following structure, taking into account
that if there has been any error it will be indicated in the Warning field:

LSCamposObligatorios List (string) Mandatory Fields