Upload
trinhthuan
View
256
Download
1
Embed Size (px)
Citation preview
PMS – Manual do Sistema 1
PMS Manual do Sistema
V3.0
PMS – Manual do Sistema 2
Histórico de Revisões Data da Revisão Versão Descrição Autor 21/03/2017 V1.0 Criação do documento Patrick Melo
22/03/2017 V1.1 Ajustes Patrick Melo
23/03/2017 V1.2 Correções com base na revisão Patrick Melo
24/03/2017 V1.3 Ajuste no indice Patrick Melo
20/04/2017 V1.4 Correção nas chamadas da API Patrick Melo
01/06/2017 V1.5 Ajustes no método de inventário Vinicius Teixeira
11/07/2017 V1.6 Inclusão do método de UH, Grupo de Tarifa e Categoria de Tarifa
Vinicius Teixeira
31/08/2017 V1.7 Inclusão dos métodos de Contrato Luciano Santos
14/09/2017 V1.8 Inclusão do método de Grupo de UH Vinicius Teixeira
27/11/2017 V1.9 Inclusão do método de Consulta de Source Of Business e Alteração no método de UH
Vinicius Teixeira
21/12/2017 V2.0 Ajustes na documentação Vinicius Teixeira
29/12/2017 V2.1 Ajustes na documentação Luciano Santos
09/01/2017 V2.2 Ajustes na API do Contract Vinicius Teixeira
19/01/2018 V2.3 Ajustes nas Tags de Start e End de alguns métodos Vinicius Teixeira
31/01/2018 V2.4 Alteração na estrutura do Bilhete de Inventory Vinicius Teixeira
23/03/2018 V2.5 Inclusão de Lista de CompanyId e do campo de SourceOfBusiness no Bilhete de Rateplan
Vinicius Teixeira
12/04/2018 V2.6 Inclusão do método RateplanList Vinicius Teixeira
18/04/2018 V2.7 Inclusão do método de confirmação de recebimento de Rateplan, Rule e RateAmount
Vinicius Teixeira
04/07/2018 V2.8 Inclusão do Método para trazer os Parceiros Luis Felipe
10/07/2018 V2.9 Inclusão de Lista de Parceiros no bilhete de RatePlan Luis Felipe
06/08/2018 V3.0 Adição de elementos de faturamento e cancelamento no Rateplan
Luis Felipe
PMS – Manual do Sistema 3
Índice
Sumário Visão Geral .................................................................................................................................................................. 4
Autenticação ............................................................................................................................................................... 4
Idioma ......................................................................................................................................................................... 4
Compressão ................................................................................................................................................................ 5
Envio Parcial ............................................................................................................................................................... 5
Regras para o recebimento de bilhete ...................................................................................................................... 5
Métodos ..................................................................................................................................................................... 6
Allotment ............................................................................................................................................................... 6
Inventory ................................................................................................................................................................ 9
RateAmount ......................................................................................................................................................... 11
Rateplan ............................................................................................................................................................... 15
Rateplan List ......................................................................................................................................................... 18
Rule ...................................................................................................................................................................... 20
Reservation Download ......................................................................................................................................... 23
Reservation Confirmation ................................................................................................................................... 29
Rate ..................................................................................................................................................................... 30
UHGroup ............................................................................................................................................................... 35
UH ......................................................................................................................................................................... 37
RateGroup ............................................................................................................................................................ 41
RateCategory ........................................................................................................................................................ 43
Contract ................................................................................................................................................................ 46
Listagem de Source Of Business ........................................................................................................................... 52
Package ................................................................................................................................................................. 53
RateAvailability ..................................................................................................................................................... 57
SendBooking ......................................................................................................................................................... 59
PartnerList ............................................................................................................................................................ 64
PMS – Manual do Sistema 4
Visão Geral
Caro Parceiro,
Este documento visa esclarecer todos os procedimentos de como consumir via REST os recursos da HIGS PMS 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.
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-4652-87A9-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-4652-87A9-DF5BA91963F7
Content-Type: application/json;
charset=utf-8
Accept-Language: en-US
PMS – Manual do Sistema 5
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-4652-87A9-DF5BA91963F7
Content-Type: application/json;
charset=utf-8
Accept-Language: en-US
Accept-Encoding: gzip,deflate
Envio Parcial Todos os métodos, exceto o Download de Reservas, podem ter seu processamento total ou parcial. Isto quer dizer que um bloco de disponibilidade (LocatorID) não interfere em outro.
Regras para o recebimento de bilhetes Todos os métodos, exceto o Download de Reservas, podem receber até 10 bilhetes por requisição, o método de Inventory, além dos 10 bilhetes, cada um pode ter no máximo 366 dias.
PMS – Manual do Sistema 6
Métodos Allotment
Método POST de Allotments. São disponibilidade física de UHs (Unidades Habitacionais) dedicados exclusivamente para um cliente. O código do hotel deve ser passado na URL.
Request URL
http://api.pms.higs.com.br/api/v1/Allotment/{HotelCode}
Exemplo de requisição:
Body {
"Allotments": [
{
"LocatorID": "ABCD123",
"BookingLimit": 10,
"StatusApplicationControl": {
"RatePlanCode": "XPTO1",
"InvTypeCode": "STD",
"StartDate": "2017-09-01",
"EndDate": "2017-09-02",
"Mon": 1,
"Tue": 1,
"Wed": 1,
"Thu": 1,
"Fri": 0,
"Sat": 0,
"Sun": 0
}
}
]
}
Retorno Sucesso Código HTTP: 200
Response {
"Message” : “Processed”
}
PMS – Manual do Sistema 7
Exemplo de Erro Parcial Código HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 9999,
"Message": "Invalid field StatusApplicationControl",
"LocatorID": "ABCD456"
}
]
}
Exemplo de Erro Código HTTP: 400
Response {
"Message": "Not Processed"
}
Erros do Método
Código Interno Mensagem de Erro 15 Data inválida
145 Período ou datas incorretas
1058 O campo RatePlanCode é obrigatório
1117 O campo Start é obrigatório
1118 O campo End é obrigatório
1125 O campo BookingLimit é inválido
1126 O campo BookingLimit é obrigatório
1127 O campo InvTypeCode é 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
1151 O campo StatusApplication é obrigatório
PMS – Manual do Sistema 8
Parâmetros URL
Parâmetro Descrição Tipo Obrigatório
HotelCode Código do Hotel. Exemplo: http://api.pms.higs.com.br/api/v1/Allotment/1234
Integer
Parâmetros
Parâmetro Descrição Tipo Obrigatório
Allotments Lista de bilhetes para atualização.
Array
LocatorId Identificador do item no bilhete. Numeração gerada pelo requisitante.
String
BookingLimit Quantidade disponível da acomodação no período informado para o contrato.
Integer
StatusApplicationControl
Conjunto de informações de nome e endereço do hóspede.
Object
RatePlanCode Código de plano tarifário para o período.
String
InvTypeCode Código do tipo de acomodação
String
StartDate Data inicial do período
yyyy-MM-dd
EndDate
Data final do período
yyyy-MM-dd
Monk
Se marcado com 1, habilita apenas o dia da semana Integer
Tue
Se marcado com 1, habilita apenas o dia da semana Integer
Wed
Se marcado com 1, habilita apenas o dia da semana Integer
Thu
Se marcado com 1, habilita apenas o dia da semana Integer
Fri
Se marcado com 1, habilita apenas o dia da semana Integer
Sat
Se marcado com 1, habilita apenas o dia da semana Integer
Sun
Se marcado com 1, habilita apenas o dia da semana Integer
PMS – Manual do Sistema 9
Inventory Método POST para envio de inventário. O código do hotel deve ser passado na URL.
Request URL
http://api.pms.higs.com.br/api/v1/Inventory/{HotelCode}
Exemplo de requisição: Body
{
"Inventories":
[
{
"ActionType": "Allocation",
"Start": "2017-08-25",
"End": "2017-08-26",
"StatusApplicationControl":
[
{
"InvTypeCode": "A123",
"LocatorID": "1",
"Count": 64
}
]
}
]
}
Retorno Sucesso Código HTTP: 200
Response {
"Message” : “Processed”
}
Exemplo de Erro Parcial Código HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 145,
"Message": "Duration period or dates incorrect",
"LocatorID": "123"
}
]
}
Exemplo de Erro Código HTTP: 400
Response {
"Message": "Not Processed"
}
PMS – Manual do Sistema 10
Erros do Método
Código Interno Mensagem de Erro 15 Data inválida
145 Período ou datas incorretas
1095 Não há informações de inventário
1117 O campo Start é obrigatório
1117 O campo Start é obrigatório
1118 O campo End é obrigatório
1118 O campo End é obrigatório
1125 O campo Actiontype é inválido
1126 Inventories obrigatório
1127 O campo InvTypeCode é obrigatório
1128 O campo Count é obrigatório
1129 Código do Hotel é obrigatório
1130 O campo LocatorId é obrigatório
Parâmetros URL
Parâmetro Descrição Tipo Obrigatório
HotelCode Código do Hotel. Exemplo: http://api.pms.higs.com.br/api/v1/Inventory/1234
Integer
Parâmetros
Parâmetro Descrição Tipo Obrigatório
Start Data inicial do período
yyyy-MM-dd
End
Data final do período
yyyy-MM-dd
ActionType Tipo de bilhete que está sendo enviado Exemplo: Allocation
String
StatusApplicationControl
Lista de bilhetes para atualização.
Array
InvTypeCode Código do tipo de acomodação
String
LocatorID Identificador do bilhete. Numeração gerada pelo requisitante.
String(30)
Count Quantidade de quartos disponíveis Integer
PMS – Manual do Sistema 11
RateAmount Método POST para envio de preços. O código do hotel deve ser passado na URL.
Request URL
http://api.pms.higs.com.br/api/v1/RateAmount/{HotelCode}
Exemplo de requisição: Body
{
"RateAmountMessages" :
[
{
"LocatorID": "ABCD123",
"StatusApplicationControl":
{
"Start": "2016-01-01",
"End": "2017-12-31",
"RatePlanCode": "XPTO1",
"InvTypeCode": "STD",
"Mon": 1,
"Tue": 1,
"Wed": 1,
"Thu": 1,
"Fri": 0,
"Sat": 0,
"Sun": 0
},
"Rate":
{
"BaseByGuestAmts":
[
{ "AgeQualifyingCode": 10, "NumberOfGuests": 1, "AmountAfterTax": 100.00 },
{ "AgeQualifyingCode": 10, "NumberOfGuests": 2, "AmountAfterTax": 120.00 },
{ "AgeQualifyingCode": 10, "NumberOfGuests": 3, "AmountAfterTax": 130.00 },
{ "AgeQualifyingCode": 8, "AmountAfterTax": 100.00 },
{ "AgeQualifyingCode": 6, "AmountAfterTax": 100.00 }
]
},
"AdditionalGuestAmounts":
[
{ "AgeQualifyingCode": 10, "Amount": 10.00 },
{ "AgeQualifyingCode": 8, "Amount": 10.00 }
]
},
{
"LocatorID": "ABCD456",
"StatusApplicationControl":
{
"Start": "2016-01-01",
"End": "2017-12-31",
"RatePlanCode": "XPTO2",
"InvTypeCode": "STD",
"Mon": 1,
"Tue": 1,
"Wed": 1,
"Thu": 1,
"Fri": 1,
"Sat": 1,
"Sun": 1
},
"Rate":
{
"BaseByGuestAmts":
[
{ "AgeQualifyingCode": 10, "NumberOfGuests": 1, "AmountAfterTax": 110.00 },
{ "AgeQualifyingCode": 10, "NumberOfGuests": 2, "AmountAfterTax": 130.00 },
{ "AgeQualifyingCode": 10, "NumberOfGuests": 3, "AmountAfterTax": 140.00 },
PMS – Manual do Sistema 12
{ "AgeQualifyingCode": 10, "NumberOfGuests": 4, "AmountAfterTax": 150.00},
{ "AgeQualifyingCode": 8, "AmountAfterTax": 50.00 },
{ "AgeQualifyingCode": 6, "AmountAfterTax": 50.00 }
]
},
"AdditionalGuestAmounts":
[
{ "AgeQualifyingCode": 10, "Amount": 10.00 },
{ "AgeQualifyingCode": 8, "Amount": 10.00 }
]
}
]
}
Retorno Sucesso Código HTTP: 200
Response {
"Message” : “Processed”
}
Exemplo de Erro Parcial Código HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 145,
"Message": "Duration period or dates incorrect",
"LocatorID": "ABCD123"
}
]
}
Exemplo de Erro Código HTTP: 400
Response {
"Message": "Not Processed"
}
PMS – Manual do Sistema 13
Erros do Método
Código Interno Mensagem de Erro 145 Período ou datas incorretas
367 Formato inválido
1058 O campo RatePlanCode é obrigatório
1099 O campo Amount é obrigatório
1117 O campo Start é obrigatório
1117 O campo Start é obrigatório
1118 O campo End é obrigatório
1118 O campo End é obrigatório
1127 O campo InvTypeCode é obrigatório
1129 Código do hotel é 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
1140 O campo AgeQualifyingCode é obrigatório
1141 O campo AmountAfterTax é 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
1149 O campo AgeQualifyingCode é inválido
1151 O campo StatusApplicationControl é obrigatório
1178 O campo RateAmountItems é obrigatório
1179 O campo Rate é obrigatório
Parâmetros URL
Parâmetro Descrição Tipo Obrigatório
HotelCode Código do Hotel. Exemplo: http://api.pms.higs.com.br/api/v1/RateAmount/1234
Integer
PMS – Manual do Sistema 14
Parâmetros
Parâmetro Descrição Tipo Obrigatório
RateAmountMessages
Lista de bilhetes para atualização.
Array
LocatorID Identificador do bilhete. Numeração gerada pelo requisitante.
String(30)
StatusApplicationControl
Object
Start Data inicial do período
yyyy-MM-dd
End
Data final do período
yyyy-MM-dd
RatePlanCode
Código de plano tarifário String
InvTypeCode
Código do tipo de acomodação String
Mon
Se marcado com 1, habilita apenas o dia da semana.
Integer
Tue
Se marcado com 1, habilita apenas o dia da semana.
Integer
Wed
Se marcado com 1, habilita apenas o dia da semana.
Integer
Thu
Se marcado com 1, habilita apenas o dia da semana.
Integer
Fri
Se marcado com 1, habilita apenas o dia da semana.
Integer
Sat
Se marcado com 1, habilita apenas o dia da semana.
Integer
Sun
Se marcado com 1, habilita apenas o dia da semana.
Integer
Rate Informações de tarifa Object
BaseByGuestAmts Valor por número de hóspedes Object
AgeQualifyingCode
Código identificador do tipo de acompanhante. 10 – Adulto; 8 – Criança; 6 – Criança até 2 anos
Integer
NumberOfGuests
Número de hóspedes Integer
AmountAfterTax
Valor sem taxas Decimal
AdditionalGuestAmounts
Informações tarifárias para hóspedes adicionais Object
AgeQualifyingCode
Código identificador Integer
Amount
Valor Decimal
PMS – Manual do Sistema 15
Rateplan Método POST para envio de Plano Tarifário. O código do hotel deve ser passado na URL. Request URL
http://api.pms.higs.com.br/api/v1/Rateplan/{HotelCode}
Exemplo de requisição:
Body {
"RatePlans": [
{
"LocatorID": "88888",
"RatePlanCode": "XPT01",
"IsNew":true,
"Active":true,
"BillingPolicy":"A politica de faturamento...",
"BeforeArrival":{
"TimeUnit": "Day",
"Value": 2
},
"CancellationPolicy":{
"TimeUnit": "Hour",
"Value": 1
},
"ListOfSource": [
{
"SourceOfBusiness": "BOOKING",
"ListCompanyID": [
{
"CompanyId": "123"
},
{
"CompanyId": "12g3"
}
]
}
],
"Start": "2016-12-01",
"End": "2017-12-31",
"CurrencyCode": "BRL",
"IsCommissionable": "true",
"TypeComission": 0,
"ValueComission": 10,
"MealsIncluded": {
"MealPlanIndicator": "true",
"MealPlanCode": 1
},
"SellableProduct": [
{
"RoomTypeCode": "STD"
},
{
"RoomTypeCode": "SLX"
},
{
"RoomTypeCode": "SLU"
}
],
"Name": "XPTO1...",
"Partners": [
477892,157895
],
"Description": " Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
]
}
PMS – Manual do Sistema 16
Retorno Sucesso Código HTTP: 200
Response {
"Message” : “Processed”
}
Exemplo de Erro Parcial Código HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 145,
"Message": "Duration period or dates incorrect",
"LocatorID": "ABCD123"
}
]
}
Exemplo de Erro Código HTTP: 400
Response {
"Message": "Not Processed"
}
Erros do Método Código Interno Mensagem de Erro
15 Data inválida
367 Formato inválido
1027 O campo CurrencyCode é inválido
1058 O campo RatePlanCode é obrigatório
1085 RoomType inválido
1117 O campo Start é obrigatório
1118 O campo End é obrigatório
1119 O campo CurrencyCode é obrigatório
1120 O campo IsCommissionable é obrigatório
1121 O campo MealsIncluded é obrigatório
1122 O campo SellableProduct é obrigatório
1123 O campo MealPlanIndicator é obrigatório
1124 O campo MealPlanCode é obrigatório
1129 Código do Hotel é obrigatório
1130 O campo LocatorId é obrigatório
1402 Registro inserido, porém lista de CompanyIds do SourceOfBusiness estão duplicados e não serão inseridos.
1403 O Parceiro IdCliente não está átivo para distribuição
1404 Lista de Parceiros inválida verifique as permissões de distribuição.
PMS – Manual do Sistema 17
Parâmetros URL
Parâmetro Descrição Tipo Obrigatório
HotelCode Código do Hotel. Exemplo: http://api.pms.higs.com.br/api/v1/Rateplan/1234
Integer
Parâmetros
Parâmetro Descrição Tipo Obrigatório
RatePlans
Lista de bilhetes para atualização.
Array
LocatorID Identificador do bilhete. Numeração gerada pelo requisitante.
String(30)
RatePlanCode Código de plano tarifário
String
IsNew Identificar se o elemento é novo Boolean Active Identifica se o elemento esta átivo Boolean BillingPolicy Texto com a Politica de Faturamento String BeforeArrival
Informações para Faturamento
Object
TimeUnit Tipo de unidade DEFAULT de faturamento para Post (Day, Hour, Minute, Month , Week). Para Leitura(Day = 0, Hour = 1, Minute =2, Week = 3, Month = 4)
String
Value Unidade DEFAULT de tempo para faturamento da reserva.
Integer
CancellationPolicy
Informações para cancelamento
Object
TimeUnit Tipo de unidade DEFAULT de faturamento para
Post (Day, Hour, Minute, Month , Week). Para Leitura(Day = 0, Hour = 1, Minute =2, Week = 3, Month = 4)
String
Value Unidade DEFAULT de tempo para cancelamento da reserva.
Integer
ListOfSource
Lista de Origens List
SouceOfBusiness Código do Source Of Business String ListCompanyId Lista de CompanyIds List CompanyId CompanyIds String
Start Data inicial do período
yyyy-MM-dd
End
Data final do período
yyyy-MM-dd
CurrencyCode Código da moeda com padrão ISSO 4217. O ISO 4217 é um padrão internacional que define códigos de três letras para as moedas correntes.
String Exemplo: "CurrencyCode": "BRL"
IsCommissionable
Campo que informa se Rateplan é comissionado
Boolean
TypeComission
Caso IsCommissionable for verdadeiro este campo passa a ser Obrigatório. (TypeComission)
None = 0, Amount = 1, Percent = 2
Integer
PMS – Manual do Sistema 18
ValueComission Caso IsCommissionable for verdadeiro este campo passa a ser Obrigatório.(ValueComission)
decimal
MealsIncluded
Refeições incluídas
Object
MealPlanIndicator
Indica se contém refeição Boolean
MealPlanCode
Código da refeição Nenhum = 1, CafeDaManha = 2, Meia = 3, MeiaPensaoAlmoco = 4, MeiaPensaoJantar = 5, PensaoInteira = 6, TudoIncluso = 7
Integer
SellableProduct
Produtos à venda Array
RoomTypeCode
Código de RoomType String
Name
Nome do plano tarifário String
Description
Descrição do plano tarifário String
Partners Parceiros vinculados ao Hotel Array
Rateplan List A Api Rateplan List é composta de 2 métodos.
Método GET para listagem das informações cadastradas no sistema.
Método Post para confirmação de recebimento das informações No método Get iremos exibir as informações que englobam as informações de Rateplan, Rule e Rate Amount Request URL
http://api.pms.higs.com.br/api/v1/RateplanList/{HotelCode}?RatePlanCode={RatePlanCode *optional*}
Utilizando o parâmetro opcional será listado todas as informações do RateplanCode informado, isto engloba Rules e Rate Amount. Exemplo de resposta:
Body {
"RateplanList": [{
"RatePlan": [{
"ID": "cfdf2160-7353-40af-8a7f-164b0a4b3e65",
"RatePlanCode": "XPT01",
"ListOfSource": [{
"SourceOfBusiness": "BOOKING",
"ListCompanyID": [{
"CompanyId": "123"
},
{
"CompanyId": "12g3"
}]
}],
PMS – Manual do Sistema 19
"Start": "2016-12-01",
"End": "2017-12-31",
"CurrencyCode": "BRL",
"IsCommissionable": "true",
"MealsIncluded": {
"MealPlanIndicator": "true",
"MealPlanCode": 1
},
"SellableProduct": [{
"RoomTypeCode": "STD"
},
{
"RoomTypeCode": "SLX"
},
{
"RoomTypeCode": "SLU"
}],
"Name": "XPTO1...",
"Description": " Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}],
"RateAmount": [{
"ID": "63ce8c51-e9ad-474e-af76-a591c2db1b50",
"StatusApplicationControl": {
"Start": "2016-01-01",
"End": "2017-12-31",
"RatePlanCode": "XPT01",
"InvTypeCode": "STD",
"Mon": 1,
"Tue": 1,
"Wed": 1,
"Thu": 1,
"Fri": 0,
"Sat": 0,
"Sun": 0
},
"Rate": {
"BaseByGuestAmts": [{
"AgeQualifyingCode": 10,
"NumberOfGuests": 1,
"AmountAfterTax": 100.00
}]
},
"AdditionalGuestAmounts": [{
"AgeQualifyingCode": 10,
"Amount": 10.00
},
{
"AgeQualifyingCode": 8,
"Amount": 10.00
}]
}],
"Rule": [{
"ID": "b29667d8-e019-4bc5-8ea3-75b968376fa8",
"BookingLimit": 1,
"StatusApplicationControl": {
"RatePlanCode": "XPT01",
"InvTypeCode": "STD",
"StartDate": "2016-10-01",
"EndDate": "2016-10-31",
"Mon": 1,
"Tue": 1,
"Wed": 1,
"Thu": 1,
"Fri": 1,
"Sat": 1,
"Sun": 1
},
"RestrictionStatus": {
"RestrictionType": "Master",
"Status": "Open"
},
"LengthsOfStay": [{
"TimeUnit": "Day",
"Time": 1,
"MinMaxMessageType": "SetMinLOS"
}]
}]
}]
PMS – Manual do Sistema 20
}
No método Post iremos receber o código de ID, separado por tipo de bilhete, Rateplan, Rule ou Rate Amount. Request URL
http://api.pms.higs.com.br/api/v1/RatePlanList/{HotelCode}
PMS – Manual do Sistema 21
Exemplo de Resposta:
Body {
"ListConfirmation":[
{
"Rateplan":[
"cfdf2160-7353-40af-8a7f-164b0a4b3e65",
"cfdf2160-7353-40af-8a7f-164b0a4b3e65"
],
"Rule":[
"b29667d8-e019-4bc5-8ea3-75b968376fa8",
"142b8ac2-3007-413a-97e1-721a229e4c74"
],
"RateAmount":[
"63ce8c51-e9ad-474e-af76-a591c2db1b50",
"51feb0a3-9b91-4e6d-b160-6199b393f012",
"16948934-1195-42a0-945c-81053b66a440"
]
}
]
}
Retorno Sucesso Código HTTP: 200
Response {
"Message” : “Processed”
}
Rule
Método POST para envio de restrições tarifárias. Elas impõem regras com o mínimo e máximo de pernoite em determinados planos tarifários. O código do hotel deve ser passado na URL. Request URL
http://api.pms.higs.com.br/api/v1/Rule/{HotelCode}
Exemplo de requisição:
Body {
"RuleMessages": [
{
"LocatorID": "12312",
"BookingLimit": 1,
"StatusApplicationControl": {
"RatePlanCode": "XPTO1",
"InvTypeCode": "STD",
"StartDate": "2016-10-01",
"EndDate": "2016-10-31",
"Mon": 1,
"Tue": 1,
"Wed": 1,
"Thu": 1,
"Fri": 1,
"Sat": 1,
"Sun": 1
PMS – Manual do Sistema 22
},
"RestrictionStatus": {
"RestrictionType": "Master",
"Status": "Open"
},
"LengthsOfStay": [
{
"TimeUnit": "Day",
"Time": 1,
"MinMaxMessageType": "SetMinLOS"
}
]
}
]
}
Retorno Sucesso Código HTTP: 200
Response {
"Message” : “Processed”
}
Exemplo de Erro Parcial Código HTTP: 206
Response
{
"Message": "Partially Processed",
"Warnings": [{
"Code": 145,
"Message": "Duration period or dates incorrect",
"LocatorID": "ABCD123"
}
]
}
Exemplo de Erro Código HTTP: 400
Response {
"Message": "Not Processed",
}
Erros do Método
Código Interno Mensagem de Erro 15 Data inválida
367 Formato inválido
1058 O campo RatePlanCode é obrigatório
1117 O campo Start é obrigatório
1118 O campo End é obrigatório
1127 O campo InvTypeCode é obrigatório
1129 Código do Hotel é obrigatório
1130 O campo LocatorId é obrigatório
1131 O campo Mon é obrigatório
PMS – Manual do Sistema 23
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
1150 O campo RuleMessages é obrigatório
1151 O campo StatusApplicationControl é obrigatório
1152 O campo BookingRules é obrigatório
1153 O campo LengthsOfStay é obrigatório
1154 O campo RestrictionStatus é obrigatório
1155 O campo TimeUnit é obrigatório
1156 O campo Time é obrigatório
1157 O campo MinMaxMessageType é obrigatório
1158 O campo RestrictionType é obrigatório
1159 O campo Status é obrigatório
1160 O campo LengthsOfStay é inválido
1161 O campo Restriction é inválido
Parâmetros URL
Parâmetro Descrição Tipo Obrigatório
HotelCode Código do Hotel. Exemplo: http://api.pms.higs.com.br/api/v1/Rule/1234
Integer
Parâmetros
Parâmetro Descrição Tipo Obrigatório
RuleMessages
Lista de bilhetes para atualização.
Array
LocatorID Identificador do bilhete. Numeração gerada pelo requisitante.
String(30)
StatusApplicationControl
Destinado ao controle das informações Object
RatePlanCode
Código de Rateplan String
InvTypeCode
Código do tipo de acomodação String
StartDate Data inicial do período
yyyy-MM-dd
EndDate
Data final do período yyyy-MM-dd
Mon
Se marcado com 1, habilita apenas o dia da semana. Integer
Tue
Se marcado com 1, habilita apenas o dia da semana. Integer
Wed
Se marcado com 1, habilita apenas o dia da semana. Integer
Thu
Se marcado com 1, habilita apenas o dia da semana. Integer
Fri
Se marcado com 1, habilita apenas o dia da semana. Integer
Sat
Se marcado com 1, habilita apenas o dia da semana. Integer
PMS – Manual do Sistema 24
Sun
Se marcado com 1, habilita apenas o dia da semana. Integer
LengthsOfStay
Campo referente a duração da estadia Array
TimeUnit
Unidade de tempo Atualmente só recebe o parâmetro "Day"
String
Time
Quantidade em tempo relativo a unidade de tempo Integer
MinMaxMessageType
Campo destinado a mensagem String
RestrictionStatus
Campo referente as regras Array
RestrictionType
Campo destinado ao tipo de restrição String
Status
Status relativo ao tipo de restrição String
Reservation Download Método POST para o recebimento de reservas.
Request URL
http://api.pms.higs.com.br/api/v1/ReservationDownload
Exemplo de requisição: Body
{
"SelectionCriteria": {
"HotelCode": "12345"
}
}
Retorno Sucesso Código HTTP: 200
Response {
"Message": "Processed",
"ReservationsList": [{
"ReservationNumber": "99646d750g/803",
"ReservationNumberHigs": "99452370",
"OperationType": 2,
"Request":
"{\"CreatorId\":\"Omnibees\",\"SourceOfBusiness\":\"BOOKING\",\"IdHotel\":2125,\"Checkin\":\"2017-06-
09T00:00:00Z\",\"Checkout\":\"2017-06-11T00:00:00Z\",\"DateTimeInclusion\":\"2016-11-
11T13:20:24\",\"GuestCount\":2,\"NumberChildren\":0,\"MainGuest\":{\"GivenName\":\"LUCIANA\",\"Surename\"
:\"TEa3a\",\"Telephone\":null,\"Address\":{\"AdressLine\":null,\"CityName\":null,\"StateProv\":null,\"Zip
Code\":null,\"CountryName\":null,\"CompanyName\":null},\"Email\":\"[email protected]\"},\"Guest
s\":[{\"GivenName\":\"LUCIANA\",\"LastName\":\"BARONE VITORELLO\"}],\"Comment\":\" PAGAMENTO: FATURAAR
APENAS DIARIAS - DBL - QUARTO LUXO CASAL: A HOSPEDE MARIA SILVIA FARÁ O CHECK IN NO DIA 23/11, JÁ O
HOSPEDE ERNANI LEITE VITORELLO CHEGARÁ SOMENTE NO DIA
24/11\\r\\n##############################\\r\\n11/11/2016 3:41:00 PM;------------------------------------
----------------;11/11/2016 9:11:4AR APENAS DIARIAS - DBL - QUARTO LUXO CASAL: A HOSPEDE LUCIANA BARONE
PM;\\r\\n\",\"TypePayment\":2,\"TypeInvoice\":[\"Di\"],\"CreditCardData\":null,\"RatePlanCode\":\"4444\",
\"Commission\":0,\"RoomTypeCode\":\"aaa\",\"HotelReservationIds\":[{\"HotelReservationNumber\":\"99452370
\",\"TypeReservation\":2}],\"Taxes\":[{\"CodeTax\":1,\"Value\":40.58,\"Description\":\"Taxa de
Serviço\"}],\"Rates\":[{\"EffectiveDate\":\"2016-11-
23T00:00:00\",\"Amount\":242.25},{\"EffectiveDate\":\"2016-11-
24T00:00:00\",\"Amount\":242.25},{\"EffectiveDate\":\"2016-11-
PMS – Manual do Sistema 25
25T00:00:00\",\"Amount\":163.5},{\"EffectiveDate\":\"2016-11-
26T00:00:00\",\"Amount\":163.5}],\"TotalAmountBeforeTax\":811.5,\"CurrencyCode\":\"BRL\",\"CompanyInfo\":
null}"
}
]
}
Caso a requisição não retorne dados, o retorno somente exibirá uma mensagem informando que a requisição foi processada com sucesso.
Response {
"Message” : “Processed”
}
Exemplo de Erro Código HTTP: 400
Response {
"Message": "Not Processed",
}
Erros do Método Código Interno Mensagem de Erro
1129 Código do Hotel é obrigatório
Estrutura do Campo Request Request
{
"CreatorId": "Test",
"SourceOfBusiness": "BOOKING",
"IdHotel": 2125,
"Checkin": "2016-12-07",
"Checkout": "2016-12-14",
"DateTimeInclusion": "2016-09-16T01:57:00",
"GuestCount": 2,
"NumberChildren": 0,
"MainGuest": {
"GivenName": "Bruno João",
"Surename": "Carvalho",
"Telephone": "2121212121",
"Address": {
"AdressLine": "Rua abc, 10 - Centro",
"CityName": "Rio de Janeiro",
"StateProv": "RJ",
"ZipCode": "21212121",
"CountryName": "BR",
"CompanyName": "CompanyCo"
},
"Email": "[email protected]"
},
"Guests": [
{
"GivenName": "Alfredo Iried",
"LastName": "Santos"
}
],
"Comment": "1 double and 2 single beds5 - Bill only nghts bkd to cc# @ ck-in gs",
"TypePayment": 1,
"TypeInvoice": null,
"CreditCardData": {
"Flag": "MC",
"Name": "VirtualCard",
"CardNumber": "000004544465800",
"SecurityCode": "001",
"Expiration": "09/20"
},
PMS – Manual do Sistema 26
"RatePlanCode": "333",
"Commission": 25,
"RoomTypeCode": "noteste",
"HotelReservationIds": [
{
"HotelReservationNumber": "000907106/1",
"TypeReservation": 1
}
],
"Taxes": [{
"CodeTax": 1,
"Value": 1.0,
"Description": "ISS"
}],
"Rates": [
{
"EffectiveDate": "2016-12-07",
"Amount": 205.77
},
{
"EffectiveDate": "2016-12-08",
"Amount": 205.77
}
],
"TotalAmountBeforeTax": 1440.39,
"CurrencyCode": "BRL"
}
Parâmetros do Request
Parâmetro Descrição Tipo Obrigatório
CreatorId Nome do Sistema do parceiro. Exemplo: "CreatorId": "CRS HIGS"
String
SourceOfBusiness Código de origem da reserva. Este campo é usado para relacionar os Roomtypes e os RatePlans. A lista de origens está disponível no link http://api.higs.com.br/ Exemplo: "SourceOfBusiness": "BOOKING"
String(07)
IdHotel Código de identificação do Hotel no Higs. Exemplo: "IdHotel": 012345
Integer
Checkin Data de chegada do Hóspede. Exemplo: "Checkin": "2016-10-29"
String(10) (yyyy-MM-dd)
Checkout Data de saída do Hóspede. Exemplo: "Checkin": "2016-10-30"
String(10) (yyyy-MM-dd)
DateTimeInclusion Data e hora da inclusão da Reserva no integrador. Exemplo: "DateTimeInclusion": "2016-10-03T17:59:50"
String(19) (yyyy-MM-ddThh:mm:ss)
GuestCount Quantidade total de hóspedes adultos. Exemplo: "GuestCount": 2
Integer
NumberChildren Quantidade total de hóspedes crianças.
Integer
PMS – Manual do Sistema 27
Exemplo: "NumberChildren": 1
MainGuest
Conjunto de informações de nome e endereço do hóspede.
GivenName Nome do hóspede. Exemplo: "GivenName": "Manoel"
String(30)
Surename Sobrenome do hóspede. Exemplo: "Surename": "da Silva"
String(30)
Telephone Telefone do hóspede. Exemplo: "Telephone": "(21) 9999 9999"
String(20)
Address
Conjunto de informações do endereço do hóspede
AdressLine Endereço do hóspede. Exemplo: "AdressLine": "Av. Principal, n° 500"
String(70)
CityName Cidade do hóspede. Exemplo: "CityName": "Campinas"
String(255)
StateProv Estado de residência do hóspede. Exemplo: "StateProv": "São Paulo"
String(255)
ZipCode Cep de residência do hóspede. Exemplo: "ZipCode": "20500-001"
String(12)
CountryName País de residência do hóspede. Exemplo: "CountryName": "Brasil"
String(255)
Email E-mail do hóspede ou do responsável pela reserva. Exemplo: "Email": "[email protected]"
String(50)
Guests
Conjunto de informações dos hóspedes acompanhantes. * Máximo de 03 hóspedes.
GivenName Primeiro Nome do hóspede acompanhante. Exemplo: "GivenName": "Estela Valdez"
String(30)
LastName Sobrenome do hóspede acompanhante. Exemplo: "LastName": "Garcia"
String(30)
Comment Notas e observações sobre a reserva. Exemplo: "Comment": "Booking Modify text"
String[1400]
TypePayment Identificação do tipo de pagamento: 1 – Cartão de Crédito
Integer
PMS – Manual do Sistema 28
2 – Direto no Hotel 3 – Faturado para empresa Exemplo: "TypePayment": 2
TypeInvoice Lista de tipos de pagamento faturados para empresa. Usados somente quando o campo TypePayment = 3 (Invoice) Opções: Ty = Todas as despesas sem bebidas alcoólicas Tt = Todas as despesas Tx = Taxas An = Alimentação e bebidas não alcoólicas Di = Diárias Cf = reaplanhã Tl = Telefonemas Tu = Taxas de turismo Bu = Frigobar Fb = Frigobar Lv = Lavanderia *Mínimo de 01 e máximo de 05 tipos são aceitos. Exemplo: "TypeInvoice": ["Ty","Tx","An","Tl","Tu"]
Array[string]
CreditCardData Conjunto de informações de Cartão de Crédito. Preenchido somente quando o campo TypePayment = 1 (Cartão de Crédito). Nos demais casos os campos relativos ao conjunto de informações do cartão de crédito não precisam ser informados.
Flag Bandeira do cartão de crédito. Lista de bandeiras: GC - Good Card VI - Visa IK - Mastercard DC - Diners Club AX - American Express EL - ELO DS - Discover EV - Expedia Virtual Card Exemplo: "Flag": "VI"
String(02)
Name Nome impresso no cartão de crédito. Exemplo: "Name": "MANOEL SILVA"
String(30)
CardNumber Número do cartão de crédito. Exemplo: "CardNumber": "4444333322221111"
String(24)
SecurityCode Código de segurança do cartão de crédito. Exemplo: "SecurityCode": "123"
String(08)
Expiration Data de expiração do cartão de crédito no formato (mm/yy). Exemplo: "Expiration": "10/22"
String(05) (MM/yy)
RatePlanCode Código identificador do Rate Plan. String(64)
PMS – Manual do Sistema 29
Exemplo: "RatePlanCode": 20160101
Commission
Valor da comissão para o contrato associado ao parceiro. Se o contrato associado ao RateplanCode obedecer alguma regra de comissionamento o campo passa a obedecer às seguintes regras: - Para contratos Comissionados: (obrigatório) "Commission": 25 - Para contratos Não Comissionados: (obrigatório) "Commission": 0 - Para contratos Indiferentes: *Não é necessário incluir o campo no bilhete
Integer
RoomTypeCode Código identificador do Roomtype do integrador. É necessário que o hotel realize previamente o correlacionamento de Roomtypes no HIGS. Exemplo: "RoomTypeCode": 201602
String(64)
HotelReservationIds
Lista de hotéis onde a reserva está sendo efetuada.
HotelReservationNumber Número de identificação da reserva no integrador. Exemplo: "HotelReservationNumber": "131362840"
String(30)
TypeReservation Código identificador do tipo da reserva no integrador. Exemplo: "TypeReservation": 1
Integer
Taxes
Lista de informações das taxas.
CodeTax Código identificador da taxa no HIGS. Lista de códigos de taxas: 1 - Taxa de serviço 2 - Imposto sobre serviços 3 - Taxa de turismo 4 - Taxa Ecológica 5 - Imposto Circulação de 6 - Imposto Agregado 18 - Food & beverage 28 - Taxa Juiz de Fora
Exemplo: "CodeTax": 2
Integer
Value Valor da diária. Exemplo: "Value": 20.50
Number(12,2)
Description Descrição das taxas e impostos. Exemplo: "Description": "ISS"
String(50)
Rates Lista de informação dos valores dia-a-dia da reserva.
PMS – Manual do Sistema 30
EffectiveDate Data de realização da cobrança. (yyyy-mm-dd) Exemplo: "EffectiveDate": "2016-10-29
String(10) (yyyy-MM-dd)
Amount Valor da diária. Exemplo: "Amount": 190.20
Number(16,2)
TotalAmountBeforeTax Valor total da reserva sem taxas e impostos. Exemplo: "TotalAmountBeforeTax": 190.20
Number(16,2)
CurrencyCode Código da moeda utilizada na reserva. Código padrão ISO 4207. Exemplo: "CurrencyCode": "BRL"
String(03)
Reservation Confirmation Método POST para confirmação de recebimento de reservas. O número que deve ser informado para a confirmação do recebimento da reserva é o ReservationNumber, ele consta no bilhete de resposta da API de Reservation Download.
Request URL
http://api.pms.higs.com.br/api/v1/BookingConfirmation
Exemplo de requisição:
Body {
"HotelCode": 2125,
"HotelReservationIds": [
{
"HigsReservationNumber": 1233447
"HotelReservationNumber": 8999512
}
]
}
Retorno Sucesso Código HTTP: 200
Response {
"Message” : “Processed”
}
Exemplo de Erro Código HTTP: 400
Response {
"Message": "Not Processed"
}
PMS – Manual do Sistema 31
Erros do Método Código Interno Mensagem de Erro
1399 Reserva não encontrada
1400 Reserva Já confirmada
Rate
Inclusão de tarifa O cadastro de Tarifas possui três métodos:
Método POST, utilizado para realizar o cadastro de uma Categoria de Tarifas.
Método PUT, utilizado para atualizar o cadastro de uma Categoria de Tarifas.
Método DELETE, utilizado para excluir o cadastro de um Grupo de Tarifas Nos métodos Post e Put deve ser utilizada a estrutura de dados a seguir. O código do hotel deve ser passado na URL.
Request URL
http://api.pms.higs.com.br/api/v1/Rate/{HotelCode}
Exemplo de requisição: Body
{
"Rates": [
{
"LocatorID": "1234",
"HotelCode": "TUCM",
"HotelID": 2125,
"RateNumber": 305,
"RateName": "BALCAO 2017 ESPECIAL",
"CurrencyISOCode": "BRL",
"QttChildrenFree": 1,
"PercentageDiscountChildren": 0,
"PercentageDiscountChildren1": 0,
"RateExpirationDateInitial": "2017-09-01",
"RateExpirationDateFinal": "2018-10-26",
"IncludedCoffee": "C",
"NCANCEL": 0,
"CCANCEL": "H",
"PrepaymentPercent": 0,
"DaysToArrival": 0,
"DaysAfterRequestReservation": 0,
"Commission": 0,
"CategoryCode": "THEO",
"IDRateGroup": 1,
"AcceptRateCalc": "1",
"QttChildrenFree1": 0,
"Frequency": 1,
"MinimumStay": 1,
"MaximumStay": 99,
"WeekendDays": "0001100",
"CloseToArrival": "0001111",
"PriorityOrder": 0,
"IDEmployee": 2,
"TaxesServiceIncluded": "N",
"TaxesIncluded": "N",
"IDRate": "15226377",
"ErrorCode": "xxx",
PMS – Manual do Sistema 32
"RateplanCode": "BO",
"RateValues": [
{
"TPA_UHType": "LM",
"Value1GuestRate": 536,
"Value2GuestRate": 596,
"Value3GuestRate": 626,
"Value4GuestRate": 0,
"Value5GuestRate": 0,
"ValueAdditionalInRate": 0,
"FixedValueChild1": 0,
"FixedValueChild2": 0,
"RateType": "N",
"AdultHalfCoffeeValue": 0,
"ChildCoffeeValue1": 0,
"ChildCoffeeValue2": 0,
"AdultHalfPensionValue": 1,
"ChildHalfPension1": 1,
"ChildHalfPension2": 0,
"AdultFullPensionValue": 2,
"ChildFullPensionRange1": 2,
"ChildFullPensionRange2": 3,
"AdultAllIncludedValue": 0,
"ChildAllIncludedValue1": 0,
"ChildAllIncludedValue2": 1
}
],
"PensionRates": [
{
"PensionCode": "M",
"GuestType": 1,
"SpecialFlag": "N",
"Value1Guest": 626,
"Value2Guest": 2,
"Value3Guest": 3,
"Value4Guest": 4,
"ValueGuestAdditional": 5
}
]
}
]
}
Retorno Sucesso Código HTTP: 200
Response {
"Message” : “Processed”
}
Exemplo de Erro Parcial Código HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 145,
"Message": "Duration period or dates incorrect",
"LocatorID": "ABCD123"
}
]
}
Exemplo de Erro Código HTTP: 400
Response
PMS – Manual do Sistema 33
{
"Message": "Not Processed"
}
Parâmetros URL
Parâmetro Descrição Tipo Obrigatório
HotelCode Código do Hotel. Exemplo: http://api.pms.higs.com.br/api/v1/Rate/1234
Integer
Parâmetros
Parâmetro Descrição Tipo Obrigatório
LocatorID Identificador do bilhete. Numeração gerada pelo requisitante.
String(30)
HotelCode Código do hotel
HotelID ID do hotel
RateNumber Número da tarifa
RateName Nome da tarifa
CurrencyISOCode Código ISO da moeda
QttChildrenFree Quantidade de crianças Free na primeira faixa
QttChildrenFree1 Quantidade de crianças Free na segunda faixa
PercentageDiscountChildren Percentual de desconto para crianças na primeira faixa
PercentageDiscountChildren1 Percentual de desconto para crianças na segunda faixa
RateExpirationDateInitial Data de início da validade da tarifa
RateExpirationDateFinal Data de final de validade da tarifa
IncludedCoffee Padrão de Pensão (S - Sem café / C - Com café / M - Meia pensão / A - Meia Pensão Almoço / J - Meia Pensão Jantar / I - Pensão inteira / T - All-Inclusive (Tudo Incluso))
NCancel Quantidade referente a CCANCELA
CCancel Tipo de cancelamento (H - Horas antes da chegada / D - Dias antes da chegada / W - Semanas antes da chegada / A - Horas do dia da chegada (manhã) / P - Horas do dia da chegada (tarde))
PMS – Manual do Sistema 34
PrepaymentPercent Percentual de pré-pagamento
DaysToArrival Dias da Chegada
DaysAfterRequestReservation Dias após a Solicitação da Reserva
Commission Percentual de comissão pago
CategoryCode Código da Categoria
IDRateGroup Id do grupo de tarifas em
AcceptRateCalc Se a tarifa for gerenciada através do calendário de tarifas = 1 se não = 0
Frequency Frequência de lançamento das tarifas na conta do hospede
MinimumStay Estadia mínima
MaximumStay Estadia máxima
WeekendDays Dias para valer a tarifa especial chegada 7- Dom, 1- Seg,2 Ter, etc.
CloseToArrival Fechado para chegada 7- Dom, 1- Seg,2 Ter, etc.
PriorityOrder Indica a ordem em que as tarifas irão ser listadas na tela de atendimento da Central de Reservas.
IDEmployee Id do funcionário que incluiu/alterou o registro
TaxesServiceIncluded Taxa de Serviço Incluída: S/N
TaxesIncluded Imposto Incluído: S/N
IDRate Id da tarifa
RateplanCode RatePlan Code
RateValues
TPA_UHType Tipo de UH
Value1GuestRate Valor de 1 pax na tarifa
Value2GuestRate Valor de 2 pax na tarifa
Value3GuestRate Valor de 3 pax na tarifa
PMS – Manual do Sistema 35
Value4GuestRate Valor de 4 pax na tarifa
Value5GuestRate Valor de 5 pax na tarifa
ValueAdditionalInRate Valor do adicional na tarifa
RateType Tipo de tarifa N-Normal E-Especial
AdultFullPensionValue Valor da Pensão Inteira adulto
AdultHalfPensionValue Valor da Pensão Meia adulto
AdultHalfCoffeeValue Valor da Café Meia adulto
ChildFullPensionRange1 Valor da Pensão Inteira criança faixa 1
ChildFullPensionRange2 Valor da Pensão Inteira criança faixa 2
ChildHalfPension1 Valor da Pensão Meia criança faixa 1
ChildHalfPension2 Valor da Pensão Meia criança faixa 2
ChildCoffeeValue1 Valor da Pensão Café criança faixa 1
ChildCoffeeValue2 Valor da Pensão Café criança faixa 2
FixedValueChild1 Valor fixo de criança 1
FixedValueChild2 Valor fixo de criança 2
AdultAllIncludedValue Pensão adulto Tudo Incluso .
ChildAllIncludedValue1 Valor criança 1 tudo incluso.
ChildAllIncludedValue2 Valor criança 2 tudo incluso.
PensionRates
PensionCode Padrão de Pensão (S - Sem café / C - Com café / M - Meia
pensão / A - Meia Pensão Almoço / J - Meia Pensão Jantar / I
- Pensão inteira / T - All-Inclusive (Tudo Incluso))
GuestType Tipo de Pax: 0=adulto 1=crian a 1 2=crian a 2
SpecialFlag Indica se é tarifa especial.
Value1Guest Valor para 1 pax.
Value2Guest Valor para 2 pax.
PMS – Manual do Sistema 36
Value3Guest Valor para 3 pax.
Value4Guest Valor para 4 pax.
ValueGuestAdditional Valor de Pax Adicional.
Exclusão de tarifa Método DELETE para Excluir as tarifas. O código do hotel deve ser passado na URL. Request URL
http://api.pms.higs.com.br/api/v1/Rate/{HotelCode}?codRate={RateCode}
Retorno Sucesso Código HTTP: 200
Response {
"Message” : “Processed”
}
Exemplo de Erro Código HTTP: 500
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 500,
"Message": "Error when deleting the Rate"
}
]
}
UHGroup
O cadastro de Grupo de UH possui três métodos
Método POST, utilizado para realizar o cadastro de um Grupo de UH
Método PUT, utilizado para atualizar o cadastro de um Grupo de UH
Método DELETE, utilizado para excluir o cadastro de um Grupo de UH. Nos métodos Post e Put deve ser utilizado a estrutura de dados a seguir. O código do hotel deve ser passado na URL.
PMS – Manual do Sistema 37
Request URL
http://api.pms.higs.com.br/api/v1/UhGroup/{HotelCode}
Exemplo de requisição: Body
{
"UhGroup": [
{
"LocatorId": "123",
"UhGroupCode": "A12",
"UhGroupDescription": "GRUPO DE UH DE TESTE"
}
]
}
Retorno Sucesso Código HTTP: 200
Response {
"Message” : “Processed”
}
Exemplo de Erro Parcial Código HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 1360,
"Message": " O campo UhGroupCode é obrigatório", "LocatorID": "1234"
}
]
}
Método DELETE Request URL
http://api.pms.higs.com.br/api/v1/UhGroup/{HotelCode}?codUhGroup={UhGroupCod}
Exemplo de Erro Código HTTP: 400
Response {
"Message": "Not Processed",
}
PMS – Manual do Sistema 38
Erros do Método
Código Interno Mensagem de Erro 1360 O campo UhGroupCode é obrigatório
1361 O tamanho do campo UhGroupCode (03 caracteres) foi excedido
1362 O campo UhGroupDescription é obrigatório
1363 O tamanho do campo UhGroupDescription (60 caracteres) foi excedido.
1364 Este Grupo de UH já está cadastrado
1365 Este Grupo de UH não existe
Parâmetros URL
Parâmetro Descrição Tipo Obrigatório
HotelCode Código do Hotel. Exemplo: http://api.pms.higs.com.br/api/v1/uhgroup/1234
Integer X
Parâmetros Parâmetro Descrição Tipo Obrigatório
UhGroup Lista de bilhetes para atualização.
Array X
LocatorId Identificador do item no bilhete. Numeração gerada pelo requisitante.
String X
UhGroupCode Código do Grupo de UH String X
UhGroupDescription Descrição do Grupo de UH String(60) X
UH Método POST para inclusão de tipos de UH. O código do hotel deve ser passado na URL. Request URL
http://api.pms.higs.com.br/api/v1/UH/{HotelCode}
Exemplo de requisição:
Body {
"UHs": [
{
"LocatorId": "1234",
"UHType": "TS",
"IdTypeUH": 10,
"IdGroupUH": 10,
"UHDescription": "Descrição da UH",
"PeopleAmount": 1,
"CommentPT": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
"CommentEN": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
"CommentES": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
"AvailableStdQtt": 1,
"PercentAvailableCmnet": 10,
"TotalUHsHotel": 2,
"SmokingRoom": "N",
"BathroomType": "P",
"QttBedsType1": 2,
"IdBedsType1": 2,
"QttBedsType2": null,
PMS – Manual do Sistema 39
"IdBedsType2": 0,
"QttBedsType3": null,
"IdBedsType3": 0,
"IdViewType1": 1,
"IdViewType2": null,
"IdLocationUHType1": 10,
"IdLocationUHType2": 0,
"IdTypeQualityUH": 1,
"DistributorCode": "S2U",
"QttAdultsUH": 2,
"QttChildrenUH": 1,
"Shared": "S"
}
]
}
Retorno Sucesso Código HTTP: 200
Response {
"Message” : “Processed”
}
Exemplo de Erro Parcial Código HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 1204,
"Message": " The IdLocationUHType1 field is required", "LocatorID": "1234"
}
]
}
Exemplo de Erro Código HTTP: 400
Response {
"Message": "Not Processed"
}
Erros do Método
Código Interno Mensagem de Erro 1130 O campo LocatorId é obrigatório
1195 O campo Descricao é obrigatório
1196 O campo TipoUH é obrigatório
1197 O campo IdCamaTipo1 é obrigatório
1198 O campo QtdCamasTipo1 é obrigatório
1199 O campo QtdCamasTipo2 está inválido
1200 O campo IdCamaTipo2 está inválido
1201 O campo QtdCamasTipo3 está inválido
1202 O campo IdCamaTipo3 está inválido
1203 O campo IdVistaTipo2 está inválido
PMS – Manual do Sistema 40
1204 O campo IdLocalizacaoUHTipo1 é obrigatório
1205 O campo IdLocalizacaoUHTipo2 está inválido
1206 O campo IdTipoUH está inválido
1207 O campo CodigoDistribuidor é obrigatório
1208 O campo IdGrupoUH está inválido
1210 O campo IdVistaTipo1 é inválido
1215 O campo QtdPessoas é obrigatório
1216 O campo IdTipoQualidadeUH é obrigatório
1217 O campo QtdAdultosUH é obrigatório
1218 O campo TotalUHsHotel é obrigatório
1233 Número de registros não permitidos no campo TipoUH
1234 Número de registros não permitidos no campo de comentário
1368 Erro ao informar se a UH é compartilhada, informe "S" ou "N"
1395 Registro Inexistente para Exclusão
1397 Código de UH já cadastrado no Hotel informado
1398 O IdGrupoUH informado não está cadastrado
Parâmetros URL
Parâmetro Descrição Tipo Obrigatório
HotelCode Código do Hotel. Exemplo: http://api.pms.higs.com.br/api/v1/RateAmount/1234
Integer
Parâmetros
Parâmetro Descrição Tipo Obrigatório
LocatorId Lista de bilhetes para atualização. Array
UHType Tipo da Uh. Array
IdTypeUH Tipo de quarto Integer
IdGroupUH Código do Grupo de UH String
UHDescription Descrição da Uh. Array
PeopleAmount Quantidade de Pessoas. Integer
CommentPT Comentário em Português Array
CommentEN Comentário em Inglês Array
CommentES Comentário em Espanhol Array
AvailableStdQtt Quantidade default de disponibilidade. Integer
PMS – Manual do Sistema 41
PercentAvailableCmnet Percentual da disponibilidade do hotel Integer
TotalUHsHotel Número total de uhs no hotel Integer
SmokingRoom Quarto de fumante <F>umante , <N>ão Fumante ou <A>mbos
Array
BathroomType Banheiro <P>rivado, Banheiro <C>ompartilhado Array
QttBedsType1 Quantidade de camas do 1º tipo Integer
IdBedsType1 Id do 1º tipo de cama Integer
QttBedsType2 Quantidade de camas do 2º tipo Integer
IdBedsType2 Id do 2º tipo de cama Integer
QttBedsType3 Quantidade de camas do 3º tipo Integer
IdBedsType3 Id do 3º tipo Integer
IdViewType1 1º Tipo de vista Integer
IdViewType2 2º Tipo de vista Integer
IdLocationUHType1 1º Tipo de localização do quarto Integer
IdLocationUHType2 2º Tipo de localização do quarto Integer
IdTypeQualityUH Tipo de qualidade do quarto Integer
DistributorCode Código da UH no distribuidor Array
QttAdultsUH Quantidade máxima de adultos no quarto Integer
QttChildrenUH Quantidade máxima de crianças no quarto Integer
Shared UH Compartilhada String S – Sim N - Não
PMS – Manual do Sistema 42
Excluir UH Método DELETE para excluir o cadastro de UH O código do hotel e o código da UH deve ser passado na URL. Request URL
http://api.pms.higs.com.br/api/v1/UH/{HotelCode}?UHType={UHType}
RateGroup O cadastro de Grupo de Tarifas possui três métodos:
Método POST, utilizado para realizar o cadastro.
Método PUT, utilizado para atualizar o cadastro.
Método DELETE, utilizado para excluir o cadastro. Nos métodos Post e Put deve ser utilizada a estrutura de dados a seguir. O código do hotel deve ser passado na URL.
Inserir/Atualizar Grupo de tarifa Request URL
http://api.pms.higs.com.br/api/v1/RATEGROUP/{HotelCode}
Exemplo de requisição:
Body {
"RateGroups":
[
{
"LocatorId": "1234",
"RateGroupCode": "XX1",
"RateGroupDescription": "Grupo Tarifas Teste API 01"
},
{
"LocatorId": "abcd",
"RateGroupCode": "XX2",
"RateGroupDescription": "Grupo Tarifas Teste API ab"
}
]
}
Retorno Sucesso Código HTTP: 200
Response {
"Message” : “Processed”
}
PMS – Manual do Sistema 43
Exemplo de Erro Parcial Código HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 145,
"Message": "Duration period or dates incorrect",
"LocatorID": "ABCD123"
}
]
}
Exemplo de Erro Código HTTP: 400
Response {
"Message": "Not Processed"
}
Parâmetros URL
Parâmetro Descrição Tipo Obrigatório
HotelCode Código do Hotel. Exemplo: http://api.pms.higs.com.br/api/v1/RateAmount/1234
Integer
Parâmetros
Parâmetro Descrição Tipo Obrigatório
LocatorID Identificador do bilhete. Numeração gerada pelo requisitante.
String(30)
RateGroupCode Código do Grupo de Tarifas String(05)
RateGroupDescription Descrição do Grupo de Tarifas String(60)
Erros do Método
Código Interno Mensagem de Erro 1130 O campo LocatorId é obrigatório
1221 O campo RateGroupCode é obrigatório
1222 O tamanho do campo RateGroupCode (05 caracteres) foi excedido.
1223 O campo RateGroupDescription é obrigatório
1224 O tamanho do campo RateGroupDescription (60 caracteres) foi excedido.
PMS – Manual do Sistema 44
Excluir Grupo de tarifa Método DELETE para excluir os Grupos de Tarifa. O código do hotel e o código do Grupo de Tarifas devem ser passados na URL. Request URL
http://api.pms.higs.com.br/api/v1/RATEGROUP/{HotelCode}?codRateGroup={RateGroupCode}
Retorno Sucesso Código HTTP: 200
Response {
"Message” : “Processed”
}
Exemplo de Erro Código HTTP: 400
Response {
"Message": "Existe associação para este Grupo de Tarifas. Desfaça as associações e tente novamente."
}
RateCategory O cadastro de Categoria de Tarifas possui três métodos:
Método POST, utilizado para realizar o cadastro.
Método PUT, utilizado para atualizar o cadastro.
Método DELETE, utilizado para excluir o cadastro. Nos métodos Post e Put deve ser utilizada a estrutura de dados a seguir.
Inserir/Atualizar Categoria de Tarifa O código do hotel deve ser passado na URL. Request URL
http://api.pms.higs.com.br/api/v1/RATECATEGORY/{HotelCode}
PMS – Manual do Sistema 45
Exemplo de requisição:
Body {
"RateCategories":
[
{
"LocatorId": "1234",
"RateCategoryCode": "XX1",
"RateCategoryDescription": "Grupo Tarifas Teste API 01"
},
{
"LocatorId": "abcd",
"RateCategoryCode": "XX2",
"RateCategoryDescription": "Grupo Tarifas Teste API ab"
}
]
}
Retorno Sucesso Código HTTP: 200
Response {
"Message” : “Processed”
}
Exemplo de Erro Parcial Código HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 145,
"Message": "Duration period or dates incorrect",
"LocatorID": "ABCD123"
}
]
}
Exemplo de Erro Código HTTP: 400
Response {
"Message": "Not Processed",
}
Parâmetros URL
Parâmetro Descrição Tipo Obrigatório
HotelCode Código do Hotel. Exemplo: http://api.pms.higs.com.br/api/v1/RateAmount/1234
Integer
PMS – Manual do Sistema 46
Parâmetros
Parâmetro Descrição Tipo Obrigatório
LocatorID Identificador do bilhete. Numeração gerada pelo requisitante.
String(30)
RateCategoryCode Código da Categoria de Tarifas String(20)
RateCategoryDescription Descrição da Categoria de Tarifas String(60)
Excluir Categoria de tarifa Método DELETE para excluir os tipos de uh. O código do hotel deve ser passado na URL.
Request URL
http://api.pms.higs.com.br/api/v1/RATEGROUP/{HotelCode}?codRateCategory={RateCategoryCode}
Retorno Sucesso Código HTTP: 200
Response {
"Message” : “Processed”
}
Exemplo de Erro Parcial Código HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 145,
"Message": "Duration period or dates incorrect",
"LocatorID": "ABCD123"
}
]
}
Exemplo de Erro Código HTTP: 400
Response {
"Message": "Not Processed"
}
PMS – Manual do Sistema 47
Erros do Método
Código Interno Mensagem de Erro 1130 O campo LocatorId é obrigatório
1228 O campo RateCategoryCode é obrigatório
1229 O tamanho do campo RateCategoryCode (05 caracteres) foi excedido.
1230 O campo RateCategoryDescription é obrigatório
1231 O tamanho do campo RateCategoryDescription (60 caracteres) foi excedido.
Contract O cadastro de Contratos possui três métodos:
Método POST, utilizado para realizar o cadastro de um Contrato.
Método PUT, utilizado para atualizar o cadastro de um Contrato.
Método DELETE, utilizado para excluir o cadastro de um Contrato. Nos métodos Post e Put deve ser utilizada a estrutura de dados a seguir. O código do hotel deve ser passado na URL.
Request URL
http://api.pms.higs.com.br/api/v1/Contract/{HotelCode}
Exemplo de requisição: Body
{
"Contract": [
{
"LOCATORID": "13561",
"COD_AGEMP": "62202SB",
"CONTRNUM": 3,
"CONTRNAME": "TARIFA MARINGA",
"INITIALDATE": "2018-01-20",
"ENDDATE": "2018-01-25",
"ALLOT": "N",
"CATEGORYCODE": "001",
"CCANCEL": "H",
"NCANCEL": 48,
"CODUH1": "",
"CODUH2": "",
"CODUH3": "",
"CODUH4": "",
"COMMISSION": 0,
"COMPANYCODE": "",
"COMPANYID": 0,
"CREDIT": "L",
"CUTOFF": 0,
"DAYS_DEPG": 0,
"DAYS_PREPG": 0,
"DISTRIBUTOR": "",
"EXCLUDE": 0,
"IDCONTINENT": 1,
PMS – Manual do Sistema 48
"IDGEOREGION": 1,
"INCLCOFFEE": "C",
"LASTCUTOFF": "",
"MARKUP1": 0,
"MARKUP2": 0,
"MARKUP3": 0,
"MARKUP4": 0,
"MERCHANT": "",
"OWNERID": 0,
"PERC_PREPG": 0,
"PRIORITY": 1,
"QTUH1": 0,
"QTUH2": 0,
"QTUH3": 0,
"QTUH4": 0,
"RATEPLANCODE": "",
"ROOMTX": "0",
"SYSTEMID": 0,
"TAXNUM": 0,
"TYPECONTRACTFRONT": "N",
"UPDATED": "1900-01-01",
"USERID": 0,
"ContractLanguages": [
{
"IDLANGUAGE": 1,
"LANGUAGENAME": "",
"LANGUAGEDESCRIPTION": "N",
"LANGUAGEINFORMATIONS": "N",
"TITLE": "N",
"LANGUAGEDATA": "XXX Português",
"POLITICSDESCRIPTION": "1 hora antes do check in",
"GEOGRAPHICDESCRIPTION": "We will only accepted reservations with deposit in
bank of 70% of the value of the rates ten days before the check-in.Only for
groups",
"CULTUREDESCRIPTION": "Serviços prestados pelo hotel Inglês vvv",
"GENERALDESCRIPTION1": "N",
"GENERALDESCRIPTION2": "N",
"GENERALDESCRIPTION3": "N"
}
]
}
]
}
Retorno Sucesso Código HTTP: 200
Response {
"Message” : “Processed”
}
Exemplo de Erro Parcial Código HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 145,
"Message": "Duration period or dates incorrect",
"LocatorID": "ABCD123"
}
]
}
Exemplo de Erro Código HTTP: 400
PMS – Manual do Sistema 49
Response {
"Message": "Not Processed"
}
Erros do Método
Código Interno Mensagem de Erro 1369 Este código de contrato já está cadastrado para o hotel informado
1370 A agência já possui um contrato com este nome para o Hotel informado
1371 Para o campo Allot informe N ou A
1372 O campo de LASTCUTOFF só deve ser informado se o Allot foi igual a A
1373 Data inválida no campo LASTCUTOFF
1374 Registro inexistente, informe um código ou categoria de Tarifa válidos
1375 Data inicial inválida
1376 A data inicial e final devem ser diferentes
1377 Código de política de cancelamento inválido
1378 Código de pensão inválido
1379 Código de Distribuidor inválido
1380 Código de crédito inválido
1383 Registro inexistente para atualização
1393 Código do Continente inválido
1394 Código da região geográfica inválido
1395 Registro inexistente para exclusão
Parâmetros URL
Parâmetro Descrição Tipo Obrigatório
HotelCode Código do Hotel. Exemplo: http://api.pms.higs.com.br/api/v1/Contract/1234
Integer
Parâmetros
Parâmetro Descrição Tipo Obrigatório
LocatorID Identificador do bilhete. Numeração gerada pelo requisitante.
Cod_Agemp Código da agência String(07)
Contrnum Número do contrato Integer
PMS – Manual do Sistema 50
Contrname Nome do contrato String(20)
Initialdate Data de início de validade do contrato Date
Endate Data de final de validade do contrato Date
Allot Se for contrato de allotment = A String(01)
CategoryCode Categoria da tarifa String(20)
Ccancel Política de cancelamento válido para este contrato (H - Horas antes da chegada / D - Dias antes da chegada / W - Semanas antes da chegada / A - Horas do dia da chegada (manhã) / P - Horas do dia da chegada (tarde))
String(01)
Ncancel Quantidade referente a CCANCEL Integer
CodUh1 Tipo de UH 1 String(02)
CodUh2 Tipo de UH 2 String(02)
CodUh3 Tipo de UH 3 String(02)
CodUh4 Tipo de UH 4 String(02)
Commission Percentual de comissão Integer
Companycode
Código da Empresa String(07)
Companyid Id da Empresa Integer
Credit Crédito da agência (L)iberado, (B)loqueado, Aval da (G)erência
String(01)
CutOff O Cut-off será feito com antecedência de: ‘n’ dias Integer
Days_Depg Dias após a Solicitação da Reserva para o pré-pagamento Integer
Days_Prepg Dias antes da Chegada para o pré-pagamento Integer
Distributor Distribuidor onde este contrato pode ser visualizado - G - GDS, I - Internet, null Ambos/Todos
String(01)
Exclude O Cut-off será excluído em ‘n’ dias Integer
IdContinent Id do Continente quando contrato genérico Integer
IdGeoregion Id da região geográfica quando contrato genérico Integer
Inclcoffee Padrão de Pensão (S - Sem café / C - Com café / M - Meia pensão / A - Meia Pensão Almoço / J - Meia Pensão Jantar / I -
String(01)
PMS – Manual do Sistema 51
Pensão inteira / T - All-Inclusive (Tudo Incluso))
LastcutOff Data do último cutoff Date
MarkUp1 Percentual de markup do tipo 1 Integer
MarkUp2 Percentual de markup do tipo 2
Integer
MarkUp3 Percentual de markup do tipo 3 Integer
MarkUp4 Percentual de markup do tipo 4 Integer
Merchant Se o allotment é Merchant Model String(01)
Perc_Prepg Percentual de pré-pagamento Decimal
Priority Prioridade Integer
Qtuh1 Quantidade de Uh's no Allotment 1 Integer
Qtuh2 Quantidade de Uh's no Allotment 2 Integer
Qtuh3 Quantidade de Uh's no Allotment 3 Integer
Qtuh4 Quantidade de Uh's no Allotment 4 Integer
RateplanCode Código do Rateplan String(10)
RoomTX Se existe cobrança de Taxa de Turismo para este contrato (1)Sim ou (0)Não
String(01)
SystemId Id do sistema que criou/alterou o registro Integer
TaxNum Número da tarifa do contrato Integer
TypeContractFront Flag para contrato padrão no front. Indica o Tipo de contrato: NORMAL (N) ou PADRÃO (P)
String(01)
Updated Data da última atualização do Registro Date
UserId Usuário que criou/alterou o registro Integer
ContractLanguages
IdLanguage Id do idioma Integer
LanguageName Nome do Idioma String(150)
PMS – Manual do Sistema 52
LanguageDescription
Descrição do Idioma String(4000)
LanguageInformations
Informações do Idioma String(4000)
Title Título String(100)
LanguageData Dados do Idioma String(4000)
PoliticsDescription Descrição das Políticas String(4000)
GeoGraphicDescription Descrições da Geografia String(4000)
CultureDescription Descrição da Cultura String(4000)
GeneralDescription1 Descrição geral 1 String(4000)
GeneralDescription2 Descrição geral 2 String(4000)
GeneralDescription3 Descrição geral 3 String(4000)
Exclusão de Contrato Método DELETE para exclusão de contratos. O código do hotel deve ser passado na URL junto com o código do contrato Request URL
http://api.pms.higs.com.br/api/v1/Contract/{HotelCode}?codContract={ContractCode}
Retorno Sucesso Código HTTP: 200
Response {
"Message” : “Processed”
}
Exemplo de Erro Código HTTP: 500
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 500,
"Message": "Error when deleting the Contract",
}
]
}
PMS – Manual do Sistema 53
Listagem de Source Of Business Método GET para listagem dos Sources Of Business cadastrados no sistema. Request URL
http://api.pms.higs.com.br/api/v1/SourceOfBusiness
Retorno Sucesso Código HTTP: 200
Response {
"SourceOfBusinessList": [
{
"Source": "AAATISM",
"Name": "AAATOURISMSITEMINDER"
},
{
"Source": "AADTNMN",
"Name": "MUNRO'S TRAVEL LIMITED"
},
{
"Source": "AATRVEL",
"Name": "AATRAVELSITEMINDER"
},
{
"Source": "ABREREU",
"Name": "ABREUSITEMINDER"
},
{
"Source": "ACCOURU",
"Name": "ACCOMMODATIONGURUSITEMINDER"
}
]
}
Exemplo de Erro Código HTTP: 500
Response {
"Message": " Not Processed", "Warnings": [{
"Code":366,
"Message": "Error during processing, please retry",
}
]
}
PMS – Manual do Sistema 54
Package O cadastro de Pacotes possui três métodos:
Método POST, utilizado para realizar o cadastro de um Pacote.
Método PUT, utilizado para atualizar o cadastro de um Pacote.
Método DELETE, utilizado para excluir o cadastro de um Pacote. Nos métodos Post e Put deve ser utilizada a estrutura de dados a seguir. O código do hotel deve ser passado na URL.
Request URL
http://api.pms.higs.com.br/api/v1/package/{HotelCode}
Exemplo de requisição: Body
{
"Packages": [
{
"LocatorId": "1212",
"PackageCode": 12,
"RateNumber": 1,
"EventName": "PACOTE DE FÉRIAS",
"Descriptions": [
{
"Type": 1,
"language": 1,
"Text": "Cancelamento permitido até 48h antes da chegada"
}
],
"Start": "2017-11-25T00:00:00",
"End": "2017-11-25T00:00:00",
"DaysMin": 1,
"FixedPrice": "S",
"RequiredReservation": "T",
"PercentPrePayment": 0,
"DaysBeforeArrival": 0,
"DaysAfterReservationForPayment": 0,
"CompanyCode": null,
"CancellationUnit": "Day",
"UnitTimeCancellation": 1,
"Commission": 0,
"Pension": "C",
"CategoryCode": null,
"Priority": 1,
"RatePlanCode": "DD",
"Distributor": "I",
"lastupdate": "2017-12-18T00:00:00"
}
]
}
Retorno Sucesso Código HTTP: 200
Response {
"Message” : “Processed”
}
PMS – Manual do Sistema 55
Exemplo de Erro Parcial Código HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 118,
"Message": " End field is required", "LocatorID": "ABCD123"
}
]
}
Exemplo de Erro Código HTTP: 400
Response {
"Message": "Not Processed"
}
Erros do Método
Código Interno Mensagem de Erro 1357 O campo PackageCode é obrigatório
1236 O campo EventName é obrigatório
1237 O campo Descriptions é obrigatório
1117 O campo Start é obrigatório
1118 O campo End é obrigatório
1382 Este código de pacote já está cadastrado
1383 Registro inexistente para atualização
1384 Tipo de idioma inválido
1385 Tipo de descrição inválido
1386 Campo FixedPrice inválido, informe S ou N
1387 Campo RequiredReservation inválido
1388 Campo CompanyCode inválido
1389 Campo CancellationUnit inválido
1390 Informe uma Política de Cancelamento
Parâmetros URL
Parâmetro Descrição Tipo Obrigatório
HotelCode Código do Hotel. Exemplo: http://api.pms.higs.com.br/api/v1/Package/1234
Integer
PMS – Manual do Sistema 56
Parâmetros
Parâmetro Descrição Tipo Obrigatório
LocatorID Identificador do bilhete. Numeração gerada pelo requisitante.
PackageCode Código do Pacote String(04)
RateNumber Código da Tarifa String(07)
EventName Nome do Pacote String
Start Data de início do pacote Date
End Data final do pacote Date
DaysMin Número mínimo de dias Integer FixedPrice Pacote Fixo
S(im) ou N(ão) String(01)
RequiredReservation Obriga Reservas no Pacote? [T]odos, [A]gências,[C]entral de reservas, [N]ão obrigatório, [I]nternet
String(01)
PercentPrePayment Percentual de Pre-pagamento. Decimal
DaysBeforeArrival Quantidades de dias antes da chegada. Integer
DaysAfterReservationForPayment Numero de dias apos a reserva para fazer o deposito previo. Integer
CompanyCode Código SB/IT do cliente caso o pacote seja específico para uma Agência/Empresa
String
CancellationUnit Tipo de unidade DEFAULT de cancelamento Hour = HORA, Day = DIA, Week = SEMANA, A = AM, P = PM
String
UnitTimeCancellation Unidade DEFAULT de tempo para cancelamento da reserva. Integer
Commission Percentual de comissão pago para as agências Decimal
Pension Padrão de Pensão (S - Sem café / C - Com café / M - Meia pensão / A - Meia Pensão Almoço / J - Meia Pensão Jantar / I - Pensão
String(01)
CategoryCode Categoria da tarifa String
Priority Ordem de prioridade para ser mostrado o produto. Integer
RatePlanCode Rate Acess no Tars String
Distribuidor Distribuidor onde este pacote pode ser visualizado G - gds, I - internet, null ambos/todos
String(1)
Lastupdate Data de última atualização Date
PMS – Manual do Sistema 57
Descriptions
Observações do Pacote
Type Tipo de Observação
Cancelamento: 1
Compras, pagamentos ou Garantias: 2
Observação: 3
Outros Serviços: 4
Descrição: 5
Integer
Language Idioma da Observação
Português: 1
Inglês: 999
Espanhol: 3
Italiano: 4
Frances: 5
Alemão: 6
Portugal: 7
String(150)
Text Descrição String(4000)
Exclusão de Pacotes Método DELETE para exclusão de pacotes. O código do hotel deve ser passado na URL junto com o código do pacote Request URL
http://api.pms.higs.com.br/api/v1/Package/{HotelCode}?packageCode={PackageCode}
Retorno Sucesso Código HTTP: 200
Response {
"Message” : “Processed”
}
PMS – Manual do Sistema 58
Exemplo de Erro Código HTTP: 500
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 500,
"Message": "Error when deleting the Package",
}
]
}
RateAvailability A inclusão de registros no calendário de tarifas é efetuada através do Metódo Post
O código do hotel deve ser passado na URL.
Request URL
http://api.pms.higs.com.br/api/v1/RateAvailability/{HotelCode}
Exemplo de requisição: Body
{
"RateAvailability":
[
{"LocatorId": "1212",
"InitialDate": "2017-12-18T00:00:00",
"FinalDate": "2017-12-18T00:00:00",
"StatusDescription": 1,
"Status": 1,
"RoomType": "UH1",
"Rate": 1,
"RateGroup": 1
}
]
}
Retorno Sucesso Código HTTP: 200
Response {
"Message” : “Processed”
}
PMS – Manual do Sistema 59
Exemplo de Erro Parcial Código HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 1343,
"Message": " The field FinalDate is Required", "LocatorID": "ABCD123"
}
]
}
Exemplo de Erro Código HTTP: 400
Response {
"Message": "Not Processed"
}
Erros do Método
Código Interno Mensagem de Erro 1130 O campo LocatorId é obrigatório
1342 O campo InitialDate é obrigatório
1343 O campo FinalDate é obrigatório
1344 O campo StatusDescription é obrigatório
1345 O campo Status é obrigatório
1346 O campo RoomType é obrigatório
1347 A taxa do campo é necessária
1348 O campo RateGroup é obrigatório
Parâmetros URL
Parâmetro Descrição Tipo Obrigatório
HotelCode Código do Hotel. Exemplo: http://api.pms.higs.com.br/api/v1/RateAvailability /1234
Integer
PMS – Manual do Sistema 60
Parâmetros
Parâmetro Descrição Tipo Obrigatório
LocatorID Identificador do bilhete. Numeração gerada pelo requisitante.
InitialDate Data inicial do período Date
FinalDate Data final do período Date
StatusDescription Descrição do status String(60)
Status Status do calendário CalTarifa.STATUS: 1 = Tarifa está fechada CalTarifa.STATUS: 2 = Fechada para chegada CalTarifa.STATUS: 3 = Aberta para DayUse CalTarifa.STATUS: BETWEEN 4 AND 17 Mostra Status = Estada mínima a partir da Data CalTarifa.STATUS: BETWEEN 18 AND 31 = Estada mínima passando pela Data CalTarifa.STATUS: BETWEEN 32 AND 45 = Estada máxima a partir da Data CalTarifa.STATUS: BETWEEN 46 AND 59 = Estada máxima passando pela Data
Integer
RoomType Código do Quarto String(2)
Rate Código da Tarifa Integer
RateGroup Grupo de Tarifa String(01)
SendBooking O método SendBooking deve ser utilizado para efetuar o envio de reservas do PMS para o HIGS O envio de reservas deve ser através do método Post
O código do hotel deve ser passado na URL.
Request URL
http://api.pms.higs.com.br/api/v1/SendBooking/
PMS – Manual do Sistema 61
Exemplo de requisição: Body
{
"BookingList":
[
{"LocatorId": "1212",
"HotelCode": 12,
"ReservationNumberHIGS": "18774/G",
"ReservationNumberHOTEL": "1212/D",
"IsWalkin": true,
"Status": 1,
"PMSStatus": 1,
"Checkin": "2017-12-18T00:00:00",
"Checkout": "2017-12-25T00:00:00",
"ConfirmedCheckin": "2017-12-18T00:00:00",
"ConfirmedCheckout": "2017-12-18T00:00:00",
"CreationDate": "2017-12-18T00:00:00",
"LastUpdateDate": "2017-12-18T00:00:00",
"NumberOfRooms": 1,
"Guests":{
"Adults": 1,
"Children": 1,
"GuestOriginCountryCode": "RJ",
"GuestOriginStateCode": "RJ",
"GuestOriginCityName": "Rio de Janeiro"
},
"OriginalPMSRoomType": "SS",
"CurrentPMSRoomType": "UH",
"PMSRateCode": "COD05",
"PMSBlockCode": "D44",
"AllotmentCode": "N",
"MealPlanCode": 1,
"ReservationSourceCode": "GGT",
"ReservationMarketCode": "DDD",
"ReservationSubMarketCode": "FF",
"RewardProgramType": "DD",
"LoyaltyID": "FF",
"CompanyInfo":{
"CompanyId": "DD",
"CompanyName": "SSSS",
"CountryCode": "RJ",
"StateCode": "RJ",
"CityCode": "RJ"
},
"CurrencyCode": "DD",
"Rates":[
{
"EffectiveDate": "2017-12-18T00:00:00",
"Amount": 1
}
]
}
]
}
}
Retorno Sucesso Código HTTP: 200
Response {
"Message” : “Processed”
}
Exemplo de Erro Parcial Código HTTP: 206
Response
PMS – Manual do Sistema 62
{
"Message": "Partially Processed",
"Warnings": [{
"Code": 1343,
"Message": " The field FinalDate is Required", "LocatorID": "ABCD123"
}
]
}
Exemplo de Erro Código HTTP: 400
Response {
"Message": "Not Processed"
}
Erros do Método
Código Interno Mensagem de Erro 1027 O campo "CurrencyCode" é inválido
1028 O campo "CurrencyCode" é obrigatório
1029 O campo "Checkin" é obrigatório
1030 O campo "Checkout" é obrigatório
1043 O campo "IdHotel" é inválido
1057 O campo "GuestCount" é obrigatório
1090 ID de reserva do hotel inválido
1101 O campo "Rates" é obrigatório
1130 O campo LocatorId é obrigatório
1159 O campo Status é obrigatório
1164 O campo CompanyId é obrigatório.
1166 O campo CompanyName é obrigatório.
1173 O tamanho do campo CityName foi excedido.
1174 O tamanho do campo StateName foi excedido.
1175 O tamanho do campo CountryName foi excedido.
PMS – Manual do Sistema 63
Parâmetros
Parâmetro Descrição Tipo Obrigatório
LocatorID Identificador do bilhete. Numeração gerada pelo requisitante.
HotelCode Código do Hotel Integer
ReservationNumberHIGS Número da reserva no HIGS String
ReservationNumberHOTEL Número da reserva no Hotel String
IsWalkin Hospede passante Boolean
Status Status da Reserva Reservado = 1,
ReservadoComAlteracoes = 2, Cancelado = 3, CheckedIn = 4, CheckedOut = 5, NoShow = 6
Integer
PmsStatus Status da Reserva Reservado = 1,
ReservadoComAlteracoes = 2, Cancelado = 3, CheckedIn = 4, CheckedOut = 5, NoShow = 6
Integer
Checkin Data de Chegada Date
Checkout Data de partida Date
ConfirmedCheckin Data de confirmação do Checkin Date
ConfirmedCheckout
Data de confirmação do Checkout Date
CreationDate Data de criação Date
LastUpdateDate Data de última atualização Date
NumberOfRooms Número de quartos Integer
Guests Número de hóspedes Integer
Guests
Informações dos Hóspedes
PMS – Manual do Sistema 64
Adults Quantidade de adultos Integer
Children Quantidade de crianças Integer
GuestOriginCountryCode Código da Cidade de origem String
GuestOriginStateCode Código do Estado de origem String
GuestOriginCityName Nome da cidade String
OriginalPMSRoomType Room Type original no PMS String
CurrentPMSRoomType Room Type Corrente String
PMSRateCode PMS Rate Code String
PMSBlockCode Código de bloqueio no PMS String
AllotmentCode Código do Allotment String
MealPlanCode Código do plano de refeição Nenhum: 1, CafeDaManha: 2, MeiaPensaoAlmoco: 3, MeiaPensaoJantar: 4, PensaoInteira: 5, TudoIncluso: 6
Integer
ReservationSourceCode Código de origem da reserva String
ReservationMarketCode Código de Market da reserva String
ReservationSubMarketCode Código de Market da reserva String
RewardProgramType
Informações do programa de fidelidade String
LoyaltyID Código do programa de fidelidade String
CompanyInfo
Informações da Agência / Empresa
CompanyId Código da companhia String
CompanyName Nome da agência String
CountryCode Código da cidade String
StateCode Código do Estado String
CityCode Código da cidade String
CurrencyCode Código de moeda String
PMS – Manual do Sistema 65
Rates
EffectiveDate Data da efetuação da reserva que será cobrada Integer
Amount Valor a ser cobrado de acordo com o EffectiveDate Integer
PartnerList Método Get para realizar consulta de parceiros vinculados a um hotel se estão ativos ou inativos, quando o Active for false significa que o parceiro não esta habilitado para o hotel. O código do hotel deve ser passado na URL. Request URL
http://api.pms.higs.com.br/api/v1/PartnerList/{HotelCode}
Retorno Sucesso Código HTTP: 200
Response
{
"Partners": [
{
"Id": 789456,
"PartnerClient": "Rate Tiger",
"Active": false
},
{
"Id": 654123,
"PartnerClient": "AVAIL PRO",
"Active": false
},
{
"Id": 147852,
"PartnerClient": "Parceiro Omnibees",
"Active": true
}
]
}
Parâmetros
Parâmetro Descrição Tipo Obrigatório
HotelCode Código Identificador do Hotel Integer