Property
Property describes a commercial premises such as hotels, motels, lodges, luxury apartments, home stays and other types of buildings where individuals, couples, families and/or groups pay to stay, eat, have fun, relax, and to take advantage of all the offered in-house services available.
Create or Update Property
You can create a new property or update an existing property with this API.
Endpoint
POST
https://connect-sandbox.su-api.com/SUAPI/jservice/OTA_HotelDescriptiveContentNotifThe HotelDescriptiveContent object
The HotelDescriptiveContent object defines all the details of a particular hotel such as hotel id, hotel name, time zone, currency, language, contact info, hotel email id, phone number, and position. Partner can provide all these details using the sample request and create or update hotel descriptive content.
Attributes
The dot notation indicates that the property is one level deep inside a hash. No attributes are guaranteed to be present, and if we cannot find data on a specific network, then we will return a null value for that attribute.
HotelName string (Required)
Name of the property as it should be displayed on the website as a hotel name.
Accepts alphanumeric values.
Special characters are not allowed except Hyphen & Apostrophe mark (" - ", " ' ").
HotelType string (Optional)
Hotels are classified according to the location, target markets, ownership, affiliation, and facility provided. HotelType describes the type of that property.
Accepts values: [1, 2 or 3] (Default value=1)
1- Hotel
2- Motel
3- Vacational Rental
TimeZone string (Optional)
If no value passed, system would take the default value of TimeZone depending on the country.
Accepts the values listed under Time Zones.
Platform string (Optional)
PMS service assigned as Both (SU & STAAH).
Accepts values: ["SU" or "STAAH"]
hotelid / HotelCode / ClientID string (Required)
The unique property ID as assigned by the provider upon creation of the property.
Accepts alphanumeric values.
Space and Special characters are not allowed except Hyphen (" - ").
Maximum 20 characters allowed.
ChainID string (Optional)
The Chain ID as assigned by the provider upon creation of the property.
Accepts alphanumeric values.
Space and Special characters are not allowed except Hyphen (" - ").
Maximum 20 characters allowed.
LanguageCode enum (Required)
The language codes which are acceptable for the property.
Accepts the values listed under Language Codes.
Default: en
CurrencyCode string (Required)
The currency codes which are acceptable for the property.
Accepts the values listed under Currency Codes.
closeoutdays number (Optional)
The closeoutdays as allocated by the provider for the property.
Accepts the values between 0 to 30 but must be in quotes. Default value is - 1 (no closeouts).
closeouttime string (Optional)
The closeouttime as allocated by the provider for the property.
Accepts the values between 00:00 to 24:00 (Interval must be 30 min). It is required only if you set closeoutdays value as 0. Default value is - 1 (no closeouts).
HotelDescriptiveContentNotifType enum (Required)
Indicates whether the call is meant to create a new property or update an existing one.
Accepts these values: New and Overlay.
Default: New
PropertyLicenseNumber string (Optional)
The property license number, as provided by the local authority.
Required for certain property types, in certain regions.
OfficialCheckinTime string (Optional)
Indicates Check-in Time for the earliest time a guest can check in.
Format: HH:MM 24-hour check-in can be specified using 00:00
OfficialCheckoutTime string (Optional)
Indicates Check-out Time for the earliest time a guest can check out.
Format: HH:MM 24-hour check-in can be specified using 00:00
The ContactInfos object
The ContactInfos object contains all the information related to the property. This object is the building block of Names, Addresses, Emails, and Phones.
If the contact profile type is physical location, then you have to provide the complete address which contains complete physical address of the property (City, Postal code, and Country).
Attributes
ContactProfileType enum (Required)
Indicates the type of contact.
Accepts: availability and PhysicalLocation.
availability- Contact for questions about availability.
PhysicalLocation- Address details for the property's physical location.
Name.GivenName string (Required)
The contact's given (first) name.
Name.Surname string (Required)
The contact's last name or family name.
NotificationEmail email (Optional)
Email address on which reservations will be notified.
Multiple Notification Email allowed.
Addresses object
Provides information about the addresses associated with hotels or properties.
Address.AddressLine string (Required)
The full street name and number.
Address.CityName string (Required)
The name of the city, town, or village.
Only editable via Extranet.
Address.CountryName countrycode (Required)
The two-letter code for the country.
Only editable via Extranet listed under Country Code.
Address.PostalCode string (Required)
The postal or zip code.
Emails object
Provides information about the addresses associated with hotels or properties.
Email string (Required)
Contains a valid email address.
Phones object
Refers to the phone number and the phone tech type used.
Phone.PhoneNumber string (Required)
The international phone number that must be dialed to reach the phone.
Must begin with +, followed by all digits required to dial internationally.
No whitespace, hyphens, or other characters allowed.
Not more than 15 numbers.
Phone.PhoneTechType enum (Required)
The type of phone line or device, expressed as a PTT code.
The HotelInfo object
This object represents your hotel’s physical position. It provides the exact co-ordinates containing the value of Latitude and Longitude.
Attributes
Position.Latitude latitude-value (Required)
Latitude of the property's location.
A valid Latitude value (-90) to 90.
Position.Longitude longitude-value (Required)
Longitude of the property's location.
A valid Longitude value (-180) to 180.
Facilities array
This array represents the facility in your hotel such as free parking, internet connection, cab service, and CCTV camera. It provides the information in combination of the facility and the group name from which the facility belongs to.
Attributes
Facility.Group string (Optional)
Group name of the facility.
Facility.name string (Optional)
Name of the facility under a group, multiple facility name can come under one group.
HotelDescription Free Text (Optional)
Proper description of the property/hotel.
Maximum 100 characters. If exceeded, system will simply accept and will not return an error.
Sample Request
{
"HotelDescriptiveContents": {
"HotelDescriptiveContent": {
"HotelName": "Kings Cross",
"HotelType": "3",
"TimeZone": "Europe/London",
"Platform": "SU",
"hotelid": "KC",
"ChainID": "W1",
"LanguageCode": "en",
"CurrencyCode": "GBP",
"Closeoutdays": "1",
"Closeouttime": "00:30",
"HotelDescriptiveContentNotifType": "New",
"PropertyLicenseNumber": "AB-CD-1234",
"OfficialCheckinTime": "12:00",
"OfficialCheckoutTime": "11:00",
"ContactInfos": {
"ContactInfo": [
{
"ContactProfileType": "PhysicalLocation",
"Addresses": {
"Address": {
"AddressLine": "36 Northwild Street",
"CityName": "London",
"PostalCode": "M16JD",
"CountryName": "GB"
}
}
},
{
"ContactProfileType": "availability",
"Names": {
"Name": {
"GivenName": "Steve",
"Surname": "Martin"
}
},
"Addresses": {
"Address": {
"AddressLine": "36 Northwild Street",
"CityName": "London",
"CountryName": "GB",
"PostalCode": "M16JD"
}
},
"NotificationEmail": "no-reply[at]youremail.com",
"Emails": {
"Email": [
"admin[at]examplehotel.com",
"admin1[at]examplehotel.com",
"admin2[at]examplehotel.com"
]
},
"Phones": {
"Phone": [
{
"PhoneNumber": "+3362211110",
"PhoneTechType": "1"
},
{
"PhoneNumber": "+3362211111",
"PhoneTechType": "1"
},
{
"PhoneNumber": "+3362211112",
"PhoneTechType": "5"
},
{
"PhoneNumber": "+3362211113",
"PhoneTechType": "5"
},
{
"PhoneNumber": "+3362211114",
"PhoneTechType": "3"
}
]
}
}
]
},
"HotelInfo": {
"Position": {
"Latitude": "49.4092",
"Longitude": "1.0900"
}
},
"Facilities": {
"Facility": [
{
"Group": "Parking",
"name": "Free Parking"
},
{
"Group": "Facilities",
"name": "CCTV Camera"
},
{
"Group": "Facilities",
"name": "Gym"
},
{
"Group": "Facilities",
"name": "Convention Center"
},
{
"Group": "Facilities",
"name": "24 hours Frontdesk"
}
]
},
"HotelDescription": "Graceful Apartment in London is nearby airport with Free WiFi and other Amenities."
}
}
}Response
Sample Success Response
{
"Status": "Success"
}Sample Error Response
{
"Errors": [
{
"Code": "895",
"ShortText": "HotelDescriptiveContent: HotelName Property content is required"
}
],
"Status": "Fail"
}This API uses an overlay system. Every time you update an existing property, room type or other objects, the body of your request replaces previous information.
This means existing information will be deleted if you don’t include in your request.To update an object without deleting information, make sure your request contains both the fields you want to update and those you want to keep the same.
Last updated
Was this helpful?