pms system manual - api.higs.com.brapi.higs.com.br/content/doc/pms_en.pdf · 20/04/2017 v1.4...
TRANSCRIPT
PMS – System Manual 1
PMS System Manual
V3.0
PMS – System Manual 2
Histórico de Revisões Review Date Version Description Author 21/03/2017 V1.0 Document creation Patrick Melo
22/03/2017 V1.1 Settings Patrick Melo
23/03/2017 V1.2 Patch based on review Patrick Melo
24/03/2017 V1.3 Adjustment in index Patrick Melo
20/04/2017 V1.4 Correction to API calls Patrick Melo
01/06/2017 V1.5 Adjustments to the inventory method Vinicius Teixeira
11/07/2017 V1.6 Inclusion of the UH method, Rate Group and Rate Category
Vinicius Teixeira
31/08/2017 V1.7 Inclusion of Contract Methods Luciano Santos
14/09/2017 V1.8 Inclusion of the UH Group method Vinicius Teixeira
27/11/2017 V1.9 Inclusion of the Source Of Business method and Alteration in the UH method
Vinicius Teixeira
21/12/2017 V2.0 Documentation settings Vinicius Teixeira
29/12/2017 V2.1 Documentation settings Luciano Santos
09/01/2017 V2.2 Contract API Settings Vinicius Teixeira
19/01/2018 V2.3 Settings in the Start and End Tags of some methods Vinicius Teixeira
31/01/2018 V2.4 Change in the structure of the Inventory Ticket Vinicius Teixeira
23/03/2018 V2.5 Inclusion of CompanyId List and SourceOfBusiness field in Rateplan Ticket
Vinicius Teixeira
12/04/2018 V2.6 Inclusion of RateplanList method Vinicius Teixeira
18/04/2018 V2.7 Inclusion of Rateplan, Rule and RateAmount Receipt Confirmation Method
Vinicius Teixeira
04/07/2018 V2.8 Inclusion of the Method for Bringing Partners Luis Felipe
10/07/2018 V2.9 Inclusion of a Partner List on the RatePlan ticket Luis Felipe
06/08/2018 V3.0 Add Billing and cancellation elements to Rateplan Luis Felipe
PMS – System Manual 3
Index
Sumário Overview .............................................................................................................................................................. 4
Authentication ...................................................................................................................................................... 4
Language .............................................................................................................................................................. 4
Compression......................................................................................................................................................... 5
Partial Shipping ..................................................................................................................................................... 5
Rules for receipt of ticket ..................................................................................................................................... 5
Methods ............................................................................................................................................................... 6
Availability ....................................................................................................................................................... 6
Inventory.......................................................................................................................................................... 9
RateAmount ................................................................................................................................................... 11
RatePlan ......................................................................................................................................................... 15
RatePlan List ................................................................................................................................................... 18
Rule ................................................................................................................................................................ 20
Reservations Download .................................................................................................................................. 23
Reservations Confirmation ............................................................................................................................. 29
Rate ............................................................................................................................................................... 30
UHGroup ........................................................................................................................................................ 36
UH Registration .............................................................................................................................................. 38
RateGroup ...................................................................................................................................................... 41
RateCategory ................................................................................................................................................. 44
Contract ......................................................................................................................................................... 46
Source Of Business ......................................................................................................................................... 52
Package .......................................................................................................................................................... 53
RateAvailability .............................................................................................................................................. 57
SendBooking .................................................................................................................................................. 59
PartnerList...................................................................................................................................................... 64
PMS – System Manual 4
Overview
Dear Partner,
This document aims to clarify all the procedures of how to consume via REST the resources of the HIGS PMS API through HTTP methods.
All HTTP methods that provide the features required for integration are detailed below.
Authentication In order to have access to the HIGS API, it is necessary to have an unlocked Token Client and Token Application, which are received after hiring our service. The two parameters must be entered in the Header with their respective values. In all requests the use of tokens is mandatory. Example:
Headers token-client: 54f11ad4ae0d17744fa33d99
token-application: 19A322AF-BF7C-4652-87A9-DF5BA91963F7
Content-Type: application/json;
Language The language of return of the messages of the system can be chosen through the parameter Accept-Language that must be inserted in the header. Available languages: en-US and pt-BR. Note: In the absence of the Accept-Language parameter, the language returned will be pt-BR. Example:
Headers token-client: 54f11ad4ae0d17744fa33d99
token-application: 19A322AF-BF7C-4652-87A9-DF5BA91963F7
Content-Type: application/json;
charset=utf-8
Accept-Language: en-US
PMS – System Manual 5
Compression All requests must be sent in a compressed Gzip format. For this, it should be placed in the header the Accept-Encoding Tag to perform the compression:
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
Partial Shipping All methods, other than Download Reservations, may have full or partial processing. This means that an availability block, LocatorID, does not interfere with another.
Rules for receipt of tickets All methods, except the Download Reservations, can receive up to 10 tickets per request, the Inventory method, in addition to the 10 tickets, each can have a maximum of 366 days.
PMS – System Manual 6
Methods Availability Allotments POST Method. They are physical availability of UHs dedicated exclusively to a client. The hotel code must be passed in the URL. Request URL
http://api.pms.higs.com.br/api/v1/Allotment/{HotelCode}
Request example: Body
{
"Allotments":
[
{
"LocatorID": "ABCD123",
"BookingLimit": 10,
"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
}
},
{
"LocatorID": "ABCD456",
"BookingLimit": 20,
"StatusApplicationControl":
{
"Start": "2016-01-01",
"End": "2017-12-31",
"RatePlanCode": "XPTO2",
"InvTypeCode": "STD",
"Mon": 1,
"Tue": 1,
"Wed": 1,
"Thu": 1,
"Fri": 0,
"Sat": 0,
"Sun": 1
}
}
]
}
Return Success Code HTTP: 200
Response {
"Message” : “Processed”
}
PMS – System Manual 7
Partial Error Example Code HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 9999,
"Message": "Invalid field StatusApplicationControl",
"LocatorID": "ABCD456"
}
]
}
Error Example Code HTTP: 400
Response {
"Message": "Not Processed",
}
Method Errors Internal code Error message
15 Invalid date
145 Period or dates incorrect
1058 The RatePlanCode field is required
1117 Start field is required
1118 End field is required
1125 The BookingLimit field is invalid
1126 BookingLimit field is required 1127 The InvTypeCode field is required
1131 The Mon field is required
1133 The Tue field is required.
1134 The Wed field is required
1135 Thu field is required
1136 The Fri field is required
1137 The Sat field is required
1138 Sun field is required
1142 Mon field is invalid
1143 The field Tue is invalid
1144 The Wed field is invalid
1145 Field Thu is invalid
1146 The Fri field is invalid
1147 Sat field is invalid
1148 The Sun field is invalid
1151 The StatusApplication field is required
PMS – System Manual 8
URL Parameters
Parameter Description Kind Required
HotelCode Hotel code. Exemple: http://api.pms.higs.com.br/api/v1/Allotment/1234
Integer X
Parameters
Parameter Description Kind Required
Allotments List of tickets to update. Array X
LocatorId Ticket item identifier. Numbering generated by the requester.
String X
BookingLimit Available quantity of accommodation in the period informed for the contract.
Integer X
StatusApplicationControl
Guest name and address information set.
Object
X
RatePlanCode Tariff plan code for the period. String X
InvTypeCode Accommodation Type Code String X
Start Start date of the period yyyy-MM-dd X
End
End date of the period yyyy-MM-dd X
Mon
If marked with 1, only enables the day of the week Integer X
Tue
If marked with 1, only enables the day of the week Integer X
Wed
If marked with 1, only enables the day of the week Integer X
Thu
If marked with 1, only enables the day of the week Integer X
Fri
If marked with 1, only enables the day of the week Integer X
Sat
If marked with 1, only enables the day of the week Integer X
Sun
If marked with 1, only enables the day of the week Integer X
PMS – System Manual 9
Inventory POST method for sending inventory. The hotel code must be passed in the URL. Request URL
http://api.pms.higs.com.br/api/v1/Inventory/{HotelCode}
Request example: Body
{
"Inventories":
[
{
"ActionType": "Allocation",
"Start": "2017-08-25",
"End": "2017-08-26",
"StatusApplicationControl":
[
{
"InvTypeCode": "A123",
"LocatorID": "1",
"Count": 64
}
]
}
]
}
Return Success Code HTTP: 200
Response {
"Message” : “Processed”
}
Partial Error Example Code HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 145,
"Message": "Duration period or dates incorrect",
"LocatorID": "ABCD123"
}
]
}
PMS – System Manual 10
Error Example Code HTTP: 400
Response {
"Message": "Not Processed",
}
Method Errors Internal code Error message
15 Invalid date
145 Period or dates incorrect
1095 No inventory information
1117 Start field is required
1117 Start field is required
1118 End field is required
1118 End field is required
1125 Actiontype field is invalid 1126 Inventories required
1127 The InvTypeCode field is required
1128 Count field is required
1129 Hotel code is required
1130 The LocatorId field is required
Parameters URL
Parameter Description Kind Required
HotelCode Hotel code. Example: http://api.pms.higs.com.br/api/v1/Inventory/1234
Integer X
Parameters Parameter Description Kind Required
Start Start date of the period
yyyy-MM-dd X
End
End date of the period yyyy-MM-dd X
ActionType Type of ticket being sent Example: Allocation
String X
StatusApplicationControl
List of tickets to update. Array X
InvTypeCode Accommodation Type Code
String X
LocatorID Ticket identifier. Numbering generated by the requester.
String(30) X
Count Number of rooms available Integer X
PMS – System Manual 11
RateAmount POST method for sending prices. The hotel code must be passed in the URL.
Request URL
http://api.pms.higs.com.br/api/v1/RateAmount/{HotelCode}
Request example: Body
{
"RateAmountItems" :
[
{
"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 },
PMS – System Manual 12
{ "AgeQualifyingCode": 10, "NumberOfGuests": 3, "AmountAfterTax": 140.00 },
{ "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 }
]
}
]
}
Return Success Code HTTP: 200
Response {
"Message” : “Processed”
}
Partial Error Example Code HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 145,
"Message": "Duration period or dates incorrect",
"LocatorID": "ABCD123"
}
]
}
Error Example Code HTTP: 400
Response {
"Message": "Not Processed"
}
PMS – System Manual 13
Method Errors
Internal code Error message 145 Period or dates incorrect
367 Invalid format 1058 The RatePlanCode field is required
1099 Amount field is required
1117 Start field is required
1117 Start field is required
1118 End field is required
1118 End field is required
1127 The InvTypeCode field is required
1129 Hotel code is required
1130 The LocatorId field is required
1131 The Mon field is required
1133 The Tue field is required.
1134 The Wed field is required
1135 Thu field is required
1136 The Fri field is required
1137 The Sat field is required
1138 Sun field is required
1140 AgeQualifyingCode field is required
1141 The AmountAfterTax field is required
1142 Mon field is invalid 1143 The field Tue is invalid
1144 The Wed field is invalid
1145 Field Thu is invalid
1146 The Fri field is invalid
1147 Sat field is invalid
1148 The Sun field is invalid
1149 AgeQualifyingCode field is invalid
1151 The StatusApplicationControl field is required
1178 The RateAmountItems field is required
1179 Rate field is required
URL Parameters
Parameter Description Kind Required
HotelCode Hotel code. Example: http://api.pms.higs.com.br/api/v1/RateAmount/1234
Integer X
PMS – System Manual 14
Parameters
Parameter Description Kind Required RateAmountItems
List of tickets to update. Array X
LocatorID Ticket identifier. Numbering generated by the requester.
String(30) X
StatusApplicationControl
Object X
Start Start date of the period
yyyy-MM-dd X
End
End date of the period
yyyy-MM-dd X
RatePlanCode
Tariff plan code String X
InvTypeCode
Accommodation Type Code String X
Mon
If set to 1, only enables the day of the week. Integer X
Tue
If set to 1, only enables the day of the week. Integer X
Wed
If set to 1, only enables the day of the week. Integer X
Thu
If set to 1, only enables the day of the week. Integer X
Fri
If set to 1, only enables the day of the week. Integer X
Sat
If set to 1, only enables the day of the week. Integer X
Sun
If set to 1, only enables the day of the week. Integer X
Rate Rate Information Object X
BaseByGuestAmts Value per number of guests Object X
AgeQualifyingCode
Code identifying the type of accompanying person. 10 - Adult; 8 - Child; 6 - Child up to 2 years
Integer X
NumberOfGuests
Number of guests Integer X
AmountAfterTax
Value without fees Decimal X
AdditionalGuestAmounts
Additional guest tariff information Object X
AgeQualifyingCode
Identifier code Integer X
Amount
Value Decimal X
PMS – System Manual 15
RatePlan POST method for sending the Tariff Plan. The hotel code must be passed in the URL. Request URL
http://api.pms.higs.com.br/api/v1/Rateplan/{HotelCode}
Request example:
Body {
"RatePlans": [
{
"LocatorID": "88888",
"RatePlanCode": "XPT01",
"IsNew":true,
"Active":true,
"BillingPolicy":"Lorem ipsum dolor sit amet...",
"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 – System Manual 16
}
Return Success Code HTTP: 200
Response {
"Message” : “Processed”
}
Partial Error Example Code HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 145,
"Message": "Duration period or dates incorrect",
"LocatorID": "ABCD123"
}
]
}
Error Example Code HTTP: 400
Response {
"Message": "Not Processed",
}
Method Errors Internal code Error message
15 Invalid date
367 Invalid format
1027 CurrencyCode field is invalid
1058 The RatePlanCode field is required
1085 Invalid RoomType
1117 Start field is required 1118 End field is required
1119 CurrencyCode field is required
1120 The IsCommissionable field is required
1121 The MealsIncluded field is required
1122 The SellableProduct field is required
1123 The MealPlanIndicator field is required
1124 The MealPlanCode field is required
1129 Hotel code is required
1130 The LocatorId field is required
1402 Record inserted, but SourceIndex's CompanyIds list is duplicate and will not be entered.
1403 IdClient Partner is not active for distribution
1404 Invalid Partner List, check the distribution permissions.
PMS – System Manual 17
URL Parameters Parameter Description Kind Required
HotelCode Hotel code. Example: http://api.pms.higs.com.br/api/v1/Rateplan/1234
Integer
Parameters
Parameter Description Kind Required RatePlans
List of tickets to update. Array
LocatorID Ticket identifier. Numbering generated by the requester.
String(30)
RatePlanCode Tariff plan code String IsNew Identify whether the element is New Boolean Active Identifies whether the elemento is Active Boolean BillingPolicy Text with Billing Policy String BeforeArrival
Billing Information
Object
TimeUnit
Billing Default unit type for Post (Day, Hour, Minute, Month , Week). For Reading(Day = 0, Hour =1, Minute =2, Week = 3, Month = 4)
String
Value Default unit of time for reservation billing Integer CancellationPolicy
Cancellation Information
Object
TimeUnit
Billing Default unit type for Post (Day, Hour, Minute, Month , Week). For Reading(Day = 0, Hour =1, Minute =2, Week = 3, Month = 4)
String
Value Default unit of time for cancellation Integer ListOfSource
Lista de Origens List
SouceOfBusiness Source Of Business Code String ListCompanyId List of CompanyIds List CompanyId CompanyIds String Start Start date of the period
yyyy-MM-dd
End
End date of the period yyyy-MM-dd
CurrencyCode Currency code with ISO 4217 standard. ISO 4217 is an international standard that defines three-letter codes for currencies.
String Example: "CurrencyCode": "BRL"
IsCommissionable
Field that informs if Rateplan is commissioned
Boolean
TypeComission
If IsCommissionable is true this field becomes Required (TypeComission)
Nome = 0, Amount = 1, Percent = 2
Integer
ValueComission
If IsCommissionable is true this field becomes Required (Commission Value)
decimal
PMS – System Manual 18
MealsIncluded
Meals included Object
MealPlanIndicator
Indicates whether it contains meal Boolean
MealPlanCodes
Meal code Integer
SellableProduct
Products for sale Array
RoomTypeCode
RoomType Code String
Name
Tariff plan name String
Description
Description of the tariff plan String
Partners Partners linked to Hotel Array
PMS – System Manual 19
Rateplan List The Api Rateplan List is composed of 2 methods. • GET method for listing the information registered in the system. • Post method to confirm receipt of information In the Get method we will display the information that encompasses Rateplan, Rule, and Rate Amount Request URL
http://api.pms.higs.com.br/api/v1/RateplanList/{HotelCode}?RatePlanCode={RatePlanCode *optional*}
Using the optional parameter will list all the information of RateplanCode informed, this includes Rules and Rate Amount. Example response:
Body {
"RateplanList": [{
"RatePlan": [{
"ID": "cfdf2160-7353-40af-8a7f-164b0a4b3e65",
"RatePlanCode": "XPT01",
"ListOfSource": [{
"SourceOfBusiness": "BOOKING",
"ListCompanyID": [{
"CompanyId": "123"
},
{
"CompanyId": "12g3"
}]
}],
"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,
PMS – System Manual 20
"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"
}]
}]
}]
}
In the Post method we will receive the ID code, separated by ticket type, Rateplan, Rule or Rate Amount. Request URL
http://api.pms.higs.com.br/api/v1/RatePlanList/{HotelCode}
PMS – System Manual 21
Example Answer:
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"
]
}
]
}
Return Success Code HTTP: 200
Response {
"Message” : “Processed”
}
Rule Description POST method for sending tariff restrictions. They impose rules with minimum and maximum overnight rates in certain tariff plans. The hotel code must be passed in the URL. Request URL
http://api.pms.higs.com.br/api/v1/Rule/{HotelCode}
Request example:
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
},
"RestrictionStatus": {
PMS – System Manual 22
"RestrictionType": "Master",
"Status": "Open"
},
"LengthsOfStay": [
{
"TimeUnit": "Day",
"Time": 1,
"MinMaxMessageType": "SetMinLOS"
}
]
}
]
}
Return Success Code HTTP: 200
Response {
"Message” : “Processed”
}
Partial Error Example Code HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 145,
"Message": "Duration period or dates incorrect",
"LocatorID": "ABCD123"
}
]
}
Error Example Code HTTP: 400
Response {
"Message": "Not Processed",
}
Method Errors Internal code Error message
15 Invalid date
367 Invalid format
1058 The RatePlanCode field is required
1117 Start field is required
1118 End field is required
1127 The InvTypeCode field is required
1129 Hotel code is required
1130 The LocatorId field is required
1131 The Mon field is required
1133 The Tue field is required
1134 The Wed field is required
1135 Thu field is required
PMS – System Manual 23
1136 The Fri field is required
1137 The Sat field is required
1138 Sun field is required
1150 RuleMessages field is required
1151 The StatusApplicationControl field is required
1152 The BookingRules field is required
1153 LengthsOfStay field is required
1154 The RestrictionStatus field is required.
1155 TimeUnit field is required
1156 Time field is required
1157 MinMaxMessageType field is required
1158 RestrictionType field is required
1159 The Status field is required
1160 LengthsOfStay field is invalid
1161 Restriction field is invalid
URL Parameters
Parameter Description Kind Required HotelCode Hotel code.
Example: http://api.pms.higs.com.br/api/v1/Rule/1234
Integer X
Parameters
Parameter Description Kind Required
RuleMessages
List of tickets to update. Array X
LocatorID Ticket identifier. Numbering generated by the requester.
String(30) X
StatusApplicationControl
Aimed at controlling information Object X
RatePlanCode
Rateplan Code String X
InvTypeCode
Accommodation Type Code String X
Mon
If marked with 1, only enables the day of the week. Integer X
Tue
If marked with 1, only enables the day of the week Integer X
Wed
If marked with 1, only enables the day of the week Integer X
Thu
If marked with 1, only enables the day of the week Integer X
Fri
If marked with 1, only enables the day of the week Integer X
Sat
If marked with 1, only enables the day of the week Integer X
Sun
If marked with 1, only enables the day of the week Integer X
BookingRules Accommodation Type Code
String X
Start Start date of the period
yyyy-MM-dd X
PMS – System Manual 24
End
End date of the period yyyy-MM-dd X
LengthsOfStay
Field relating to the period of stay Array X
TimeUnit
Unit of time Currently only receives the parameter "Day"
String X
Time
Quantity in time relative to time unit Integer X
MinMaxMessageType
Message field String X
RestrictionStatus
Rule field Array X
RestrictionType
Field intended for the type of restriction String X
Status
Status relative to type of restriction String X
Reservations Download POST method for receipt of reservations. Request URL
http://api.pms.higs.com.br/api/v1/ReservationDownload
Request example: Body
{
"SelectionCriteria": {
"HotelCode": "12345"
}
}
Return Success Code 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 – System Manual 25
25T00:00:00\",\"Amount\":163.5},{\"EffectiveDate\":\"2016-11-
26T00:00:00\",\"Amount\":163.5}],\"TotalAmountBeforeTax\":811.5,\"CurrencyCode\":\"BRL\",\"CompanyInfo\":
null}"
}
]
}
If the request does not return data, the return will only display a message stating that the request has been processed successfully.
Response {
"Message” : “Processed”
}
Error Example Code HTTP: 400
Response {
"Message": "Not Processed",
}
Method Errors Internal code Error message
1129 Hotel code is required
Parameters Parameter Description Kind Required
SelectionCriteria
Inventory Information Array Object X
HotelCode Hotel Code Example: "HotelCode": "12345"
String X
Request Field Structure
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": [
PMS – System Manual 26
{
"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"
},
"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"
}
Request Parameters
Parameter Description Kind Required
CreatorId Partner Name. Example: "CreatorId": "CRS HIGS"
String
SourceOfBusiness Source code of the reservation. This field is used to relate Roomtypes and RatePlans. Source list is available on the link http://api.higs.com.br/ Example: "SourceOfBusiness": "BOOKING"
String(07)
IdHotel Code of identification of the Hotel at Higs. Example: "IdHotel": 012345
Integer
Checkin Date of arrival of the Guest. Example: "Checkin": "2016-10-29"
String(10) (yyyy-MM-dd)
Checkout Departure date of the Guest. Example: "Checkin": "2016-10-30"
String(10) (yyyy-MM-dd)
PMS – System Manual 27
DateTimeInclusion Date and time of inclusion of the Reserve in the integrator. Example: "DateTimeInclusion": "2016-10-03T17:59:50"
String(19) (yyyy-MM-ddThh:mm:ss)
GuestCount Total amount of adult guests. Example: "GuestCount": 2
Integer
NumberChildren Total number of guests children. Example: "NumberChildren": 1
Integer
MainGuest
Guest name and address information set.
GivenName Guest name. Example: "GivenName": "Manoel"
String(30)
Surename Surname of the guest. Example: "Surename": "da Silva"
String(30)
Telephone Phone number of the guest. Example: "Telephone": "(21) 9999 9999"
String(20)
Address
Guest address information set
AdressLine Guest address. Example: "AdressLine": "Av. Principal, n° 500"
String(70)
CityName City of the guest. Example: "CityName": "Campinas"
String(255)
StateProv State of residence of the guest. Example: "StateProv": "São Paulo"
String(255)
ZipCode Residence code of the guest. Example: "ZipCode": "20500-001"
String(12)
CountryName Country of residence of the guest. Example: "CountryName": "Brasil"
String(255)
Email E-mail of the guest or the person in charge of the reservation. Example: "Email": "[email protected]"
String(50)
Guests
Accompanying guest information set.
* Up to 03 guests.
GivenName First Name of the accompanying guest. Example: "GivenName": "Estela Valdez"
String(30)
PMS – System Manual 28
LastName Last name of the accompanying guest. Example: "LastName": "Garcia"
String(30)
Comment Notes and notes about the reservation. Example: "Comment": "Booking Modify text"
String[1400]
TypePayment Payment Type Identification: 1 - Credit Card 2 - Hotel Direct 3 - Company billing Example: "TypePayment": 2
Integer
TypeInvoice List of payment types billed to the company. Used only when the TypePayment = 3 (Invoice) Available Options: Ty = All expenses without alcoholic beverages Tt = All expenses Tx = Rates An = Food and non-alcoholic beverages Di = Daily Cf = Breakfast Tl = Phone calls Tu = Tourism fees Bu = Frigobar Fb = Frigobar Lv = Laundry * Minimum of 01 and maximum of 05 types are accepted. Example: "TypeInvoice": ["Ty","Tx","An","Tl","Tu"]
Array[string]
CreditCardData Set of Credit Card information. Populated only when the TypePayment = 1 field (Credit Card). In all other cases the fields related to the set of credit card information do not need to be reported.
Flag Credit card banner. List of flags: GC - Good Card VI - Visa IK - Mastercard DC - Diners Club AX - American Express EL-ELO DS - Discover EV - Expedia Virtual Card Example: "Flag": "VI"
String(02)
Name Name printed on credit card. Example: "Name": "MANOEL SILVA"
String(30)
CardNumber Credit card number.
String(24)
PMS – System Manual 29
Example: "CardNumber": "4444333322221111"
SecurityCode Credit card security code. Example: "SecurityCode": "123"
String(08)
Expiration Expiration date of the credit card in the format (mm / yy). Example: "Expiration": "10/22"
String(05) (MM/yy)
RatePlanCode Code identifier of Rate Plan. Example: "RatePlanCode": 20160101
String(64)
Commission
Value of the commission for the contract associated with the partner. If the contract associated with RateplanCode obeys some commissioning rule the field will obey the following rules: - For Commissioned Contracts: (required) "Commission": 25 - For Non-Commissioned Contracts: (required) "Commission": 0 - For indifferent contracts: * It is not necessary to include the field in the ticket
Integer
RoomTypeCode Integrator Roomtype identifier code. It is necessary for the hotel to previously perform Roomtypes correlation in HIGS. Example: "RoomTypeCode": 201602
String(64)
HotelReservationIds
List of hotels where the reservation is being made.
HotelReservationNumber Identification number of the reserve in the integrator. Example: "HotelReservationNumber": "131362840"
String(30)
TypeReservation Código identificador do tipo da reserva no integrador. Example: "TypeReservation": 1
Integer
Taxes
List of fee information.
CodeTax HIGS rate identification code. List of fee codes: 1 - Service charge 2 - Service tax 3 - Tourist tax 4 - Ecological Fee 5 - Circulation Tax 6 - Aggregate Tax 18 - Food & beverage 28 - Juiz de Fora Tax
Integer
PMS – System Manual 30
Example: "CodeTax": 2
Value Daily value. Example: "Value": 20.50
Number(12,2)
Description Description of fees and taxes. Example: "Description": "ISS"
String(50)
Rates List of information of the day-to-day values of the reservation.
EffectiveDate Date of collection. (Yyyy-mm-dd) Example: "EffectiveDate": "2016-10-29
String(10) (yyyy-MM-dd)
Amount Daily value. Example: "Amount": 190.20
Number(16,2)
TotalAmountBeforeTax Total amount of reservation without taxes and fees. Example: "TotalAmountBeforeTax": 190.20
Number(16,2)
CurrencyCode Currency code used when booking. ISO 4207 standard code. Example: "CurrencyCode": "BRL"
String(03)
Reservation Confirmation POST method to confirm receipt of reservations. The number that must be informed for confirmation of receipt of the reservation is the ReservationNumber, it appears on the Reservation Download API response ticket.
Request URL
http://api.pms.higs.com.br/api/v1/BookingConfirmation
Request example:
Body {
"HotelCode": 2125,
"HotelReservationIds": [
{
"HigsReservationNumber": 1233447
"HotelReservationNumber": 8999512
}
]
}
Return Success Code HTTP: 200
PMS – System Manual 31
Response {
"Message” : “Processed”
}
Error Example Code HTTP: 400
Response {
"Message": "Not Processed"
}
Method Errors
Internal code Error message
1399 Reservation not found
1400 Reservation already confirmed
Rate Inclusion of tariff The cadastre of Tariffs has three methods:
POST method, used to register a Rate Category.
PUT method, used to update the registration of a Rate Category.
DELETE method, used to exclude the registration of a Tariff Group In the Post and Put methods the following data structure must be used.
The hotel code must be passed in the URL.
Request URL
http://api.pms.higs.com.br/api/v1/Rate/{HotelCode}
Request example: 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",
PMS – System Manual 32
"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",
"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
}
]
}
]
}
Return Success Code HTTP: 200
Response {
"Message” : “Processed”
}
PMS – System Manual 33
Partial Error Example Code HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 145,
"Message": "Duration period or dates incorrect",
"LocatorID": "ABCD123"
}
]
}
Error Example Code HTTP: 400
Response {
"Message": "Not Processed"
}
URL Parameters
Parameter Description Kind Required
HotelCode Hotel code. Example: http://api.pms.higs.com.br/api/v1/Rate/1234
Integer
Parameters
Parameter Description Kind Required
LocatorID Ticket identifier. Numbering generated by the requester. String(30)
HotelCode Hotel code
HotelID Hotel ID
RateNumber Rate number
RateName Rate Name
CurrencyISOCode ISO currency code
QttChildrenFree Number of children Free in the first track
QttChildrenFree1 Number of children Free in the second track
PercentageDiscountChildren Percentage discount for children in the first track
PMS – System Manual 34
PercentageDiscountChildren1 Child discount percentage on second track
RateExpirationDateInitial Tariff expiration date
RateExpirationDateFinal Tariff expiration date
IncludedCoffee Standard of Pension (S - Without coffee / C - With coffee / M - Half board / A - Half Board Lunch / J - Half Board Dinner / I - Full Board / T - All-Inclusive)
NCancel Quantity related to CCANCELA
CCancel Type of cancellation (H - Hours before arrival / D - Days before arrival / W - Weeks before arrival / A - Hours of day of arrival (morning) / P - Hours of day of arrival (afternoon))
PrepaymentPercent Percentage of prepayment
DaysToArrival Days of Arrival
DaysAfterRequestReservation Days after Request for Reservation
Commission Percentage of commission paid
CategoryCode Category Code
IDRateGroup Rate group Id
AcceptRateCalc If the tariff is managed through the tariff schedule = 1 if not = 0
Frequency Frequency of launching tariffs on the host account
MinimumStay Minimum stay
MaximumStay Maximum stay
WeekendDays Days to valid the special arrival rate 7- Sun, 1-Mon, 2 Tues, etc.
CloseToArrival Fechado para chegada 7- Dom, 1- Seg,2 Ter, etc.
PriorityOrder Indicates the order in which the tariffs will be listed in the service screen of the Reservation Center.
IDEmployee Employee ID that included / changed the registry
TaxesServiceIncluded Service Fee Included: S / N
TaxesIncluded Tax Included: S / N
PMS – System Manual 35
IDRate Rate Id
RateplanCode RatePlan Code
RateValues
TPA_UHType Type of UH
Value1GuestRate 1 pax rate
Value2GuestRate Value of 2 pax in the rate
Value3GuestRate Value of 3 pax in the rate
Value4GuestRate Value of 4 pax in the rate
Value5GuestRate Value of 5 pax in the rate
ValueAdditionalInRate Value of additional in rate
RateType Rate Type N-Normal E-Special
AdultFullPensionValue Whole Adult Pension Value
AdultHalfPensionValue Pension Amount Adult half
AdultHalfCoffeeValue Value of Coffee Adult half
ChildFullPensionRange1 Amount of Pension Whole child track 1
ChildFullPensionRange2 Amount of Full Board Child's Sleep 2
ChildHalfPension1 Pension Amount half child track 1
ChildHalfPension2 Pension Amount half child track 2
ChildCoffeeValue1 Pension Amount coffee child track 1
ChildCoffeeValue2 Pension Amount coffee child track 2
FixedValueChild1 Fixed value of child 1
FixedValueChild2 Fixed value of child 2
AdultAllIncludedValue All-Inclusive Adult Breakfast
PMS – System Manual 36
ChildAllIncludedValue1 Value child 1 all inclusive.
ChildAllIncludedValue2 Value child 2 all inclusive.
PensionRates
PensionCode Standard of Pension (S - Without coffee / C - With coffee / M -
Half board / A - Half Board Lunch / J - Half Board Dinner / I -
Full Board / T - All-Inclusive)
GuestType Type of Pax: 0 = adult 1 = child 1 2 = child 2
SpecialFlag Indicates if it is special rate.
Value1Guest Value for 1 pax.
Value2Guest Value for 2 pax.
Value3Guest Value for 3 pax.
Value4Guest Value for 4 pax.
ValueGuestAdditional Additional Pax Value.
Rate exclusion DELETE method to Exclude Rates. The hotel code must be passed in the URL. Request URL
http://api.pms.higs.com.br/api/v1/Rate/{HotelCode}?codRate={RateCode}
Return Success Code HTTP: 200
Response {
"Message” : “Processed”
}
Error Example Code HTTP: 500
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 500,
"Message": "Error when deleting the Rate"
}
]
}
PMS – System Manual 37
UHGroup The UH Group registry has three methods
POST method, used to perform the registration of a UH Group
PUT method, used to update the registration of a UH Group
DELETE method, used to exclude the registration of a UH Group. In the Post and Put methods, the following data structure must be used. The hotel code must be passed in the URL. Request URL
http://api.pms.higs.com.br/api/v1/UhGroup/{HotelCode}
Request example:
Body {
"UhGroup": [
{
"LocatorId": "123",
"UhGroupCode": "A12",
"UhGroupDescription": " UH GROUP OF TEST " }
]
}
Return Success Code HTTP: 200
Response {
"Message” : “Processed”
}
Partial Error Example Code HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 1360,
"Message": " The UhGroupCode field is required ", "LocatorID": "1234"
}
]
}
PMS – System Manual 38
DELETE method Request URL
http://api.pms.higs.com.br/api/v1/UhGroup/{HotelCode}?codUhGroup={UhGroupCod}
Error Example Code HTTP: 400
Response {
"Message": "Not Processed",
}
Method Errors
Internal code Error message 1360 The UhGroupCode field is required
1361 The size of the UhGroupCode field (03 characters) has been exceeded
1362 The UhGroupDescription field is required
1363 The size of the UhGroupDescription field (60 characters) has been exceeded.
1364 This UH Group is already registered
1365 This UH Group does not exist
URL Parameters
Parameter Description Kind Required
HotelCode Hotel code. Example: http://api.pms.higs.com.br/api/v1/uhgroup/1234
Integer X
Parameters Parameter Description Kind Required
UhGroup List of tickets to update. Array X
LocatorId Ticket item identifier. Numbering generated by the requester.
String X
UhGroupCode UH Group Code String X
UhGroupDescription Description of UH Group String(60) X
PMS – System Manual 39
UH registration POST method to be performed the registration of a UH. The hotel code must be passed in the URL. Request URL
http://api.pms.higs.com.br/api/v1/UH/{HotelCode}
Request example:
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,
"IdBedsType2": 0,
"QttBedsType3": null,
"IdBedsType3": 0,
"IdViewType1": 1,
"IdViewType2": null,
"IdLocationUHType1": 10,
"IdLocationUHType2": 0,
"IdTypeQualityUH": 1,
"DistributorCode": "S2U",
"QttAdultsUH": 2,
"QttChildrenUH": 1,
"Shared": "S"
}
]
}
Return Success Code HTTP: 201
Response {
"Message” : “Processed”
}
PMS – System Manual 40
Partial Error Example Code HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 1204,
"Message": " The IdLocalizacaoUHTipo1 field is required", "LocatorID": "1234"
}
]
}
Error Example Code HTTP: 400
Response {
"Message": "Not Processed",
}
Method Errors
Internal code Error message 392 Invalid hotel code
1130 The LocatorId field is required
1195 The field UHDescription is required
1196 The UHType field is required
1197 The IdBedsType1 field is required
1198 The QttBedsType1 field is required
1199 The QttBedsType2 field is invalid
1200 The IdBedsType2 field is invalid
1201 The QttBedsType3 field is invalid
1202 The field IdBedsType3 is invalid 1203 The IdViewType2 field is invalid
1204 The IdLocationUHType1 field is required’
1205 The IdLocationUHType2 field is invalid
1206 The field IdTypeUH is invalid
1207 The DistributorCode field is required
1208 The IdGroupUH field is invalid
1210 This IdViewType1 is already registered
1215 The PeopleAmount field is required
1216 The field IdTypeQualityUH is required
1217 The field QttAdultsUH is required
1218 The field TotalUHsHotel is required
1233 Number of records not allowed in the IdTypeUH field
1234 Number of records not allowed in comment field
1368 Error when informing if UH is shared, inform "S" or "N"
1395 Non-existent Record for Exclusion
1397 UH code already registered in the informed Hotel
1398 Informed IdGrupoUH is not registered
PMS – System Manual 41
URL Parameters
Parameter Description Kind Required
HotelCode Hotel code. Example: http://api.pms.higs.com.br/api/v1/UH/1234
Integer X
Parameters
Parameter Description Kind Required
LocatorId List of tickets to update.
Array
UHType Uh type
String
IdTypeUH Type of room
String(4)
IdGroupUH Room Group Code
String
UHDescription Description of UH
String(60)
PeopleAmount Maximum of people Allowed in Room
Integer
CommentPT Description of the Room in Portuguese
String (2.500)
CommentEN Description of Room in English
String (2.500)
CommentES Description of Room in Spanish
String (2.500)
AvailableStdQtt Default amount of availability.
Integer (3)
PercentAvailableCmnet Percentage of hotel availability to be applied to CMNet
Integer (3)
TotalUHsHotel Total number of uhs of this type in the hotel
Integer(4)
SmokingRoom Smoking room Smoker - F Non-Smoking - N Both - A
String(1)
BathroomType WC Private - P Shared - C
Integer
QttBedsType1 Number of beds of the 1st type
Integer
IdBedsType1 1st bed type ID
Integer
QttBedsType2 Number of beds of the second type
Integer
IdBedsType2 2nd bed type ID
Integer
QttBedsType3 Number of beds of 3rd type
Integer
IdBedsType3 3rd bed type ID
Integer
IdViewType1 1º Type of view in TABTIPOVISTA
Integer
IdViewType2 2º Type of view in TABTIPOVISTA
Integer
IdLocationUHType1 1º Type of room of the room in TABTIPOLOCALUH Integer
PMS – System Manual 42
IdLocationUHType2 2º Room Type of Room in TABTIPOLOCALUH
Integer
IdTypeQualityUH Type of room quality
Integer
DistributorCode Distributor Room code
String(10)
QttAdultsUH Maximum number of adults in the room
Integer
QttChildrenUH Maximum number of children in the room
Integer
Shared Room Shared S – Yes N - No
String
Delete UH DELETE method to exclude UH registration The hotel code and UH code must be passed in the URL. Request URL
http://api.pms.higs.com.br/api/v1/UH/{HotelCode}?UHType={UHType}
RateGroup The registration of Rates has three methods
• POST method, used to register a Rate Group. • PUT method, used to update the registration of a Tariff Group. • DELETE method, used to exclude the registration of a Tariff Group.
In the Post and Put methods the following data structure must be used. The hotel code must be passed in the URL.
Insert / Update Rate group Request URL
http://api.pms.higs.com.br/api/v1/RateGroup/{HotelCode}
Request example:
Body {
"RateGroups":
[
{
"LocatorId": "1234",
"RateGroupCode": "XX1",
PMS – System Manual 43
"RateGroupDescription": "Grupo Tarifas Teste API 01"
},
{
"LocatorId": "abcd",
"RateGroupCode": "XX2",
"RateGroupDescription": "Grupo Tarifas Teste API ab"
}
]
}
Return Success Code HTTP: 200
Response {
"Message” : “Processed”
}
Partial Error Example Code HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 1221,
"Message": " O campo RateGroupCode é obrigatório", "LocatorID": "1234"
}
]
}
Error Example Code HTTP: 400
Response {
"Message": "Not Processed",
}
Method Errors
Internal code Error message 1220 The LocatorID field must be different in each block of records
1221 The RateGroupCode field is required
1222 The size of the RategroupCode field was exceeded
1223 The RateGroupDescription field is required
1224 The size of the RateGroupDescription field has been exceeded
1225 This Rate Group is already registered
1226 This Tariff Group does not exist
PMS – System Manual 44
URL Parameters
Parameter Description Kind Required
HotelCode Hotel code. Example: http://api.pms.higs.com.br/api/v1/rategroup/1234
Integer X
Parameters
Parameter Description Kind Required
RateGroups List of tickets to update.
Array X
LocatorId Ticket item identifier. Numbering generated by the requester.
String X
RateGroupCode Tariff Group Code String X
RateGroupCodeDescription Description of the Tariff Group String(60) X
Exclude Rate Group DELETE method to exclude Rate Groups. The hotel code and Rate Group code must be passed in the URL. Request URL
http://api.pms.higs.com.br/api/v1/RateGroup/{HotelCode}?codRateGroup={RateGroupCod}
Return Success Code HTTP: 200
Response {
"Message” : “Processed”
}
Error Example Code HTTP: 400
Response {
"Message": " There is an association for this Rate Group. Please undo joins and try again." }
PMS – System Manual 45
RateCategory The registration of Rate Category has three methods
• POST method, used to perform the registration of a Rate Category. • PUT method, used to update the registration of a Rate Category. • DELETE method, used to exclude the registration of a Tariff Group
In the Post and Put methods the following data structure must be used.
Insert / Update Rate Category The hotel code must be passed in the URL. Request URL
http://api.pms.higs.com.br/api/v1/RateCategory/{HotelCode}
Request example:
Body {
"RateCategories":
[
{
"LocatorId": "1234",
"RateCategoryCode": "XX1",
"RateCategoryDescription": "Grupo Tarifas Teste API 01"
},
{
"LocatorId": "abcd",
"RateCategoryCode": "XX2",
"RateCategoryDescription": "Grupo Tarifas Teste API ab"
}
]
}
Return Success Code HTTP: 200
Response {
"Message” : “Processed”
}
PMS – System Manual 46
Partial Error Example Code HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 1221,
"Message": " O campo RateGroupCode é obrigatório", "LocatorID": "1234"
}
]
}
Error Example Code HTTP: 400
Response {
"Message": "Not Processed",
}
URL Parameters
Parameter Description Kind Required
HotelCode Hotel Code Example: http://api.pms.higs.com.br/api/v1/RateCategory/1234
Integer X
Parâmetros
Parameter Description Kind Required LocatorId Ticket item identifier. Numbering generated by the
requester.
String X
RateGroupCode Tariff Category Code
String X
RateGroupCodeDescription Description of the Rate Category
String(60) X
Exclude Rate Category
DELETE method to exclude uh types. The hotel code must be passed in the URL. Request URL
http://api.pms.higs.com.br/api/v1/RateCategory/{HotelCode}?CodRateCategory={codRateCategory}
PMS – System Manual 47
Return Success Code HTTP: 200
Response {
"Message” : “Processed”
}
Error Example Code HTTP: 400
Response {
"Message": "Not Processed",
}
Method Errors
Internal code Error message 1220 The LocatorID field must be different in each block of records
1227 This Rate Category is already registered.
1228 The RateCategoryCode field is required.
1229 The size of the RateCategoryCode field has been exceeded.
1230 The RateCategoryDescription field is required.
1231 The size of the RateCategoryDescription field has been exceeded.
1232 This Rate Category does not exist.
Contract The Contracts registry has three methods:
POST method, used to perform the registration of a Contract.
PUT method, used to update the registration of a Contract.
DELETE method, used to exclude the registration of a Contract. In the Post and Put methods the following data structure must be used.
The hotel code must be passed in the URL.
PMS – System Manual 48
Request URL
http://api.pms.higs.com.br/api/v1/Contract/{HotelCode}
Request example: 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,
"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"
PMS – System Manual 49
}
]
}
]
}
Return Success Code HTTP: 200
Response {
"Message” : “Processed”
}
Partial Error Example Code HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 145,
"Message": "Duration period or dates incorrect",
"LocatorID": "ABCD123"
}
]
}
Error Example Code HTTP: 400
Response {
"Message": "Not Processed"
}
URL Parameters
Parameter Description Kind Required
HotelCode Hotel code. Example: http://api.pms.higs.com.br/api/v1/Contract/1234
Integer
Parameters
Parameter Description Kind Required
LocatorID Ticket identifier. Numbering generated by the requester.
Cod_Agemp Agency code String(07)
Contrnum Contact number Integer
PMS – System Manual 50
Contrname Contract name String(20)
Initialdate Start date of contract validity Date
Endate Date of expiration of the contract Date
Allot If it is allotment = A contract String(01)
CategoryCode Rate Category String(20)
Ccancel Cancellation policy valid for this contract (H - Hours before arrival / D - Days before arrival / W - Weeks prior to arrival / A - Arrival time (morning) / P - )
String(01)
Ncancel Quantity related to CCANCEL Integer
CodUh1 Type of UH 1 String(02)
CodUh2 Type of UH 2 String(02)
CodUh3 Type of UH 3 String(02)
CodUh4 Type of UH 4 String(02)
Commission Percentage of commission Integer
Companycode Company Code String(07)
Companyid Company ID Integer
Credit Agency Credit (L) Released, (B) B Blocked, Endorsement (G)
String(01)
CutOff The Cut-off will be done with antececencia of: 'n' days Integer
Days_Depg Days after Request for Reservation Integer
Days_Prepg Days of Arrival Integer
Distributor Distributor where this contract can be viewed - G - GDS, I - Internet, null Both / All
String(01)
Exclude Cut-off will be deleted in 'n' days Integer
IdContinent Mainland Id when generic contract Integer
IdGeoregion Id of geographic region when generic contract Integer
PMS – System Manual 51
Inclcoffee Standard of Pension (S - Without coffee / C - With coffee / M - Half board / A - Half Board Lunch / J - Half Board Dinner / I - Full Board / T - All-Inclusive)
String(01)
LastcutOff Date of last cutoff Date
MarkUp1 Markup percentage of type 1 Integer
MarkUp2 Markup percentage of type 2
Integer
MarkUp3 Markup percentage of type 3 Integer
MarkUp4 Markup percentage of type 4 Integer
Merchant If allotment is Merchant Model String(01)
Perc_Prepg Percentage of prepayment Decimal
Priority Priority Integer
Qtuh1 Amount of Uh's in Allotment 1 Integer
Qtuh2 Amount of Uh's in Allotment 2 Integer
Qtuh3 Amount of Uh's in Allotment 3 Integer
Qtuh4 Amount of Uh's in Allotment 4 Integer
RateplanCode Rateplan Code String(10)
RoomTX If there is a room tax or equivalent charge for this contract (S) Yes or (N) no
String(01)
SystemId System Id that created / changed the registry Integer
TaxNum Contract rate number Integer
TypeContractFront Flag for standard contract on the front. Indicates Contract Type: NORMAL (N) or STANDARD (P)
String(01)
Updated Last record update date Date
UserId User who created / changed the registry Integer
ContractLanguages
IdLanguage Language Id Integer
PMS – System Manual 52
LanguageName Language Name String(150)
LanguageDescription
Language Description String(4000)
LanguageInformations
Language Information String(4000)
Title Title String(100)
LanguageData Language Data String(4000)
PoliticsDescription Description of Policies String(4000)
GeoGraphicDescription Geography Descriptions String(4000)
CultureDescription Culture Description String(4000)
GeneralDescription1 Overview 1 String(4000)
GeneralDescription2 Overview 2 String(4000)
GeneralDescription3 Overview 3 String(4000)
Method Errors
Internal code Error message 1369 This contract code is already registered for the informed hotel
1370 The agency already has a contract with this name for the informed Hotel
1371 For the Allot field, enter N or A
1372 The LASTCUTOFF field should only be informed if Allot was equal to A
1373 Invalid date in LASTCUTOFF field
1374 Non-existent registration, enter a valid code or category of Rate
1375 Invalid start date
1376 The start and end date must be different
1377 Invalid cancellation policy code
1378 Invalid pension code
1379 Invalid Distributor ID
1380 Invalid credit code
1383 Non-existent registry for updating
1393 Invalid mainland code
1394 Invalid geographic region code
1395 Non-existent record for deletion
PMS – System Manual 53
Exclusion of Contract DELETE method for deleting contracts. The hotel code must be entered in the URL along with the contract code Request URL
http://api.pms.higs.com.br/api/v1/Contract/{HotelCode}?codContract={ContractCode}
Return Success Code HTTP: 200
Response {
"Message” : “Processed”
}
Error Example Code HTTP: 500
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 500,
"Message": "Error when deleting the Rate",
}
]
}
Source Of Business Listing GET method for listing the Sources of Business registered in the system. Request URL
http://api.pms.higs.com.br/api/v1/SourceOfBusiness
Return Success Code HTTP: 200
Response {
"SourceOfBusinessList": [
{
"Source": "AAATISM",
"Name": "AAATOURISMSITEMINDER"
},
{
PMS – System Manual 54
"Source": "AADTNMN",
"Name": "MUNRO'S TRAVEL LIMITED"
},
{
"Source": "AATRVEL",
"Name": "AATRAVELSITEMINDER"
},
{
"Source": "ABREREU",
"Name": "ABREUSITEMINDER"
},
{
"Source": "ACCOURU",
"Name": "ACCOMMODATIONGURUSITEMINDER"
}
]
}
Error Example Code HTTP: 500
Response {
"Message": " Not Processed", "Warnings": [{
"Code":366,
"Message": "Error during processing, please retry",
}
]
}
Package The Package register has three methods:
POST method, used to perform the registration of a Package.
PUT method, used to update the registration of a Package.
DELETE method, used to exclude the registration of a Package. In the Post and Put methods the following data structure must be used.
The hotel code must be passed in the URL.
Request URL
http://api.pms.higs.com.br/api/v1/package/{HotelCode}
Request example: Body
{
"Packages": [
{
"LocatorId": "1212",
"PackageCode": 12,
"RateNumber": 1,
PMS – System Manual 55
"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"
}
]
}
Return Success Code HTTP: 200
Response {
"Message” : “Processed”
}
Partial Error Example Code HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 118,
"Message": " End field is required", "LocatorID": "ABCD123"
}
]
}
Error Example Code HTTP: 400
Response {
"Message": "Not Processed"
}
Method Errors
PMS – System Manual 56
Internal code Error message 1357 User who created / changed the registry
1236 EventName field is required
1237 Descriptions field is required
1117 Start field is required
1118 End field is required
1382 This package code is already registered
1383 Non-existent upgrade package
1384 Invalid language type
1385 Invalid description type
1386 Invalid FixedPrice field, S or N report
1387 Invalid RequiredReservation field
1388 Invalid CompanyCode field
1389 Invalid CancellationUnit field
1390 Please inform a cancellation policy
URL Parameters
Parameter Description Type Required
HotelCode Hotel Code Example: http://api.pms.higs.com.br/api/v1/Package/1234
Integer
Parameters
Parameter Description Type Required
LocatorID Ticket identifier. Numbering generated by the requester.
PackageCode Package Code String(04)
RateNumber Rate Code String(07)
EventName Package Name String
Start Package start date Date
End End date of package Date
DaysMin Minimum number of days Integer
FixedPrice Fixed Package Yes(S) or No (N)
String(01)
PMS – System Manual 57
RequiredReservation Obligate Reservations in the Package? (T)All, (A)Agencies, (C)Reservation Center, (N)Not mandatory, (I)Internet
String(01)
PercentPrePayment Pre-payment percentage. Decimal
DaysBeforeArrival Amount of days before arrival. Integer
DaysAfterReservationForPayment Number of days after reservation to make the previous deposit.
Integer
CompanyCode Customer SB / IT code if the package is specific to an Agency / Company
String
CancellationUnit Cancellation unit DEFAULT type Hour = HOUR, Day = DAY, Week = WEEK, A = AM, P = PM
String
UnitTimeCancellation DEFAULT unit of time for cancellation of reservation. Integer
Commission Percentage of commission paid to agencies Decimal
Pension Standard of Pension (S - Without coffee / C - With coffee / M - Half board / A - Half Board Lunch / J - Half Board Dinner / I - Pension
String(01)
CategoryCode Rate Category String
Priority Order of priority to be shown the product. Integer
RatePlanCode Rate Access on Tars String
Distribuidor Distributor where this package can be viewed G - gds, I - internet, null both / all
String(1)
DT_UltAlteracao Last update date Date
Descriptions
Package Notes
Type Observation Type
Cancellation Policy: 1
Purchases, payments or guarantees: 2
Note: 3 Other Services: 4
Description: 5
Integer
Language Observation Language English: 1
English: 999
Spanish: 3
Italian: 4
Frances: 5 German: 6
Portugal: 7
String(150)
Text Description String(4000)
PMS – System Manual 58
Package Exclusion DELETE method to exclude packets. The hotel code must be passed in the URL along with the package code Request URL
http://api.pms.higs.com.br/api/v1/Package/{HotelCode}?packageCode={PackageCode}
Return Success Code HTTP: 200
Response {
"Message” : “Processed”
}
Error Example Code HTTP: 500
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 500,
"Message": "Error when deleting the Package",
}
]
}
RateAvailability The inclusion of records in the tariff schedule is done through the Post Method
The hotel code must be passed in the URL.
Request URL
http://api.pms.higs.com.br/api/v1/RateAvailability/{HotelCode}
Request example:
Body {
"RateAvailability":
[
{"LocatorId": "1212",
"InitialDate": "2017-12-18T00:00:00",
"FinalDate": "2017-12-18T00:00:00",
"StatusDescription": 1,
"Status": 1,
"RoomType": "UH1",
PMS – System Manual 59
"Rate": 1,
"RateGroup": 1
}
]
}
Return Success Code HTTP: 200
Response {
"Message” : “Processed”
}
Partial Error Example Code HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 1343,
"Message": " The field FinalDate is Required", "LocatorID": "ABCD123"
}
]
}
Error Example Code HTTP: 400
Response {
"Message": "Not Processed"
}
Method Errors
Internal code Error message 1130 The Field LocatorId is required
1342 The field InitialDate is Required
1343 The field FinalDate is Required
1344 The field StatusDescription is Required
1345 The field Status is Required
1346 The field RoomType is Required
1347 The field Rate is Required
1348 The field RateGroup is Required
PMS – System Manual 60
URL Parameters
Parameter Description Type Required
HotelCode Hotel code. Example: http://api.pms.higs.com.br/api/v1/RateAvailability /1234
Integer
Parameters
Parameter Description Type Required
LocatorID Ticket identifier. Numbering generated by the requester.
InitialDate Start date of the period Date
FinalDate End date of the period Date
StatusDescription Status Description String(60)
Status Calendar status CalTarifa.STATUS: 1 = Rate is closed CalTarifa.STATUS: 2 = Closed for arrival CalTarifa.STATUS: 3 = Open for DayUse CalTarifa.STATUS: BETWEEN 4 AND 17 Shows Status = Minimum Stay from Date CalTarifa.STATUS: BETWEEN 18 AND 31 = Minimum stay by passing the Date CalTarifa.STATUS: BETWEEN 32 AND 45 = Maximum Stay from Date CalTarifa.STATUS: BETWEEN 46 AND 59 = Maximum stay going by Date
Integer
RoomType Room Code String(2)
Rate Rate Code Integer
RateGroup Rate Group String(01)
SendBooking The SendBooking method must be used to send PMS reservations to HIGS Sending reservations must be through the Post method
The hotel code must be passed in the URL.
Request URL
PMS – System Manual 61
http://api.pms.higs.com.br/api/v1/SendBooking/
Request example:
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
}
]
}
]
}
}
Return Success Code HTTP: 200
Response {
"Message” : “Processed”
}
PMS – System Manual 62
Partial Error Example Code HTTP: 206
Response {
"Message": "Partially Processed",
"Warnings": [{
"Code": 1343,
"Message": " The field FinalDate is Required", "LocatorID": "ABCD123"
}
]
}
Error Example Code HTTP: 400
Response {
"Message": "Not Processed"
}
Method Errors
Internal code Error message 1027 The "CurrencyCode" field is invalid
1028 The "CurrencyCode" field is required
1029 Checkin is required
1030 Checkout field is required
1043 IdHotel field is invalid
1057 GuestCount field is required
1090 Invalid hotel reservation id
1101 The "Rates" field is required
1130 The LocatorId field is required
1159 The Status field is required
1164 The CompanyId field is required.
1166 The CompanyName field is required.
1173 CityName field size exceeded.
1174 The size of the StateName field has been exceeded.
1175 CountryName field size exceeded.
PMS – System Manual 63
Parameters
Parameter Description Type Required
LocatorID Ticket identifier. Numbering generated by the requester.
HotelCode Hotel code Integer
ReservationNumberHIGS HIGS reservation number String
ReservationNumberHOTEL Hotel reservation number String
IsWalkin Host passant Boolean
Status Reservation Status Reserved = 1,
ReservedComchanges = 2, Canceled = 3, CheckedIn = 4, CheckedOut = 5, NoShow = 6
Integer
PmsStatus Reservation Status Reserved = 1, ReservedComchanges = 2, Canceled = 3, CheckedIn = 4, CheckedOut = 5, NoShow = 6
Integer
Checkin Arrival date Date
Checkout Departure date Date
ConfirmedCheckin Checkin Confirmation Date Date
ConfirmedCheckout
Checkout Confirmation Date Date
CreationDate Creation date Date
LastUpdateDate Last update date Date
NumberOfRooms Number of bedrooms Integer
Guests Number of guests Integer
Guests
Guest Information
Adults Number of adults Integer
PMS – System Manual 64
Children Number of children Integer
GuestOriginCountryCode Source City Code String
GuestOriginStateCode Code of the State of origin String
GuestOriginCityName Name of the city String
OriginalPMSRoomType Original Room Type in PMS String
CurrentPMSRoomType Room Type Chain String
PMSRateCode PMS Rate Code String
PMSBlockCode PMS lock code String
AllotmentCode Allotment Code String
MealPlanCode Meal Plan Code None: 1, CafeDaManha: 2, MeiaPensaoAlmoco: 3, Meanwhile, PensaoInteira: 5, All Including: 6
Integer
ReservationSourceCode Reservation source code String
ReservationMarketCode Reservation Market Code String
ReservationSubMarketCode Reservation Market Code String
RewardProgramType
Loyalty program information String
LoyaltyID Loyalty program code String
CompanyInfo
Agency / Company Information
CompanyId Company code String
CompanyName Agency Name String
CountryCode Country code String
StateCode State Code String
CityCode City code String
CurrencyCode Currency Code String
Rates
PMS – System Manual 65
EffectiveDate Date of the reservation that will be charged Integer
Amount Amount to be charged according to EffectiveDate Integer
PartnerList Get method to perform consultation of partners linked to a hotel if they are active or inactive, when the Active is false means that the partner is not enabled for the hotel. The hotel code must be passed in the URL. Request URL
http://api.pms.higs.com.br/api/v1/PartnerList/{HotelCode}
Return Success Code 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
}
]
}
Parameters
Parameter Description Type Required
HotelCode Code Hotel Identifier
Integer