V2.0. RMS Manual do Sistema

Transcrição

1 RMS Manual do Sistema V2.0 RMS Manual do Sistema

2 Histórico de Revisões Data da Revisão Versão Descrição Autor 25/04/2017 V1.0 Criação do documento Wesley Barcelos 25/04/2017 V1.0 Criação do documento Vinicius Teixeira 05/05/2017 V1.1 Inclusão dos Métodos de reserve Vinicius Teixeira 19/05/2017 V2.0 Alterações na estrutura do documento Rennan Alecrim RMS Manual do Sistema 2

3 Índice Sumário Visão Geral... 4 Autenticação... 4 Idioma... 4 Compressão... 5 Envio Parcial... 5 Métodos... 5 GroupLock... 5 Overbookings... 9 SendBooking...11 Get Booking For Download...17 Get Booking by Hotel...17 Confirm Booking Receive...19 Set Booking To Resend...20 RMS Manual do Sistema 3

4 Visão Geral Caro Parceiro, Este documento visa esclarecer todos os procedimentos de como consumir via REST os recursos da HIGS RMS API através de métodos HTTP. Todos os métodos HTTP que disponibilizam os recursos necessários para a integração são detalhados a seguir. Lembre-se de que, a menos que explicitamente mencionado, os métodos são utilizados por ambos os hotéis e parceiros para enviar e consumir informações para HIGS. Os hotéis usam os métodos de envio para enviar as informações e os parceiros receberão um JSON em seus serviços da Web que precisam ser construídos em seus lados para suportar esta atualização automática. Finalmente, ambos os hotéis e parceiros podem usar o método GET para consultar o estado atual dos dados no HIGS. Autenticação Para ter acesso a HIGS API, é necessário possuir um Token Client e Token Application desbloqueados, que são recebidos após a contratação do nosso serviço. Os dois parâmetros devem ser inseridos no Header com os seus respectivos valores Em todas as requisições a utilização dos tokens é obrigatória. Exemplo: Headers token-client: 54f11ad4ae0d17744fa33d99 token-application: 19A322AF-BF7C A9-DF5BA91963F7 Content-Type: application/json; Idioma O idioma de retorno das mensagens do sistema pode ser escolhido através do parâmetro Accept-Language que deve ser inserido no header. Idiomas disponíveis: en-us e pt-br. Obs: Com a ausência do parâmetro Accept-Language, o idioma retornado será pt-br. Exemplo: Headers token-client: 54f11ad4ae0d17744fa33d99 token-application: 19A322AF-BF7C A9-DF5BA91963F7 Content-Type: application/json; RMS Manual do Sistema 4

5 charset=utf-8 Accept-Language: en-us Compressão Todas as requisições deverão ser enviadas de forma compactada no formato Gzip. Para isto, deverá ser colocada no header a Tag Accept-Encoding para realizar a compressão: Headers token-client: 54f11ad4ae0d17744fa33d99 token-application: 19A322AF-BF7C A9-DF5BA91963F7 Content-Type: application/json; charset=utf-8 Accept-Language: en-us Accept-Encoding: gzip,deflate Envio Parcial Todos os métodos podem ter seu processamento total ou parcial. Isto quer dizer que um bloco identificado pelo LocatorID, não interfere em outro. Métodos GroupLock O método POST permite que um hotel envie seus fechamentos de disponibilidade em bloco, o parceiro receberá solicitação na estrutura JSON com o fechamentos de disponibilidade atualizados. O código do hotel deve ser passado na URL. Request URL Exemplo de requisição: "InvBlocks" : [ "LocatorID" : "1234", "AbsoluteCutoff" : " ", "Start" : " ", "End" : " ", "RoomTypes" : [ "RoomTypeCode" : "ABC", "RoomTypeAllocations" : [ "RoomTypePickUpStatus" : 1, "Start" : " ", "End" : " ", "NumberOfUnits" : 10 Body RMS Manual do Sistema 5

6 , "RatePlans" : [ "RatePlanCode" : "ABC", "CurrencyCode" : "USD", "Start" : " ", "End" : " ", "PromotionCode" : "ABC", "BaseByGuestAmts" : [ "AgeQualifyingCode" : 10, "AmountBeforeTax" : 10.00, "NumberOfGuests" : 2 "LocatorID" : "2222", "AbsoluteCutoff" : " ", "Start" : " ", "End" : " ", "RoomTypes" : [ "RoomTypeCode" : "ABC", "RoomTypeAllocations" : [ "RoomTypePickUpStatus" : 1, "Start" : " ", "End" : " ", "NumberOfUnits" : 10, "RatePlans" : [ "RatePlanCode" : "ABC", "CurrencyCode" : "USD", "Start" : " ", "End" : " ", "PromotionCode" : "ABC", "BaseByGuestAmts" : [ "AgeQualifyingCode" : 10, "AmountBeforeTax" : 10.00, "NumberOfGuests" : 2 Retorno Sucesso Código HTTP: 200 "Message : Processed Exemplo de Erro Parcial Código HTTP: 206 "Message": "Partially Processed", "Warnings": [ "Code": 9999, "Message": "Invalid field StatusApplicationControl", "LocatorID": "ABCD456" RMS Manual do Sistema 6

7 Exemplo de Erro Código HTTP: 400 "Message": "Not Processed", Erros do Método Código Interno 15 Data Inválida 145 Período ou datas incorretas 1027 O campo "CurrencyCode" é inválido 1028 O campo "CurrencyCode" é obrigatório 1058 O campo RatePlanCode é obrigatório 1060 O campo RoomTypeCode é obrigatório 1111 O campo LocatorId é obrigatório 1117 O campo Start é obrigatório 1118 O campo End é obrigatório 1130 O campo LocatorId é obrigatório 1181 O campo RoomTypePickUpStatus é inválido 1182 Campo InvBlocks é obrigatório 1182 O campo NumberOfUnits é obrigatório 1183 O campo AgeQualifyingCode é obrigatório 1184 O campo AmountBeforeTax é obrigatório 1185 O campo NumberOfGuests é obrigatório 1186 O campo PromotionCode é obrigatório 1187 O campo BaseByGuestAmts é obrigatório 1188 O campo RoomTypeAllocations é obrigatório 1189 O campo RatePlans é obrigatório 1190 Campo AbsoluteCutoff é obrigatório 1191 O campo End é obrigatório Mensagem de Erro Parâmetros HotelCode Parâmetro Descrição Tipo Obrigatório Código do Hotel. Integer Exemplo: Parâmetro Atributos Atributos Descrição Tipo Obrigat ório InvBlocks Lista de bilhetes para String atualização. LocatorId Identificador do item no bilhete. Numeração gerada pelo requisitante. Integer AbsoluteCutoff xxxxx yyyy-mm-dd RMS Manual do Sistema 7

8 Start Data inicial do período yyyy-mm-dd End Data final do período yyyy-mm-dd RoomTypes Lista de códigos de Array(string) acomodação correlacionados para o canal. Exemplo: "200601" RoomTypeCode Código identificador do Roomtype do integrador. String(64) É necessário que o hotel realize previamente o correlacionamento de Roomtypes no HIGS. Exemplo: "RoomTypeCode": RoomTypeAllocations Tipo de Quarto RoomTypePickUpStatus Status do Quarto Start Data inicial do período yyyy-mm-dd End Data final do período yyyy-mm-dd NumberOfUnits Número de Unidades RatePlans Plano Tarifário RatePlanCode Código identificador do Rate Plan. String(64) Exemplo: "RatePlanCode": CurrencyCode Código da moeda utilizada na reserva. Código padrão ISO String(03) Exemplo: "CurrencyCode": "BRL" Start Data inicial do período yyyy-mm-dd End Data final do período yyyy-mm-dd PromotionCode Código de Promoção hóspedes BaseByGuestAmts Valor por número de Object AgeQualifyingCode Código identificador do tipo Integer de acompanhante. 10 Adulto; 8 Criança; 6 Criança até 2 anos AmountBeforeTax Valor total da reserva sem taxas e impostos. Exemplo: "TotalAmountBeforeTax": Number(16,2) NumberOfGuests Número de hóspedes Integer RMS Manual do Sistema 8

9 Overbookings Método POST para atualizar as configurações de Overbooking. Pode ser utilizado por hotéis e parceiros. O código do hotel deve ser passado na URL. Request URL Exemplo de requisição: "Overbookings": [ "LocatorId": "123", "Start": "2020/10/21", "End": "2020/10/22", "Sun": 0, "Mon": 1, "Tue": 0, "Wed": 1, "Thu": 1, "Fri": 1, "Sat": 1, "HotelBookingLimit": 10, "UHs": [ "BookingLimit": 10, "InvTypeCode": "AB1010" "LocatorId": "1234", "Start": "2020/10/20", "End": "2020/10/24", "Sun": 0, "Mon": 0, "Tue": 0, "Wed": 1, "Thu": 1, "Fri": 1, "Sat": 1, "HotelBookingLimit": 10, "UHs": [ "BookingLimit": 10, "InvTypeCode": "AB1010" Body Retorno Sucesso Código HTTP: 200 "Message : Processed Exemplo de Erro Parcial RMS Manual do Sistema 9

10 Código HTTP: 206 "Message": "Partially Processed", "Warnings": [ "Code": 145, "Message": "Duration period or dates incorrect", "LocatorID": "ABCD123" Exemplo de Erro Código HTTP: 400 "Message": "Not Processed", Erros do Método Código Interno Mensagem de Erro 15 Data Inválida 145 Período ou datas incorretas 1117 O campo Start é obrigatório 1118 O campo End é obrigatório 1127 O campo InvTypeCode é obrigatório 1130 O campo LocatorId é obrigatório 1131 O campo Mon é obrigatório 1133 O campo Tue é obrigatório 1134 O campo Wed é obrigatório 1135 O campo Thu é obrigatório 1136 O campo Fri é obrigatório 1137 O campo Sat é obrigatório 1138 O campo Sun é obrigatório 1142 O campo Mon é inválido 1143 O campo Tue é inválido 1144 O campo Wed é inválido 1145 O campo Thu é inválido 1146 O campo Fri é inválido 1147 O campo Sat é inválido 1148 O campo Sun é inválido 1162 O campo BookingLimit é obrigatório 1163 Invalid BookingLimit 1180 O campo HotelBookingLimit é obrigatório 1192 Overbooking obrigatório 1193 O campo Uhs é obrigatório RMS Manual do Sistema 10

11 Parâmetros Parâmetro Descrição Tipo Obrigatório HotelCode Código do Hotel. Integer Exemplo: Parâmetro Atributos Descrição Tipo Obrigatório Overbookings Lista de bilhetes para atualização. String LocatorId Identificador do item no bilhete. Numeração gerada pelo requisitante. Integer Start Data inicial do período yyyy-mm-dd End Data final do período yyyy-mm-dd Sun Se marcado com 1, habilita apenas o dia da semana Integer dia da semana Mon Se marcado com 1, habilita apenas o Integer dia da semana Tue Se marcado com 1, habilita apenas o Integer dia da semana Wed Se marcado com 1, habilita apenas o Integer dia da semana Thu Se marcado com 1, habilita apenas o Integer dia da semana Fri Se marcado com 1, habilita apenas o Integer Sat Se marcado com 1, habilita apenas o Integer dia da semana HotelBookingLimit Quantidade de UH disponível Integer UHs Lista de Uhs String BookingLimit Quantidade disponível da acomodação Integer no período informado para o contrato. InvTypeCode Código da acomodação String SendBooking Método POST de envio de reservas para o HIGS. Estas reservas são feitas no padrão RMS. Eles serão utilizados pelo parceiro RMS para análise. Este é um método exclusivo para hotéis. Request URL Exemplo de requisição: RMS Manual do Sistema 11

12 Body "BookingList":[ "LocatorId": "21ABV", "HotelCode":2225, "IsWalkin" : true, "MealplanCode" : 1, "Status": 2, "ReservationNumberHIGS": "922111", "ReservationNumberHOTEL": "E22w2Sv21", "Checkin": " ", "Checkout": " ", "ConfirmedCheckin": " ", "ConfirmedCheckout": " ", "Guests": "Adults": 2, "Children": 1, "GuestOriginCountryCode": "BR", "GuestOriginStateCode": "RJ", "GuestOriginCityName": "Rio de Janeiro" "CreationDate": " ", "LastUpdateDate": " ", "NumberOfRooms": 1, "OriginalPMSRoomType": "STD", "CurrentPMSRoomType": "LX", "PMSRateCode": "2", "PMSBlockCode": "SS", "AllotmentCode": "AA", "ReservationSourceCode": "SDSSS", "ReservationMarketCode": "SSSSS", "ReservationSubMarketCode": "GHGH", "RewardProgramType": "FG", "LoyaltyID": 23, "Rates": [ "Amount": 80, "EffectiveDate": " T00:00: " "Amount": 85, "EffectiveDate": " T00:00: " "Amount": 90, "EffectiveDate": " T00:00: " "Amount": 95, "EffectiveDate": " T00:00: " "Amount": 100, "EffectiveDate": " T00:00: ", "CurrencyCode": "BRL" RMS Manual do Sistema 12

13 Retorno Sucesso Código HTTP: 200 "Message : Processed Exemplo de uma requisição com 2 reservas: Body "BookingList":[ "LocatorId": "21ABV", "HotelCode":2225, "IsWalkin" : true, "MealplanCode" : 1, "Status": 2, "ReservationNumberHIGS": "922111", "ReservationNumberHOTEL": "E22w2Sv21", "Checkin": " ", "Checkout": " ", "ConfirmedCheckin": " ", "ConfirmedCheckout": " ", "Guests": "Adults": 2, "Children": 1, "GuestOriginCountryCode": "BR", "GuestOriginStateCode": "RJ", "GuestOriginCityName": "Rio de Janeiro" "CreationDate": " ", "LastUpdateDate": " ", "NumberOfRooms": 1, "OriginalPMSRoomType": "STD", "CurrentPMSRoomType": "LX", "PMSRateCode": "2", "PMSBlockCode": "SS", "AllotmentCode": "AA", "ReservationSourceCode": "SDSSS", "ReservationMarketCode": "SSSSS", "ReservationSubMarketCode": "GHGH", "RewardProgramType": "FG", "LoyaltyID": 23, "Rates": [ "Amount": 80, "EffectiveDate": " T00:00: " "Amount": 85, "EffectiveDate": " T00:00: " "Amount": 90, "EffectiveDate": " T00:00: " "Amount": 95, "EffectiveDate": " T00:00: " "Amount": 100, "EffectiveDate": " T00:00: " RMS Manual do Sistema 13

14 , "CurrencyCode": "BRL", "LocatorId": "21dsABV", "IsWalkin" : true, "MealplanCode" : 1, "Status": 2, "ReservationNumberHIGS": "922111", "ReservationNumberHOTEL": "E22w2Sv21", "Checkin": " ", "Checkout": " ", "ConfirmedCheckin": " ", "ConfirmedCheckout": " ", "Guests": "Adults": 2, "Children": 1, "GuestOriginCountryCode": "BR", "GuestOriginStateCode": "RJ", "GuestOriginCityName": "Rio de Janeiro" "CreationDate": " ", "LastUpdateDate": " ", "NumberOfRooms": 1, "OriginalPMSRoomType": "STDDDD", "CurrentPMSRoomType": "LX", "PMSRateCode": "2", "PMSBlockCode": "SS", "AllotmentCode": "AA", "ReservationSourceCode": "SDSSS", "ReservationMarketCode": "SSSSS", "ReservationSubMarketCode": "GHGH", "RewardProgramType": "FG", "LoyaltyID": 23, "Rates": [ "Amount": 80, "EffectiveDate": " T00:00: " "Amount": 85, "EffectiveDate": " T00:00: " "Amount": 90, "EffectiveDate": " T00:00: " "Amount": 95, "EffectiveDate": " T00:00: " "Amount": 100, "EffectiveDate": " T00:00: ", "CurrencyCode": "BRL" RMS Manual do Sistema 14

15 Exemplo de Erro Parcial Código HTTP: 206 "Message": "Partially Processed", "Warnings": [ "Code": 1043, "Message": "O campo \"IdHotel\" é inválido", "LocatorID": "21dsABV" Exemplo de Erro Código HTTP: 400 "Message": "Not Processed", Erros do Método Código Interno Mensagem de Erro 392 Código do hotel inválido 381 Data do check-in inválida 397 Número inválido de adultos 893 Código de Imposto inválido 1090 Id de reserva do hotel inválido 111 Reserva inválida 1043 O campo "IdHotel" é inválido 1044 O campo "IdHotel" é obrigatório 1029 O campo "Checkin" é obrigatório 1030 O campo "Checkout" é obrigatório 1101 O campo "Rates" é obrigatório 1098 O campo "EffectiveDate" é obrigatório 1099 O campo "Amount" é obrigatório 1027 O campo "CurrencyCode" é inválido 1028 O campo "CurrencyCode" é obrigatório Parâmetros Parâmetro Atributos Descrição Tipo Obrigatório BookingList Lista de bilhetes para atualização. String LocatorId Identificador do item no bilhete. Numeração gerada pelo requisitante. Integer HotelCode Código do Hotel Interger IsWalkin Informa se a reserva é oriunda de Boolean Walk-In caso o valor informado seja true RMS Manual do Sistema 15

16 MealplanCode Código do Plano de Refeição 1 Nenhuma 2 Café da manhã 3 Meia Pensão (Almoço) 4 Meia Pensão (Jantar) 5 Pensão Inteira 6 Tudo Incluso String Status Status da Reserva 1 Reservado 2 Reservado (Alterado) 3 Cancelado 4 Checked-in 5 Checked-Out 6- No-Show Integer ReservationNumberHIGS Número da reserva no HIGS Integer ReservationNumberHOTEL Número da Reserva no Hotel Integer Checkin Data do Checkin yyyy-mm-dd Checkout Data do Chekout yyyy-mm-dd ConfirmedCheckin Data de Confirmação do Checkin yyyy-mm-dd ConfirmedCheckout Data de Confirmação do Checkout yyyy-mm-dd Guests Informação sobre os Hóspedes Adults Quantidade de Adultos Integer Children Quantidade de Crianças Integer GuestOriginCountryCode País de Origem do Hóspede String GuestOriginStateCode Estado de Origem do Hóspede String GuestOriginCityName Cidade de Origem do Hóspede String CreationDate Data de Criação da Reserva yyyy-mm-dd LastUpdateDate Data de última atualização da Reserva yyyy-mm-dd NumberOfRooms Número de Quartos Integer OriginalPMSRoomType Quarto original da reserva String CurrentPMSRoomType Quarto utilizado pelo Hóspede String PMSRateCode Informa em qual tarifa a reserva foi efetuada String PMSBlockCode Código da Reserva de grupo, se String houver AllotmentCode Código do allotment se houver String ReservationSourceCode Código Alfanumérico definido pelo String PMS para o canal em que a Reserva foi efetuada ReservationMarketCode ReservationSubMarketCode RewardProgramType LoyaltyID Rates Código Alfanumérico definido pelo String PMS para o segmento de mercado em que a Reserva foi efetuada Código Alfanumérico definido pelo String PMS para o subsegmento de mercado em que a reserva foi efetuada Código do programa de fidelidade a String que o hóspedeestá filiado Identificador do programa de String fidelidade para o hóspede Array que contém os objetos de preços dia a dia Amount Valor pago Number RMS Manual do Sistema 16

17 CurrencyCode EffectiveDate Data básica de referência yyyy-mm-dd Moeda de moeda utilizado, 3 digitos Number de acordo com o código ISSO 4217 Get Booking for Download Método GET para a Pesquisa de Indicadores de Reservas disponível para download. Este método retorna a visão geral das reservas a serem baixadas. Este é um método exclusivo para parceiros. Request URL Retorno Sucesso Código HTTP: 200 "BookingDownloadList": [ "IdHotel": 55552, "RemainingReservationForDownload": 21 "IdHotel": 2225, "RemainingReservationForDownload": 1 "IdHotel": 4444, "RemainingReservationForDownload": 1 "IdHotel": 211, "RemainingReservationForDownload": 1 Get Booking by Hotel Método para fazer download de bilhetes de reserva do hotel. Este método retorna uma lista de reservas do hotel solicitado. Após a recepção o parceiro deve confirmar o processamento (método será descrito adiante) do mesmo para que eles sejam removidos da fila. Request URL RMS Manual do Sistema 17

18 Retorno Sucesso Código HTTP: 200 "BookingList": [ "LocatorId": null, "HotelCode": 55552, "ReservationNumberHIGS": "84r FFF45", "ReservationNumberHOTEL": "E22w2Sv21", "IsWalkin": true, "Status": 2, "PMSStatus": 0, "Checkin": " T03:00:00Z", "Checkout": " T03:00:00Z", "ConfirmedCheckin": " T03:00:00Z", "ConfirmedCheckout": " T03:00:00Z", "CreationDate": " T02:00:00Z", "LastUpdateDate": " T02:00:00Z", "NumberOfRooms": 1, "Guests": "Adults": 2, "Children": 1, "GuestOriginCountryCode": "BR", "GuestOriginStateCode": "RJ", "GuestOriginCityName": "Rio de Janeiro" "OriginalPMSRoomType": "STD", "CurrentPMSRoomType": "LX", "PMSRateCode": "2", "PMSBlockCode": "SS", "AllotmentCode": "AA", "MealPlanCode": 1, "ReservationSourceCode": "SDSSS", "ReservationMarketCode": "SSSSS", "ReservationSubMarketCode": "GHGH", "RewardProgramType": "FG", "LoyaltyID": "23", "CompanyInfo": null, "CurrencyCode": "BRL", "Rates": [ "EffectiveDate": " T23:00:00Z", "Amount": 80 "EffectiveDate": " T23:00:00Z", "Amount": 85 "EffectiveDate": " T23:00:00Z", "Amount": 90 "EffectiveDate": " T23:00:00Z", "Amount": 95 "EffectiveDate": " T23:00:00Z", "Amount": 100 "RemainingToDownload": 1 RMS Manual do Sistema 18

19 Retorno com Sucesso sem reservas para Download Código HTTP: 200 "Message": "There are no Reservations to Download.", "RemainingToDownload": 0 Exemplo de Erro Código HTTP: 400 "Message": "Not Processed", Parâmetros Parâmetro Descrição Tipo Obrigatório HotelCode Código do Hotel. Integer Exemplo: Confirm Booking Receive Métodos para confirmação do recebimento da reserva. É obrigatório o envio da confirmação do recebimento da reserva, se o mesmo não for feito a lista de reservas para download não será atualizada. Request URL Exemplo de requisição: Body "HotelCode": , "HotelReservationIds": [ "HotelReservationNumber": "84r FFF45" "HotelReservationNumber": "84r FFF45" RMS Manual do Sistema 19

20 Retorno Sucesso Código HTTP: 200 "Message": "Processed" Exemplo de requisição com Hotel inexistente: Body "HotelCode": AA, "HotelReservationIds": [ "HotelReservationNumber": "84r FFF45" "HotelReservationNumber": "84r = FFF45" Exemplo de Erro Código HTTP: 400 "Message": "Not Processed", Parâmetros Parâmetro Atributos Descrição Tipo Obrigatório HotelCode Código do Hotel. Integer HotelReservationIds Lista de Reservas HotelReservationNumber Número da reserva recebida Integer Set Booking To Resend Este método é para o parceiro solicitar o reenvio de reservas que já foram confirmadas anteriormente. Se o parceiro precisar receber reservas já confirmadas, basta usar esse método e elas retornarão à fila. Request URL Exemplo de requisição: RMS Manual do Sistema 20

21 Body "HotelCode": 55552, "HotelReservationIds": [ "HotelReservationNumber": "84r FFF45" "HotelReservationNumber": "84r = FFF45" Retorno Sucesso Código HTTP: 200 "Message : Processed Exemplo de Erro Parcial ERRO reserva inexistente Código HTTP: 206 "Message": "Partially Processed", "Warnings": [ "Code": 145, "Message": "Duration period or dates incorrect", "LocatorID": "ABCD123" Exemplo de Erro Código HTTP: 400 "Message": "Not Processed", Parâmetros Parâmetro Atributos Descrição Tipo Obrigatório HotelCode Código do Hotel. Integer HotelReservationIds Lista de Reservas HotelReservationNumber Número da reserva Integer RMS Manual do Sistema 21