Property API
Modified on: 2025-12-05 15:06
TABLE OF CONTENTS
- Introduction
- GET Property
- GET Property Content with {propertyCode}
- POST Property Content
- Related Articles:
Introduction
- GET Property: This API allows DerbySoft to retrieve a list of properties within a specified context from the Supplier's system.
- GET Property Content with {propertyCode}: This API allows users to retrieve the content details of a specific property using the provided {propertyCode}. It enables querying a single property’s information within a specified context.
- POST Property Content: This API performs a full update of property content in the system, replacing all existing data with the new submission within a specified context.
GET Property
This API allows DerbySoft to retrieve a list of properties within a specified context from the Supplier's system.
API Endpoints & Methods
Base URL: https://contentsolutions-supplier.derbysoftsec.com | |
|---|---|
HTTP method | URL |
Get | /api/content/properties |
Headers
| Name | Type | Required | Desciption | Example |
|---|---|---|---|---|
| Authorization | string | required | Basic Authentication token for API access. | Basic Vz********MTI= |
| Content-Type | string | required | Specifies the media type of the request. | application/json;charset=UTF-8 |
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
contextCode | string | required |
Response Parameters
Parameter | Type | Description | Example |
|---|---|---|---|
page | object | Contains pagination details. | |
page.index | integer | The current page index (starting from 0). | |
page.size | integer | The number of elements per page. | |
page.totalElements | integer | The total number of elements in the dataset. | |
page.totalPages | integer | The total number of pages in the dataset. | |
items | array | A list of properties, where each object represents a hotel. | |
items.contextCode | string | Business context code, possibly indicating the data source or usage. | |
items.propertyCode | string | Unique identifier for the property (hotel). | |
items.propertyName | string | The name of the hotel. | |
items.countryCode | string | The ISO country code where the property is located (e.g., US, CN, FR). | |
items.brandCode | string | The brand code indicates the brand the property belongs to (e.g., Hilton, Marriott). | |
items.chainCode | string | The chain code represents the hotel’s parent chain. | |
items.operateStatus | string | Indicates the operational status of the property. Enum: [ ENABLED, PAUSED ] | ENABLED |
Example Response
Success Response (HTTP Status 200)
{
"data": {
"page": {
"index": 1,
"size": 10,
"totalElements": 10,
"totalPages": 1
},
"items": [
{
"contextCode": "derbydemo",
"propertyCode": "derbydemo001",
"propertyName": "DerbySoft DEMO",
"countryCode": "USA",
"brandCode": "DS",
"chainCode": "DS",
"operateStatus": "ENABLED"
}
]
}
}Error Response (HTTP Status 403)
{
"error": {
"code": "FORBIDDEN",
"message": "Lack of permissions, please configure permissions."
}
}Error Response (HTTP Status 400)
{
"error": {
"code": "InvalidField",
"message": "Invalid [contextCode] value [contextCode is required.]."
}
}GET Property Content with {propertyCode}
This API allows users to retrieve the content details of a specific property using the provided {propertyCode}. It enables querying a single property’s information within a specified context.
API Endpoints & Methods
Base URL: https://contentsolutions-supplier.derbysoftsec.com | |
|---|---|
HTTP method | URL |
Get | /api/content/properties/{propertyCode} |
Headers
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Authorization | String | required | Basic Authentication token for API access. | Basic Vz********MTI= |
| Content-Type | String | required | Specifies the media type of the request. | application/json;charset=UTF-8 |
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
contextCode | String(query) | required | Context Code in DerbySoft's system. | DERBYDEMO |
propertyCode | String(path) | required | Property code provided by content suppliers, only the following characters are allowed. 1. Digits (0-9) 2. Uppercase letters (A-Z) 3. Hyphen ('-') | BONITAPROPERTY |
Response Parameters
Refers to [POST Property Content] Query Parameters
Example Response
Success Response (HTTP Status 200)
{
"basicInformation": {
"propertyNameLangs": [
{
"languageCode": "EN-US",
"value": "DerbySoft DEMO"
}
],
"propertyShortNameLangs": [
{
"languageCode": "EN-US",
"value": "DerbySoft"
}
],
"propertyDescriptionLangs": [
{
"languageCode": "EN-US",
"value": "A luxury demo hotel located in downtown Los Angeles, offering premium amenities and services."
}
],
"status": "OPEN",
"countryCode": "US",
"hotelCityCode": "LAX",
"chainCode": "100",
"chainNameLangs": [
{
"languageCode": "EN-US",
"value": "DerbySoft Hotels"
}
],
"brandCode": "200",
"brandNameLangs": [
{
"languageCode": "EN-US",
"value": "DerbySoft Luxury Collection"
}
],
"timeZone": "America/Los_Angeles",
"currencyCode": "USD",
"whenBuilt": "2010",
"firstOpenDate": "2011-06-01",
"renovations": [
{
"completionDate": "2020-01-15",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Extensive renovation of rooms and public areas, adding modern amenities."
}
]
}
],
"floors": [
{
"start": 1,
"end": 20
}
],
"propertyCategories": [
{
"code": "500",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Luxury Hotel"
}
]
}
],
"segmentCategories": [
{
"code": "300",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Business Travelers"
}
]
}
],
"locationCategories": [
{
"code": "400",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Located in the heart of the city"
}
]
}
],
"position": {
"latitude": 34.0522,
"longitude": -118.2437,
"positionAccuracyCode": "1"
},
"contacts": [
{
"companyNameLangs": [
{
"languageCode": "EN-US",
"value": "DerbySoft DEMO Hotel"
}
],
"departmentLangs": [
{
"languageCode": "EN-US",
"value": "Front Desk"
}
],
"addresses": [
{
"useTypeCode": "1",
"postalCode": "90015",
"countryCode": "US",
"stateCode": "CA",
"cityCode": "100",
"countryNameLangs": [
{
"languageCode": "EN-US",
"value": "United States"
}
],
"stateNameLangs": [
{
"languageCode": "EN-US",
"value": "California"
}
],
"cityNameLangs": [
{
"languageCode": "EN-US",
"value": "Los Angeles"
}
],
"countyNameLangs": [
{
"languageCode": "EN-US",
"value": "Los Angeles County"
}
],
"addressLines": [
{
"addressLineLangs": [
{
"languageCode": "EN-US",
"value": "1234 Sunset Blvd"
}
]
}
]
}
],
"phones": [
{
"locationType": "1",
"techType": "1",
"countryAccessCode": "+1",
"areaCityCode": "310",
"phoneNumber": "555-1234"
}
],
"emails": [
{
"type": "GENERAL",
"address": "info@derbysoftdemo.com"
}
],
"urls": [
"https://www.derbysoftdemo.com"
],
"lastUpdated": "2024-01-01"
}
],
"capacities": [
{
"code": "TOTAL_ROOMS",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Total Guest Rooms"
}
],
"quantity": 200
},
{
"code": "MAX_OCCUPANCY",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Maximum Occupancy"
}
],
"quantity": 450
}
],
"awards": [
{
"date": "2023-01-01",
"providerLangs": [
{
"languageCode": "EN-US",
"value": "TripAdvisor"
}
],
"ratingLangs": [
{
"languageCode": "EN-US",
"value": "Certificate of Excellence"
}
],
"officialAppointment": true,
"ratingSymbol": "5"
}
],
"spokenLanguages": [
{
"primaryLanguage": true,
"languageCode": "EN-US"
},
{
"primaryLanguage": false,
"languageCode": "ES-US"
},
{
"primaryLanguage": false,
"languageCode": "ZH-CN"
}
],
"labels": [
{
"code": "LUXURY",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "5-Star Luxury Accommodation"
}
]
},
{
"code": "BUSINESS_FRIENDLY",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Business Travel Approved"
}
]
}
],
"goIds": [
{
"channelCode": "AGODA",
"id": "AGD123456"
},
{
"channelCode": "BOOKING",
"id": "BKG789012"
}
],
"richMedias": [
{
"url": "https://www.derbysoftdemo.com/videos/hotel-tour.mp4"
}
],
"lastUpdated": "2024-01-01",
"facilityLastUpdated": "2024-01-01",
"policyLastUpdated": "2024-01-01",
"referencePointLastUpdated": "2024-01-01",
"attractionsLastUpdated": "2024-01-01",
"recreationLastUpdated": "2024-01-01",
"otherHotelsLastUpdated": "2024-01-01",
"affiliationsLastUpdated": "2024-01-01",
"imagesLastUpdated": "2024-01-01",
"masterChainCode": "100",
"generalUnit": "METRIC",
"generalWeightUnit": "KG",
"generalAreaUnit": "SQ_M",
"generalDistanceUnit": "KM"
},
"facilityInformation": {
"amenities": [
{
"id": "001",
"code": "101",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Free High-Speed WiFi"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Complimentary 1Gbps WiFi in all rooms and public areas"
}
],
"included": true,
"proximityCode": "INDOOR",
"quantity": 1,
"operationSchedules": [
{
"start": "2024-01-01",
"end": "2024-12-31",
"operationTimes": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "00:00",
"end": "24:00",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "24/7 Availability"
}
]
}
],
"charges": []
}
],
"features": []
},
{
"id": "002",
"code": "102",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Outdoor Swimming Pool"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Heated outdoor pool with cabanas and pool bar"
}
],
"included": true,
"proximityCode": "OUTDOOR",
"quantity": 1,
"operationSchedules": [
{
"start": "2024-03-01",
"end": "2024-10-31",
"operationTimes": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "08:00",
"end": "20:00",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Seasonal Availability (Mar-Oct)"
}
]
}
],
"charges": []
}
],
"features": [
{
"id": "F001",
"code": "POOL_BAR",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Pool Bar Service"
}
],
"quantity": 1,
"unit": "UNIT",
"chargeCurrencyCode": "USD",
"chargeAmount": 0,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Complimentary access to pool bar (food/drinks extra)"
}
]
}
]
},
{
"id": "003",
"code": "103",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Full-Service Spa"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Luxury spa offering massages, facials and body treatments"
}
],
"included": false,
"proximityCode": "INDOOR",
"quantity": 1,
"operationSchedules": [
{
"start": "2024-01-01",
"end": "2024-12-31",
"operationTimes": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "09:00",
"end": "19:00",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "By Appointment Only"
}
]
}
],
"charges": [
{
"amount": 150,
"percent": 0,
"currencyCode": "USD",
"unitCode": "HOUR",
"frequencyCode": "PER_SERVICE"
}
]
}
],
"features": [
{
"id": "F002",
"code": "SPA_TREATMENTS",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Customized Spa Packages"
}
],
"quantity": 10,
"unit": "TREATMENT",
"chargeCurrencyCode": "USD",
"chargeAmount": 200,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "90-minute signature massage package"
}
]
}
]
}
],
"businessServices": [
{
"id": "B001",
"code": "BUSINESS_CENTER",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "24-Hour Business Center"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Full-service business center with printing, scanning and meeting facilities"
}
],
"included": true,
"proximityCode": "INDOOR",
"quantity": 1,
"operationSchedules": [
{
"start": "2024-01-01",
"end": "2024-12-31",
"operationTimes": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "00:00",
"end": "24:00",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "24/7 Availability"
}
]
}
],
"charges": [
{
"amount": 0,
"percent": 0,
"currencyCode": "USD",
"unitCode": "PAGE",
"frequencyCode": "PER_USE"
}
]
}
],
"features": [
{
"id": "BF001",
"code": "PRINTING_SERVICE",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Complimentary Printing"
}
],
"quantity": 2,
"unit": "PRINTER",
"chargeCurrencyCode": "USD",
"chargeAmount": 0,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "First 10 pages complimentary, $0.10 per page thereafter"
}
]
}
]
}
],
"meetingServices": [
{
"id": "M001",
"code": "MEETING_ROOMS",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Flexible Meeting Spaces"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "5 meeting rooms accommodating 10-200 guests with AV equipment"
}
],
"included": false,
"proximityCode": "INDOOR",
"quantity": 5,
"operationSchedules": [
{
"start": "2024-01-01",
"end": "2024-12-31",
"operationTimes": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI"],
"start": "08:00",
"end": "18:00",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Weekday Availability"
}
]
}
],
"charges": [
{
"amount": 200,
"percent": 0,
"currencyCode": "USD",
"unitCode": "HOUR",
"frequencyCode": "PER_ROOM"
}
]
}
],
"features": [
{
"id": "MF001",
"code": "AV_EQUIPMENT",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "AV Equipment Rental"
}
],
"quantity": 10,
"unit": "SET",
"chargeCurrencyCode": "USD",
"chargeAmount": 50,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Projector, sound system and microphone package"
}
]
}
]
}
],
"mealServices": [
{
"id": "ME001",
"code": "BREAKFAST_SERVICE",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Complimentary Breakfast Buffet"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "International breakfast buffet with hot and cold options"
}
],
"included": true,
"proximityCode": "INDOOR",
"quantity": 1,
"operationSchedules": [
{
"start": "2024-01-01",
"end": "2024-12-31",
"operationTimes": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI"],
"start": "06:30",
"end": "09:30",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Weekday Breakfast Hours"
}
]
},
{
"weekDays": ["SAT", "SUN"],
"start": "07:00",
"end": "10:30",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Weekend Breakfast Hours"
}
]
}
],
"charges": []
}
],
"features": [
{
"id": "MEF001",
"code": "VEGETARIAN_OPTIONS",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Vegetarian & Vegan Options"
}
],
"quantity": 1,
"unit": "OPTION",
"chargeCurrencyCode": "USD",
"chargeAmount": 0,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Complimentary vegetarian and vegan breakfast options"
}
]
}
]
}
],
"accessibleService": {
"id": "A001",
"code": "ACCESSIBLE_FACILITIES",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "ADA Compliant Facilities"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Wheelchair accessible rooms, ramps and elevators"
}
],
"included": true,
"proximityCode": "INDOOR",
"quantity": 1,
"operationSchedules": [
{
"start": "2024-01-01",
"end": "2024-12-31",
"operationTimes": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "00:00",
"end": "24:00",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "24/7 Availability"
}
]
}
],
"charges": []
}
],
"features": [
{
"id": "AF001",
"code": "ACCESSIBLE_ROOMS",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Wheelchair Accessible Rooms"
}
],
"quantity": 10,
"unit": "ROOM",
"chargeCurrencyCode": "USD",
"chargeAmount": 0,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Complimentary accessible room upgrade (subject to availability)"
}
]
}
]
},
"securityService": {
"id": "S001",
"code": "24_7_SECURITY",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "24-Hour Security"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "On-site security personnel and CCTV surveillance"
}
],
"included": true,
"proximityCode": "INDOOR",
"quantity": 1,
"operationSchedules": [
{
"start": "2024-01-01",
"end": "2024-12-31",
"operationTimes": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "00:00",
"end": "24:00",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "24/7 Availability"
}
]
}
],
"charges": []
}
],
"features": [
{
"id": "SF001",
"code": "KEY_CARD_ACCESS",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Key Card Access System"
}
],
"quantity": 1,
"unit": "SYSTEM",
"chargeCurrencyCode": "USD",
"chargeAmount": 0,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Secure key card access to guest floors and rooms"
}
]
}
]
}
},
"meetingRoomInformation": {
"total": 5,
"totalRoomSpace": 1000,
"totalSeatingCapacity": 500,
"largestRoomSpace": 300,
"smallestRoomSpace": 50,
"largestSeatingCapacity": 200,
"smallestSeatingCapacity": 10,
"unit": "SQ_M",
"meetingRooms": [
{
"id": "MR001",
"nameLangs": [
{
"languageCode": "EN-US",
"value": "Sunset Ballroom"
}
],
"dimension": {
"area": 300,
"height": 3.5,
"width": 15,
"length": 20,
"unit": "SQ_M"
},
"capacities": [
{
"formatCode": "THEATER",
"maxOccupancy": 200
},
{
"formatCode": "BOARDROOM",
"maxOccupancy": 50
}
],
"services": [
{
"code": "CATERING",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Catering Service"
}
],
"quantity": 1,
"chargeAmount": 50,
"chargePercent": 0,
"chargeCurrencyCode": "USD",
"chargeUnitCode": "PER_PERSON",
"chargeFrequencyCode": "PER_EVENT"
}
],
"images": [
{
"mainUrl": "https://www.derbysoftdemo.com/images/meeting-rooms/sunset-ballroom.jpg",
"richMediaUrl": "https://www.derbysoftdemo.com/videos/meeting-rooms/sunset-ballroom.mp4",
"categoryCode": "MEETING_ROOM",
"sort": 1,
"sourceId": "MR_IMG_001",
"captionLangs": [
{
"languageCode": "EN-US",
"value": "Sunset Ballroom - Theater Style"
}
],
"applicableStart": "2024-01-01",
"applicableEnd": "2024-12-31",
"items": [
{
"url": "https://www.derbysoftdemo.com/images/meeting-rooms/sunset-ballroom-large.jpg",
"width": 1920,
"height": 1080,
"size": "LARGE",
"unit": "PIXEL",
"fileSize": 2048,
"resolution": 300,
"recordId": "MR_IMG_ITEM_001",
"formatCode": "JPG"
}
],
"lastUpdated": "2024-01-01"
}
]
}
]
},
"restaurantInformation": {
"total": 2,
"restaurants": [
{
"id": "R001",
"nameLangs": [
{
"languageCode": "EN-US",
"value": "Sunset Grill"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Fine dining restaurant specializing in American cuisine with ocean views"
}
],
"maxCapacity": 100,
"proximityCode": "OUTDOOR",
"reservationsRequired": true,
"mealOffers": ["LUNCH", "DINNER"],
"relativePosition": {
"direction": "W",
"distance": "0.5",
"unit": "KM",
"toFrom": "HOTEL"
},
"restaurantTypeCodes": [
{
"code": "FINE_DINING",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Fine Dining Restaurant"
}
]
}
],
"cuisines": [
{
"code": "AMERICAN",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "American Cuisine"
}
],
"main": true
}
],
"schedules": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "12:00",
"end": "22:00",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Daily Lunch & Dinner Service"
}
]
}
],
"restaurantServices": [
{
"code": "WINE_PAIRING",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Wine Pairing Service"
}
]
}
],
"images": [
{
"mainUrl": "https://www.derbysoftdemo.com/images/restaurants/sunset-grill.jpg",
"richMediaUrl": "https://www.derbysoftdemo.com/videos/restaurants/sunset-grill.mp4",
"categoryCode": "RESTAURANT",
"sort": 1,
"sourceId": "R_IMG_001",
"captionLangs": [
{
"languageCode": "EN-US",
"value": "Sunset Grill - Outdoor Dining Area"
}
],
"applicableStart": "2024-01-01",
"applicableEnd": "2024-12-31",
"items": [
{
"url": "https://www.derbysoftdemo.com/images/restaurants/sunset-grill-large.jpg",
"width": 1920,
"height": 1080,
"size": "LARGE",
"unit": "PIXEL",
"fileSize": 1536,
"resolution": 300,
"recordId": "R_IMG_ITEM_001",
"formatCode": "JPG"
}
],
"lastUpdated": "2024-01-01"
}
]
}
]
},
"closeSeasons": [
{
"startDate": "2024-01-15",
"endDate": "2024-01-30"
}
],
"loyaltyPrograms": [
{
"nameLangs": [
{
"languageCode": "EN-US",
"value": "DerbySoft Rewards"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Earn points for every stay, redeemable for free nights, upgrades and exclusive benefits"
}
],
"travelSector": "HOSPITALITY"
}
],
"refPoints": [
{
"id": "RP001",
"nameLangs": [
{
"languageCode": "EN-US",
"value": "Los Angeles International Airport (LAX)"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Major international airport serving Los Angeles"
}
],
"detailLangs": [
{
"languageCode": "EN-US",
"value": "15 minutes from the hotel by car"
}
],
"indexPointCode": "AIRPORT",
"categoryCode": "TRANSPORTATION",
"direction": "SW",
"distance": "10",
"countryCode": "US",
"stateCode": "CA",
"cityCode": "100",
"position": {
"latitude": 33.9425,
"longitude": -118.4081,
"positionAccuracyCode": "1"
},
"unit": "KM",
"nearest": false,
"primary": true,
"sort": 1,
"toFrom": "HOTEL",
"transportations": [
{
"code": "SHUTTLE",
"chargeUnitCode": "PER_PERSON",
"chargeFrequencyCode": "PER_TRIP",
"chargeAmount": "25",
"currencyCode": "USD",
"included": false,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Hotel shuttle service to/from LAX"
}
],
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Shuttles depart every hour from 5:00 AM to 10:00 PM"
}
],
"schedules": [
{
"start": "2024-01-01",
"end": "2024-12-31",
"operationTimes": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "05:00",
"end": "22:00",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Hourly Shuttle Service"
}
]
}
],
"charges": [
{
"amount": 25,
"percent": 0,
"currencyCode": "USD",
"unitCode": "PER_PERSON",
"frequencyCode": "PER_TRIP"
}
]
}
]
}
]
}
],
"attractions": [
{
"id": "AT001",
"categoryCode": "LANDMARK",
"nameLangs": [
{
"languageCode": "EN-US",
"value": "Hollywood Walk of Fame"
}
],
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Famous sidewalk with stars honoring celebrities"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "5 minutes from the hotel by car, 15 minutes by public transport"
}
],
"proximityCode": "NEARBY",
"applicableStart": "2024-01-01",
"applicableEnd": "2024-12-31",
"url": "https://www.walkoffame.com",
"refPoints": [
{
"countryCode": "US",
"stateCode": "CA",
"position": {
"latitude": 34.1016,
"longitude": -118.3265,
"positionAccuracyCode": "1"
},
"direction": "N",
"distance": "3",
"unit": "KM"
}
],
"tags": [
{
"textLangs": [
{
"languageCode": "EN-US",
"value": "Tourist Attraction"
}
]
}
]
}
],
"recreations": [
{
"id": "REC001",
"serviceCode": "FITNESS_CENTER",
"nameLangs": [
{
"languageCode": "EN-US",
"value": "24-Hour Fitness Center"
}
],
"detailLangs": [
{
"languageCode": "EN-US",
"value": "State-of-the-art gym with cardio and strength training equipment"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Complimentary access for hotel guests"
}
],
"proximityCode": "INDOOR",
"included": true,
"schedules": [
{
"start": "2024-01-01",
"end": "2024-12-31",
"operationTimes": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "00:00",
"end": "24:00",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "24/7 Availability"
}
]
}
],
"charges": []
}
],
"services": [
{
"code": "PERSONAL_TRAINING",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Personal Training Sessions"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Available for an additional fee (by appointment only)"
}
]
}
]
}
],
"additionalDescriptions": [
{
"id": "AD001",
"additionalDetailCode": "HOTEL_FEATURES",
"recordId": "FEAT_001",
"sourceId": "HOTEL",
"title": "Hotel Features",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "This luxury hotel offers panoramic city views, personalized concierge service, and proximity to top attractions. All rooms feature premium bedding, flat-screen TVs, and marble bathrooms with rainfall showers."
}
],
"applicableStart": "2024-01-01",
"applicableEnd": "2024-12-31"
}
],
"promotions": [
{
"category": "PACKAGE",
"code": "STAY3_GET1",
"packageTypeCode": "STAY_LONGER",
"titleLangs": [
{
"languageCode": "EN-US",
"value": "Stay 3 Nights, Get 1 Free"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Book 3 consecutive nights and receive the 4th night complimentary. Valid for stays between March 1 and October 31, 2024."
}
],
"minLos": 3,
"sort": 1,
"schedules": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "2024-03-01",
"end": "2024-10-31"
}
]
}
],
"policyInformation": {
"propertyPolicy": {
"acceptedGuestType": "1",
"roomGuaranteedLateArrival": true,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Late arrival guaranteed with credit card. Check-in after midnight requires prior notification."
}
],
"petsAllowed": "YES"
},
"childPolicy": {
"minGuestAge": 0,
"maxChildAge": 12,
"freeCutOffAge": 6,
"freeChildPerAdult": 2,
"kidsStayFree": true
},
"checkOutPolicy": {
"start": "06:00",
"end": "11:00",
"type": "STANDARD",
"chargeNights": 1,
"chargeAmount": 199.00,
"chargePercent": 0,
"currencyCode": "USD",
"balanceOfStay": false,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Late check-out after 11:00 AM subject to availability. 50% of nightly rate charged for check-out between 11:00 AM and 6:00 PM. Full nightly rate charged for check-out after 6:00 PM."
}
]
},
"commissionPolicy": {
"amount": 0,
"percent": 15,
"currencyCode": "USD",
"paymentCompanyLangs": [
{
"languageCode": "EN-US",
"value": "DerbySoft Payment Services"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "15% commission paid to authorized travel agents. Commission payments processed on a monthly basis."
}
]
},
"generalPolicies": [
{
"nameLangs": [
{
"languageCode": "EN-US",
"value": "Smoking Policy"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Hotel is 100% non-smoking. Smoking in guest rooms will result in a $250 cleaning fee."
}
]
}
],
"cancelPolicies": [
{
"code": "C001",
"nonRefundable": false,
"roomTypeCode": "ALL",
"cancelPenalty": {
"taxInclusive": true,
"feeInclusive": true,
"chargeNights": 1,
"chargeAmount": 199.00,
"chargePercent": 0,
"currencyCode": "USD",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "1 night's stay charged for cancellations made less than 48 hours prior to arrival."
}
]
},
"cancelDeadline": {
"absoluteDeadline": "",
"offsetTimeUnit": "HOUR",
"offsetUnitMultiplier": 48,
"offsetDropTimeType": "ARRIVAL"
},
"schedules": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "2024-01-01",
"end": "2024-12-31"
}
]
}
],
"guaranteePaymentPolicies": [
{
"code": "G001",
"type": "CREDIT_CARD",
"retributionType": "CHARGE",
"guaranteeType": "PRE_AUTH",
"roomTypeCode": "ALL",
"nonRefundable": false,
"holdTime": "72",
"offsetTimeUnit": "HOUR",
"offsetUnitMultiplier": 24,
"offsetDropTimeType": "ARRIVAL",
"chargeNights": 1,
"chargeAmount": 199.00,
"chargePercent": 0,
"currencyCode": "USD",
"descriptions": [
{
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Credit card required to guarantee reservation. 1 night's stay pre-authorized 24 hours prior to arrival."
}
]
}
],
"schedules": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "2024-01-01",
"end": "2024-12-31"
}
],
"acceptedPayments": [
{
"guarantee": true,
"paymentTypeCode": "CREDIT_CARD",
"cardTypeCode": "VISA",
"cardTypeDescriptionLangs": [
{
"languageCode": "EN-US",
"value": "Visa Credit Card"
}
]
},
{
"guarantee": true,
"paymentTypeCode": "CREDIT_CARD",
"cardTypeCode": "MASTERCARD",
"cardTypeDescriptionLangs": [
{
"languageCode": "EN-US",
"value": "Mastercard Credit Card"
}
]
}
],
"addresses": [
{
"paymentReceiverName": "DerbySoft DEMO Hotel",
"useTypeCode": "BILLING",
"postalCode": "90015",
"countryCode": "US",
"stateCode": "CA",
"streetNumberPoBoxLangs": [
{
"languageCode": "EN-US",
"value": "1234 Sunset Blvd"
}
],
"countryNameLangs": [
{
"languageCode": "EN-US",
"value": "United States"
}
],
"stateNameLangs": [
{
"languageCode": "EN-US",
"value": "California"
}
],
"cityNameLangs": [
{
"languageCode": "EN-US",
"value": "Los Angeles"
}
],
"addressLines": [
{
"addressLineLangs": [
{
"languageCode": "EN-US",
"value": "1234 Sunset Blvd, Los Angeles, CA 90015"
}
]
}
]
}
]
}
],
"petPolicies": [
{
"code": "P001",
"unit": "KG",
"size": 20,
"maxPetQuantity": 1,
"refundableDeposit": 100.00,
"nonRefundableFee": 50.00,
"chargeUnitCode": "PER_STAY",
"currencyCode": "USD",
"restriction": true,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Pets up to 20kg allowed in designated rooms. $100 refundable deposit and $50 non-refundable cleaning fee required. Pets must be crated when left unattended in the room."
}
]
}
],
"taxPolicies": [
{
"type": "HOTEL_TAX",
"code": "CA_HOTEL_TAX",
"chargeAmount": 0,
"chargePercent": 12,
"currencyCode": "USD",
"effectiveDate": "2024-01-01",
"expireDate": "2024-12-31",
"chargeUnitCode": "PER_NIGHT",
"chargeFrequencyCode": "PER_STAY",
"sort": 1,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "12% hotel occupancy tax applied to all stays. Tax is subject to change without notice."
}
]
}
],
"feePolicies": [
{
"type": "RESORT_FEE",
"code": "RESORT_FEE",
"chargeAmount": 35.00,
"chargePercent": 0,
"currencyCode": "USD",
"effectiveDate": "2024-01-01",
"expireDate": "2024-12-31",
"mandatory": true,
"chargeUnitCode": "PER_NIGHT",
"chargeFrequencyCode": "PER_STAY",
"taxableIndicator": true,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "$35 per night resort fee includes WiFi, pool access, fitness center access and local calls. Fee is taxable."
}
]
}
],
"ratePolicies": [
{
"corporateIdRequired": false,
"type": "PUBLIC",
"identifyRequired": false,
"guestTypeCode": "ALL",
"minRoomNightCommitment": 1,
"rateOfferTypeCode": "STANDARD",
"descriptions": [
{
"nameLangs": [
{
"languageCode": "EN-US",
"value": "Standard Public Rate"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Public rate available to all guests with no restrictions. Includes complimentary breakfast and WiFi."
}
]
}
]
}
],
"checkInPolicy": {
"start": "15:00",
"end": "24:00",
"option": "STANDARD",
"instructionLangs": [
{
"languageCode": "EN-US",
"value": "Check-in begins at 3:00 PM. Early check-in subject to availability. Please contact the hotel in advance to request early check-in."
}
]
}
},
"otherProperties": [
{
"propertyCode": "derbydemo002",
"propertyNameLangs": [
{
"languageCode": "EN-US",
"value": "DerbySoft DEMO - New York"
}
],
"chainCode": "100",
"brandCode": "200",
"segmentCode": "300",
"contextCode": "derbydemo",
"competitor": false
}
],
"propertyMappings": [
{
"sourceCode": "AMADEUS",
"sourceName": "Amadeus GDS",
"sourceType": "GDS",
"propertyCode": "DBSF_LAX",
"chainCode": "100",
"propertyName": "DerbySoft DEMO Hotel Los Angeles",
"propertyShortName": "DerbySoft LAX"
},
{
"sourceCode": "SABRE",
"sourceName": "Sabre GDS",
"sourceType": "GDS",
"propertyCode": "DSLAX123",
"chainCode": "100",
"propertyName": "DerbySoft DEMO Hotel Los Angeles",
"propertyShortName": "DerbySoft LAX"
}
],
"environmentImpact": {
"carbonFootprint": {
"meetingEvent": 50,
"roomNight": 15,
"weatherNormalized": 12,
"unit": "KG_CO2"
},
"water": {
"grayWater": true,
"waterProgram": true,
"perRoomNightUsage": 200,
"perRoomDayUsage": 150,
"wasteDiversionPercentage": 75,
"unit": "LITERS",
"descriptions": [
{
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Hotel implements water conservation program, including low-flow fixtures and gray water recycling."
}
]
}
]
},
"energy": {
"efficientAppliances": true,
"efficientLighting": true,
"heatPowerComb": false,
"heatPump": true,
"powerSavingPolicy": true,
"solar": false,
"temperatureControl": true,
"windTurbine": false,
"energyGenerated": 0,
"energyStarRating": "4",
"energyUsages": [
{
"powerType": "ELECTRICITY",
"unit": "KWH",
"quantity": 50000,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Monthly electricity consumption (average)"
}
]
}
]
},
"recycling": {
"activeProgram": true,
"ecologicalDishware": true,
"descriptions": [
{
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Comprehensive recycling program for paper, plastic, glass and metal. Biodegradable dishware used in restaurants and events."
}
]
}
]
},
"environmentGeneral": {
"certificationAvail": true,
"chemicalAllergies": true,
"environmentCleaner": true,
"linenReuse": true,
"procurementPolicy": true,
"certifications": [
{
"nameLangs": [
{
"languageCode": "EN-US",
"value": "LEED Silver Certification"
}
]
}
],
"environments": [
{
"nameLangs": [
{
"languageCode": "EN-US",
"value": "Sustainable Operations Program"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Hotel is committed to reducing environmental impact through sustainable operations and responsible sourcing."
}
]
}
]
}
},
"viewerShips": [
{
"distributorCode": "BOOKING",
"distributorTypeCode": "OTA",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Booking.com - Global OTA Distribution Channel"
}
]
},
{
"distributorCode": "EXPEDIA",
"distributorTypeCode": "OTA",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Expedia Group - Global OTA Distribution Channel"
}
]
},
{
"distributorCode": "AMADEUS",
"distributorTypeCode": "GDS",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Amadeus GDS - Travel Agent Distribution Channel"
}
]
}
],
"images": [
{
"mainUrl": "https://www.derbysoftdemo.com/images/exterior.jpg",
"richMediaUrl": "https://www.derbysoftdemo.com/videos/exterior.mp4",
"categoryCode": "1",
"sort": 1,
"sourceId": "IMG_001",
"captionLangs": [
{
"languageCode": "EN-US",
"value": "Hotel Exterior"
}
],
"applicableStart": "2024-01-01",
"applicableEnd": "2024-12-31",
"items": [
{
"url": "https://www.derbysoftdemo.com/images/exterior-large.jpg",
"width": 1920,
"height": 1080,
"size": "LARGE",
"unit": "PIXEL",
"fileSize": 2048,
"resolution": 300,
"recordId": "IMG_ITEM_001",
"formatCode": "JPG"
},
{
"url": "https://www.derbysoftdemo.com/images/exterior-small.jpg",
"width": 640,
"height": 360,
"size": "SMALL",
"unit": "PIXEL",
"fileSize": 512,
"resolution": 72,
"recordId": "IMG_ITEM_002",
"formatCode": "JPG"
}
],
"lastUpdated": "2024-01-01"
},
{
"mainUrl": "https://www.derbysoftdemo.com/images/room.jpg",
"richMediaUrl": "https://www.derbysoftdemo.com/videos/room.mp4",
"categoryCode": "2",
"sort": 2,
"sourceId": "IMG_002",
"captionLangs": [
{
"languageCode": "EN-US",
"value": "Deluxe King Room"
}
],
"applicableStart": "2024-01-01",
"applicableEnd": "2024-12-31",
"items": [
{
"url": "https://www.derbysoftdemo.com/images/room-large.jpg",
"width": 1920,
"height": 1080,
"size": "LARGE",
"unit": "PIXEL",
"fileSize": 1800,
"resolution": 300,
"recordId": "IMG_ITEM_003",
"formatCode": "JPG"
}
],
"lastUpdated": "2024-01-01"
}
],
"host": {
"id": "HOST_001",
"name": "John Smith",
"introductionLangs": [
{
"languageCode": "EN-US",
"value": "With over 15 years of hospitality experience, John leads the hotel team in delivering exceptional guest service."
}
],
"jobLangs": [
{
"languageCode": "EN-US",
"value": "General Manager"
}
]
},
"extensions": {
"additionalProp1": "WiFi_SPEED=1Gbps",
"additionalProp2": "SMOKING_POLICY=NON_SMOKING",
"additionalProp3": "PARKING_FEE=35_USD_PER_DAY"
},
"contextCode": "derbydemo",
"supplierCode": "DERBYHOTEL",
"propertyCode": "derbydemo001",
"operateStatus": "ENABLED",
"richMedia": {
"url": "https://www.derbysoftdemo.com/videos/hotel-overview.mp4"
}
}Error Response (HTTP Status 403)
{
"error": {
"code": "FORBIDDEN",
"message": "Lack of permissions, please configure permissions."
}
}Error Response (HTTP Status 400)
{
"error": {
"code": "InvalidField",
"message": "Invalid [contextCode] value [contextCode is required.]."
}
}POST Property Content
This API performs a full update of property content in the system, replacing all existing data with the new submission within a specified context.
API Endpoints & Methods
| Base URL: https://contentsolutions-supplier.derbysoftsec.com | |
|---|---|
HTTP method | URL |
POST | /api/content/properties |
Headers
Name | Type | Required | Description | Example |
|---|---|---|---|---|
Authorization | String | required | Basic Authentication token for API access. | Basic Vz********MTI= |
Content-Type | String | required | Specifies the media type of the request. | application/json;charset=UTF-8 |
Query Parameters
Importance:
To locate vacation rental-specific parameters (e.g., host, checkin)
1. Press Ctrl+F (Windows) or Cmd+F (Mac)
2. Search for the tag in description column: [Vacation rental API fields]
| Parameter | Required | Type | Description | Example |
|---|---|---|---|---|
| contextCode | Yes | String | derbydemo | |
| supplierCode | Yes | String | DERBYHOTEL | |
| propertyCode | Yes | String | derbydemo001 | |
| operateStatus | Yes | Enum<EnableStatus> | ENABLED | |
| basicInformation | Yes(create properties) | Object<PropertyBasicInformation> | Basic information about the property. | |
| basicInformation.propertyNameLangs | Yes(create properties) | List<I18N> | Name of the property. | DerbySoft Demo Hotel |
| basicInformation.propertyShortNameLangs | List<I18N> | Short name for the property. | Derby Demo | |
| basicInformation.propertyDescriptionLangs | List<I18N> | Description of the property. | A modern hotel located in the heart of the city, offering premium services and amenities. | |
| basicInformation.status | Enum<PropertyStatus> | Current status of the property. Enum: [ OPEN, CLOSED, PRE_OPENING, DE_FLAGGED, TEST, INACTIVATE, REACTIVATED, DELETED, LOCKED, UNLOCKED ] | OPEN | |
| basicInformation.hotelCityCode | String | Hotel city ode | ||
| basicInformation.countryCode | String | Country code (ISO format). | US | |
| basicInformation.chainCode | String | Unique identifier for the property chain. | DERBYCHAIN | |
| basicInformation.chainNameLangs | List<I18N> | Name of the property chain. | ||
| basicInformation.brandCode | String | Unique identifier for the property brand. | DERBYBRAND | |
| basicInformation.brandNameLangs | List<I18N> | Name of the property brand. | ||
| basicInformation.timeZone | String | Time zone for the property location. | ||
| basicInformation.currencyCode | String | Currency code for the charge. | USD | |
| basicInformation.whenBuilt | Date Format: yyyy | The property build date. Date Format: yyyy | ||
| basicInformation.preSellDate | Date Format: yyyy-MM-dd | The property pre sell date. Date Format: yyyy-MM-dd | ||
| basicInformation.firstOpenDate | Date Format: yyyy-MM-dd | The property first opening date. Date Format: yyyy-MM-dd | ||
| basicInformation.renovations | List<Renovation> | List of renovations done to the property. | ||
| basicInformation.renovations.completionDate | Date Format: yyyy | The property renovation completion date. Date Format: yyyy | ||
| basicInformation.renovations.descriptionLangs | List<I18N> | The property renovation description. | ||
| basicInformation.floors | List<FloorRange> | List of floor ranges in the property. | ||
| basicInformation.floors.start | Integer | Starting floor number of the property. | ||
| basicInformation.floors.end | Integer | Ending floor number (top floor) of the property. | ||
| basicInformation.propertyCategories | List<Category> | List of property categories (e.g., luxury, economy). | ||
| basicInformation.propertyCategories.code | String | Specifies the property class type code. | ||
| basicInformation.propertyCategories.detailLangs | List<I18N> | Description of the category in multiple languages. | ||
| basicInformation.segmentCategories | List<Category> | Segmentation of the property type (e.g., extended stay, economy). | ||
| basicInformation.segmentCategories.code | String | Specifies the type of property such as luxury, extended stay, economy. | ||
| basicInformation.segmentCategories.detailLangs | List<I18N> | Description of the segment in multiple languages. | ||
| basicInformation.locationCategories | List<Category> | Categories describing the property’s location (e.g., airport, suburban). | ||
| basicInformation.locationCategories.code | String | Specifies the general location of the property such as airport, suburban, downtown. | ||
| basicInformation.locationCategories.detailLangs | List<I18N> | Description of the location category in multiple languages. | ||
| basicInformation.position | Object<Position> | Geolocation information for the property. | ||
| basicInformation.position.latitude | Yes(create property) | String | Latitude coordinate for the property. | |
| basicInformation.position.longitude | Yes(create property) | String | Longitude coordinate for the property. | |
| basicInformation.position.positionAccuracyCode | String | Accuracy of the geo-coding for the reference point. Refer to OpenTravel Code List Position Accuracy Code (PAC). | ||
| basicInformation.contacts | Object<ContactInfo> | Contact information for the property. | ||
| basicInformation.contacts.companyNameLangs | List<I18N> | Company name in multiple languages. | ||
| basicInformation.contacts.departmentLangs | List<I18N> | The department name or ID with which the contact is associated. | ||
| basicInformation.contacts.addresses | List<Address> | List of addresses for the property. | ||
| basicInformation.contacts.addresses.useTypeCode | String | Describes the use of the address (e.g. mailing, delivery, billing, etc.). Refer to OpenTravel Code List Address Use Type (AUT). | ||
| basicInformation.contacts.addresses.postalCode | String | Postal code for the address. | ||
| basicInformation.contacts.addresses.countryCode | String | Country code (ISO format). | ||
| basicInformation.contacts.addresses.stateCode | String | State or province code. | ||
| basicInformation.contacts.addresses.cityCode | String | City code for the address. | ||
| basicInformation.contacts.addresses.countryNameLangs | List<I18N> | Country name in multiple languages. | ||
| basicInformation.contacts.addresses.stateNameLangs | List<I18N> | State or province name. | ||
| basicInformation.contacts.addresses.cityNameLangs | List<I18N> | City name in multiple languages. | ||
| basicInformation.contacts.addresses.countyNameLangs | List<I18N> | County name in multiple languages. | ||
| basicInformation.contacts.addresses.addressLines | List<AddressLine> | Address lines (e.g., street address). | ||
| basicInformation.contacts.addresses.addressLines.addressLineLangs | List<I18N> | Address lines details (e.g., street address). | ||
| basicInformation.contacts.phones | List<Phone> | Phone numbers for contacting the property. | ||
| basicInformation.contacts.phones.locationType | String | Describes the location of the phone, such as Home, Office, Property Reservation Office, etc. Refer to OpenTravel Code List Phone Location Type (PLT). | ||
| basicInformation.contacts.phones.techType | String | Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List Phone Technology Type (PTT). | ||
| basicInformation.contacts.phones.countryAccessCode | String | Code assigned by telecommunications authorities for international country access identifier. | ||
| basicInformation.contacts.phones.areaCityCode | String | Code assigned for telephones in a specific region, city, or area. | ||
| basicInformation.contacts.phones.phoneNumber | String | Telephone number assigned to a single location. | ||
| basicInformation.contacts.emails | List<Email> | Email addresses for the property contact. | ||
| basicInformation.contacts.emails.type | String | Defines the purpose of the e-mail address (e.g. personal, business, listserve). | ||
| basicInformation.contacts.emails.address | String | The email address. | ||
| basicInformation.contacts.urls | List<String> | Provides a Website address. | ||
| basicInformation.capacities | List<GuestRoomInfoCapacity> | |||
| basicInformation.capacities.code | String | The types and quantities of guest rooms at a property. | ||
| basicInformation.capacities.detailLangs | List<I18N> | May be used to give further detail on the code. | ||
| basicInformation.capacities.quantity | Integer | Specifies the number of guest rooms. | ||
| basicInformation.awards | List<Award> | Awards received by the property. | ||
| basicInformation.awards.date | Date Format: yyyy-MM-dd | The date the award was received. | ||
| basicInformation.awards.providerLangs | List<I18N> | The name of the award or ratings provider (e.g., Michelin, American Automobile Association (AAA)). | ||
| basicInformation.awards.ratingLangs | List<I18N> | The actual award or rating received by the property facility (e.g. 4 stars, 3 diamonds). If used in conjunction with RatingSymbol only the numeric rating would be passed here. | ||
| basicInformation.awards.officialAppointment | Boolean | Indicates whether the property has permission to use the award in publications. | ||
| basicInformation.awards.ratingSymbol | String | Provides the symbol used in the rating. Used in conjunction with the Rating | ||
| basicInformation.spokenLanguages | List<SpokenLanguage> | Language spoken by the property staff. | ||
| basicInformation.spokenLanguages.primaryLanguage | Boolean | List of property spoken languages. | ||
| basicInformation.spokenLanguages.languageCode | String | Primary language spoken at property. | ||
| basicInformation.labels | List<Label> | |||
| basicInformation.labels.code | String | |||
| basicInformation.labels.descriptionLangs | List<I18N> | |||
| basicInformation.goIds | List<GoId> | |||
| basicInformation.goIds.channelCode | String | |||
| basicInformation.goIds.id | String | |||
| basicInformation.richMedias | List<RichMedia> | |||
| basicInformation.richMedias.url | String | |||
| basicInformation.lastUpdated | String | |||
| basicInformation.facilityLastUpdated | String | |||
| basicInformation.policyLastUpdated | String | |||
| basicInformation.referencePointLastUpdated | String | |||
| basicInformation.attractionsLastUpdated | String | |||
| basicInformation.recreationLastUpdated | String | |||
| basicInformation.otherHotelsLastUpdated | String | |||
| basicInformation.affiliationsLastUpdated | String | |||
| basicInformation.imagesLastUpdated | String | |||
| basicInformation.masterChainCode | String | |||
| basicInformation.generalUnit | String | |||
| basicInformation.generalWeightUnit | String | |||
| basicInformation.generalAreaUnit | String | |||
| basicInformation.generalDistanceUnit | String | |||
| facilityInformation | Object<FacilityInformation> | Information about the amenities and services available at the property. | ||
| facilityInformation.amenities | List<Amenity> | List of amenities available at the property. | ||
| facilityInformation.amenities.id | String | Unique ID for the amenity. | ||
| facilityInformation.amenities.code | String | Refer to OpenTravel Code List property Amenity Code (HAC). | ||
| facilityInformation.amenities.detailLangs | List<I18N> | May be used to give further detail on the code. | ||
| facilityInformation.amenities.descriptionLangs | List<I18N> | Descriptive text that describes the service. | ||
| facilityInformation.amenities.included | Boolean | This may be used to identify a standard service included in the room rate. | ||
| facilityInformation.amenities.proximityCode | String | Denotes whether a service is onsite, offsite or information is not available. Refer to OpenTravel Code Table Proximity (PRX). | ||
| facilityInformation.amenities.quantity | Integer | Denotes the total number of service items identified by the Code attribute. | ||
| facilityInformation.amenities.operationSchedules | List<OperationScheduleDate> | Defines service availability, including operating dates, hours, and applicable fees. | ||
| facilityInformation.amenities.operationSchedules.start | String | Start date. Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22. | ||
| facilityInformation.amenities.operationSchedules.end | String | End date. Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22. | ||
| facilityInformation.amenities.operationSchedules.operationTimes.weekDays | List<String> | Day of operation. Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ] | ||
| facilityInformation.amenities.operationSchedules.operationTimes.start | String | Start time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| facilityInformation.amenities.operationSchedules.operationTimes.end | String | End time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| facilityInformation.amenities.operationSchedules.operationTimes.descriptionLangs | List<I18N> | |||
| facilityInformation.amenities.operationSchedules.charges | List<ServiceCharge> | Charges for the amenity. | ||
| facilityInformation.amenities.operationSchedules.charges.amount | Double | A monetary amount. | ||
| facilityInformation.amenities.operationSchedules.charges.percent | Double | Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). | ||
| facilityInformation.amenities.operationSchedules.charges.currencyCode | String | Currency code for the charge. | ||
| facilityInformation.amenities.operationSchedules.charges.unitCode | String | This is the unit for which the charge applies (e.g. room, person, seat). Refer to OpenTravel Code List Charge Type (CHG). | ||
| facilityInformation.amenities.operationSchedules.charges.frequencyCode | String | This is the timeframe used to apply the charge during the course of the reservation (e.g. Daily, Weekly, Stay). Refer to OpenTravel Code List Charge Type (CHG). | ||
| facilityInformation.businessServices | List<Amenity> | List of business services available at the property. | ||
| facilityInformation.businessServices.id | String | Unique ID for the business service. | ||
| facilityInformation.businessServices.code | String | Refer to OpenTravel Code List property Business Code (HAC). | ||
| facilityInformation.businessServices.detailLangs | List<I18N> | May be used to give further detail on the code. | ||
| facilityInformation.businessServices.descriptionLangs | List<I18N> | Descriptive text that describes the service. | ||
| facilityInformation.businessServices.included | Boolean | This may be used to identify a standard service included in the room rate. | ||
| facilityInformation.businessServices.proximityCode | String | Denotes whether a service is onsite, offsite or information is not available. Refer to OpenTravel Code Table Proximity (PRX). | ||
| facilityInformation.businessServices.quantity | Integer | Denotes the total number of service items identified by the Code attribute. | ||
| facilityInformation.businessServices.operationSchedules | List<OperationScheduleDate> | Defines service availability, including operating dates, hours, and applicable fees. | ||
| facilityInformation.businessServices.operationSchedules.start | String | Start date. Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22. | ||
| facilityInformation.businessServices.operationSchedules.end | String | End date. Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22. | ||
| facilityInformation.businessServices.operationSchedules.operationTimes | List<OperationScheduleTime> | List of operation times. | ||
| facilityInformation.businessServices.operationSchedules. operationTimes.weekDays | List<String> | Day of operation. Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ] | ||
| facilityInformation.businessServices.operationSchedules. operationTimes.start | String | Start time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| facilityInformation.businessServices.operationSchedules. operationTimes.end | String | End time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| facilityInformation.businessServices.operationSchedules.charges | List<ServiceCharge> | Charges for the service. | ||
| facilityInformation.businessServices.operationSchedules.charges.amount | Double | A monetary amount. | ||
| facilityInformation.businessServices.operationSchedules.charges.percent | Double | Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). | ||
| facilityInformation.businessServices.operationSchedules. charges.currencyCode | String | Currency code for the charge. | ||
| facilityInformation.businessServices.operationSchedules.charges.unitCode | String | This is the unit for which the charge applies (e.g. room, person, seat). Refer to OpenTravel Code List Charge Type (CHG). | ||
| facilityInformation.businessServices.operationSchedules. charges.frequencyCode | String | This is the timeframe used to apply the charge during the course of the reservation (e.g. Daily, Weekly, Stay). Refer to OpenTravel Code List Charge Type (CHG). | ||
| facilityInformation.meetingServices | List<Amenity> | List of meeting services available at the property. | ||
| facilityInformation.meetingServices.id | String | Unique ID for the meeting service. | ||
| facilityInformation.meetingServices.code | String | Refer to OpenTravel Code List property MeetingRoom Code (MRC). | ||
| facilityInformation.meetingServices.detailLangs | List<I18N> | May be used to give further detail on the code. | ||
| facilityInformation.meetingServices.descriptionLangs | List<I18N> | Descriptive text that describes the service. | ||
| facilityInformation.meetingServices.included | Boolean | This may be used to identify a standard service included in the room rate. | ||
| facilityInformation.meetingServices.proximityCode | String | Denotes whether a service is onsite, offsite or information is not available. Refer to OpenTravel Code Table Proximity (PRX). | ||
| facilityInformation.meetingServices.quantity | Integer | Denotes the total number of service items identified by the Code attribute. | ||
| facilityInformation.meetingServices.operationSchedules | List<OperationScheduleDate> | Defines service availability, including operating dates, hours, and applicable fees. | ||
| facilityInformation.meetingServices.operationSchedules.start | String | Start date. Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22. | ||
| facilityInformation.meetingServices.operationSchedules.end | String | End date. Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22. | ||
| facilityInformation.meetingServices.operationSchedules.operationTimes | List<OperationScheduleTime> | List of operation times. | ||
| facilityInformation.meetingServices.operationSchedules. operationTimes.weekDays | List<String> | Day of operation. Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ] | ||
| facilityInformation.meetingServices.operationSchedules.operationTimes.start | String | Start time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| facilityInformation.meetingServices.operationSchedules.operationTimes.end | String | End time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| facilityInformation.meetingServices.operationSchedules.charges | List<ServiceCharge> | Charges for the service. | ||
| facilityInformation.meetingServices.operationSchedules.charges.amount | Double | A monetary amount. | ||
| facilityInformation.meetingServices.operationSchedules.charges.percent | Double | Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). | ||
| facilityInformation.meetingServices.operationSchedules.charges.currencyCode | String | Currency code for the charge. | ||
| facilityInformation.meetingServices.operationSchedules.charges.unitCode | String | This is the unit for which the charge applies (e.g. room, person, seat). Refer to OpenTravel Code List Charge Type (CHG). | ||
| facilityInformation.meetingServices.operationSchedules.charges.frequencyCode | String | This is the timeframe used to apply the charge during the course of the reservation (e.g. Daily, Weekly, Stay). Refer to OpenTravel Code List Charge Type (CHG). | ||
| facilityInformation.mealServices | List<Amenity> | List of meals available at the property. | ||
| facilityInformation.mealServices.id | String | Unique ID for the meal service. | ||
| facilityInformation.mealServices.code | String | Refer to OpenTravel Code List property MealPlan Code (MPT). | ||
| facilityInformation.mealServices.detailLangs | List<I18N> | May be used to give further detail on the code. | ||
| facilityInformation.mealServices.descriptionLangs | List<I18N> | Descriptive text that describes the service. | ||
| facilityInformation.mealServices.included | Boolean | This may be used to identify a standard service included in the room rate. | ||
| facilityInformation.mealServices.proximityCode | String | Denotes whether a service is onsite, offsite or information is not available. Refer to OpenTravel Code Table Proximity (PRX). | ||
| facilityInformation.mealServices.quantity | Integer | Denotes the total number of service items identified by the Code attribute. | ||
| facilityInformation.mealServices.operationSchedules | List<OperationScheduleDate> | Defines service availability, including operating dates, hours, and applicable fees. | ||
| facilityInformation.mealServices.operationSchedules.start | String | Start date. Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22. | ||
| facilityInformation.mealServices.operationSchedules.end | string | End date. Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22. | ||
| facilityInformation.mealServices.operationSchedules.operationTimes | List<OperationScheduleTime> | List of operation times. | ||
| facilityInformation.mealServices.operationSchedules. operationTimes.weekDays | List<String> | Day of operation. Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ] | ||
| facilityInformation.mealServices.operationSchedules.operationTimes.start | String | Start time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| facilityInformation.mealServices.operationSchedules.operationTimes.end | String | End time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| facilityInformation.mealServices.operationSchedules.charges | List<ServiceCharge> | Charges for the service. | ||
| facilityInformation.mealServices.operationSchedules.charges.amount | Double | A monetary amount. | ||
| facilityInformation.mealServices.operationSchedules.charges.percent | Double | Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). | ||
| facilityInformation.mealServices.operationSchedules.charges.currencyCode | String | Currency code for the charge. | ||
| facilityInformation.mealServices.operationSchedules.charges.unitCode | String | This is the unit for which the charge applies (e.g. room, person, seat). Refer to OpenTravel Code List Charge Type (CHG). | ||
| facilityInformation.mealServices.operationSchedules.charges.frequencyCode | String | This is the timeframe used to apply the charge during the course of the reservation (e.g. Daily, Weekly, Stay). Refer to OpenTravel Code List Charge Type (CHG). | ||
| facilityInformation.accessibleService | Amenity | |||
| facilityInformation.accessibleService.id | String | |||
| facilityInformation.accessibleService.code | String | |||
| facilityInformation.accessibleService.detailLangs | List<I18N> | |||
| facilityInformation.accessibleService.descriptionLangs | List<I18N> | Descriptive text that describes the service. | ||
| facilityInformation.accessibleService.included | Boolean | |||
| facilityInformation.accessibleService.proximityCode | String | |||
| facilityInformation.accessibleService.quantity | Integer | |||
| facilityInformation.accessibleService.operationSchedules | List<OperationScheduleDate> | Defines service availability, including operating dates, hours, and applicable fees. | ||
| facilityInformation.accessibleService.operationSchedules.start | String | Start date. Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22. | ||
| facilityInformation.accessibleService.operationSchedules.end | string | End date. Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22. | ||
| facilityInformation.accessibleService.operationSchedules.operationTimes | List<OperationScheduleTime> | List of operation times. | ||
| facilityInformation.accessibleService.operationSchedules. operationTimes.weekDays | List<String> | Day of operation. Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ] | ||
| facilityInformation.accessibleService.operationSchedules. operationTimes.start | String | Start time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| facilityInformation.accessibleService.operationSchedules.operationTimes.end | String | End time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| facilityInformation.accessibleService.operationSchedules.charges | List<ServiceCharge> | Charges for the service. | ||
| facilityInformation.accessibleService.operationSchedules.charges.amount | Double | A monetary amount. | ||
| facilityInformation.accessibleService.operationSchedules.charges.percent | Double | Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). | ||
| facilityInformation.accessibleService.operationSchedules. charges.currencyCode | String | Currency code for the charge. | ||
| facilityInformation.accessibleService.operationSchedules.charges.unitCode | String | This is the unit for which the charge applies (e.g. room, person, seat). Refer to OpenTravel Code List Charge Type (CHG). | ||
| facilityInformation.accessibleService.operationSchedules. charges.frequencyCode | String | This is the timeframe used to apply the charge during the course of the reservation (e.g. Daily, Weekly, Stay). Refer to OpenTravel Code List Charge Type (CHG). | ||
| facilityInformation.accessibleService.features | List<Feature> | List of accessibility features available at the property. | ||
| facilityInformation.accessibleService.features.id | String | Unique ID for the accessibility feature. | ||
| facilityInformation.accessibleService.features.code | String | Refer to OpenTravel Code List Disability Feature Code (PHY). | ||
| facilityInformation.accessibleService.features.detailLangs | List<I18N> | May be used to give further detail on the code. | ||
| facilityInformation.accessibleService.features.quantity | Integer | This is the numeric value associated with the measurement. | ||
| facilityInformation.accessibleService.features.unit | String | Unit of measure code based on OpenTravel Unit of Measure Code (UOM). | ||
| facilityInformation.accessibleService.features.chargeCurrencyCode | String | Currency code for the charge. | ||
| facilityInformation.accessibleService.features.chargeAmount | Double | A monetary amount. | ||
| facilityInformation.accessibleService.features.descriptionLangs | List<I18N> | Descriptions of the accessibility feature in multiple languages. | ||
| facilityInformation.securityService | Amenity | |||
| facilityInformation.securityService.id | String | |||
| facilityInformation.securityService.code | String | |||
| facilityInformation.securityService.detailLangs | List<I18N> | |||
| facilityInformation.securityService.descriptionLangs | List<I18N> | Descriptive text that describes the service. | ||
| facilityInformation.securityService.included | Boolean | |||
| facilityInformation.securityService.proximityCode | String | |||
| facilityInformation.securityService.quantity | Integer | |||
| facilityInformation.securityService.operationSchedules | List<OperationScheduleDate> | Defines service availability, including operating dates, hours, and applicable fees. | ||
| facilityInformation.securityService.operationSchedules.start | String | Start date. Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22. | ||
| facilityInformation.securityService.operationSchedules.end | string | End date. Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22. | ||
| facilityInformation.securityService.operationSchedules.operationTimes | List<OperationScheduleTime> | List of operation times. | ||
| facilityInformation.securityService.operationSchedules. operationTimes.weekDays | List<String> | Day of operation. Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ] | ||
| facilityInformation.securityService.operationSchedules.operationTimes.start | String | Start time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| facilityInformation.securityService.operationSchedules.operationTimes.end | String | End time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| facilityInformation.securityService.operationSchedules.charges | List<ServiceCharge> | Charges for the service. | ||
| facilityInformation.securityService.operationSchedules.charges.amount | Double | A monetary amount. | ||
| facilityInformation.securityService.operationSchedules.charges.percent | Double | Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). | ||
| facilityInformation.securityService.operationSchedules.charges.currencyCode | String | Currency code for the charge. | ||
| facilityInformation.securityService.operationSchedules.charges.unitCode | String | This is the unit for which the charge applies (e.g. room, person, seat). Refer to OpenTravel Code List Charge Type (CHG). | ||
| facilityInformation.securityService.operationSchedules.charges.frequencyCode | String | This is the timeframe used to apply the charge during the course of the reservation (e.g. Daily, Weekly, Stay). Refer to OpenTravel Code List Charge Type (CHG). | ||
| facilityInformation.securityService.features | List<Feature> | List of security features available at the property. | ||
| facilityInformation.securityService.features.id | String | Unique ID for the security feature. | ||
| facilityInformation.securityService.features.code | String | Refer to OpenTravel Code List Security Feature Code (SEC). | ||
| facilityInformation.securityService.features.detailLangs | List<I18N> | May be used to give further detail on the code. | ||
| facilityInformation.securityService.features.quantity | Integer | This is the numeric value associated with the measurement. | ||
| facilityInformation.securityService.features.unit | String | Unit of measure code based on OpenTravel Unit of Measure Code (UOM). | ||
| facilityInformation.securityService.features.chargeCurrencyCode | String | Currency code for the charge. | ||
| facilityInformation.securityService.features.chargeAmount | Double | A monetary amount. | ||
| facilityInformation.securityService.features.descriptionLangs | List<I18N> | Descriptions of the security feature in multiple languages. | ||
| meetingRoomInformation | Object<MeetingRoomInformation> | Information related to meeting rooms at the property. | ||
| meetingRoomInformation.total | Integer | Total number of meeting rooms available at the property. | ||
| meetingRoomInformation.totalRoomSpace | Double | Total room space provided at the property (grand ballroom counted as one). | ||
| meetingRoomInformation.totalSeatingCapacity | Integer | Total seating capacity available for meetings at the property. | ||
| meetingRoomInformation.largestRoomSpace | Double | Room space of the largest meeting room at the property. | ||
| meetingRoomInformation.smallestRoomSpace | Double | Room space of the smallest meeting room at the property. | ||
| meetingRoomInformation.largestSeatingCapacity | Integer | Largest seating capacity for the biggest meeting room, usually for theatre-style setups. | ||
| meetingRoomInformation.smallestSeatingCapacity | Integer | Smallest seating capacity for a meeting room. | ||
| meetingRoomInformation.unit | String | Unit of measure code based on OpenTravel Unit of Measure Code (UOM). | ||
| meetingRoomInformation.meetingRooms | List<MeetingRoom> | List of meeting rooms at the property. | ||
| meetingRoomInformation.meetingRooms.id | String | Unique identifier for the meeting room. | ||
| meetingRoomInformation.meetingRooms.nameLangs | List<I18N> | Names of the meeting room in multiple languages. | ||
| meetingRoomInformation.meetingRooms.dimension | Object<MeetingRoomDimension> | Details on the dimensions of the meeting room. | ||
| meetingRoomInformation.meetingRooms.dimension.area | Double | Area of the meeting room in square units. | ||
| meetingRoomInformation.meetingRooms.dimension.height | Double | Height of the meeting room. | ||
| meetingRoomInformation.meetingRooms.dimension.length | Double | Length of the meeting room. | ||
| meetingRoomInformation.meetingRooms.dimension.width | Double | Width of the meeting room. | ||
| meetingRoomInformation.meetingRooms.dimension.unit | String | Unit of measure code based on OpenTravel Unit of Measure Code (UOM). | ||
| meetingRoomInformation.meetingRooms.capacities | List<MeetingRoomFormat> | Capacities for different types of setups in the meeting room (e.g., boardroom, theatre). | ||
| meetingRoomInformation.meetingRooms.capacities.formatCode | String | Defines the type of the meeting room being described (eg. boardroom, ballroom, exhibit space). Refer to OpenTravel Codelist Meeting Room Format Code (MRF). | ||
| meetingRoomInformation.meetingRooms.capacities.maxOccupancy | Integer | The total number of people permitted in the meeting room. | ||
| meetingRoomInformation.meetingRooms.services | List<MeetingRoomService> | Services available in the meeting room (e.g., projector, whiteboard). | ||
| meetingRoomInformation.meetingRooms.services.code | String | This is used to define items that may be available for any of the meeting rooms. Refer to OpenTravel Code List Meeting Room Code (MRC). | ||
| meetingRoomInformation.meetingRooms.services.detailLangs | List<I18N> | May be used to give further detail on the code. | ||
| meetingRoomInformation.meetingRooms.services.quantity | Integer | Used to define the quantity for an associated element or attribute. | ||
| meetingRoomInformation.meetingRooms.services.chargePercent | Double | Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). | ||
| meetingRoomInformation.meetingRooms.services.chargeAmount | Double | A monetary amount. | ||
| meetingRoomInformation.meetingRooms.services.chargeCurrencyCode | String | |||
| meetingRoomInformation.meetingRooms.services.chargeUnitCode | String | This is the unit for which the charge applies (e.g. room, person, seat). Refer to OpenTravel Code List Charge Type (CHG). | ||
| meetingRoomInformation.meetingRooms.services.chargeFrequencyCode | String | This is the timeframe used to apply the charge during the course of the reservation (e.g. Daily, Weekly, Stay). Refer to OpenTravel Code List Charge Type (CHG). | ||
| meetingRoomInformation.meetingRooms.images | List<Image> | Collection of multimedia images. | ||
| meetingRoomInformation.meetingRooms.images.categoryCode | String | Image category. Refer to OpenTravel Picture Category Code (PIC). | ||
| meetingRoomInformation.meetingRooms.images.sort | Integer | Display order of images. | ||
| meetingRoomInformation.meetingRooms.images.sourceId | String | Unique ID of the image source (e.g., original file identifier). | ||
| meetingRoomInformation.meetingRooms.images.captionLangs | List<I18N> | Multilingual image captions. | ||
| meetingRoomInformation.meetingRooms.images.applicableStart | Date Format: yyyy-MM-dd | Start date or recurring start period when the image is relevant (e.g., season start). | ||
| meetingRoomInformation.meetingRooms.images.applicableEnd | Date Format: yyyy-MM-dd | End date or recurring end period when the image is relevant (e.g., season end). | ||
| meetingRoomInformation.meetingRooms.images.mainUrl | The main image url is required. | |||
| meetingRoomInformation.meetingRooms.images.items | List<ImageItem> | List of image file variations. | ||
| meetingRoomInformation.meetingRooms.images.items.url | String | URL of the image. | ||
| meetingRoomInformation.meetingRooms.images.items.width | Integer | Image width (unit defined by UOM). | ||
| meetingRoomInformation.meetingRooms.images.items.height | Integer | Image height (unit defined by UOM). | ||
| meetingRoomInformation.meetingRooms.images.items.size | String | Image file size (e.g., MB, KB). | ||
| meetingRoomInformation.meetingRooms.images.items.unit | String | Unit of measurement. Refer to OpenTravel Unit of Measure (UOM). | ||
| meetingRoomInformation.meetingRooms.images.items.fileSize | Integer | File size in bytes. | ||
| meetingRoomInformation.meetingRooms.images.items.formatCode | String | Image format (e.g., JPEG, PNG). Refer to OpenTravel Content Format Code (CFC). | ||
| restaurantInformation | Object<RestaurantInformation> | Information related to restaurants at the property. | ||
| restaurantInformation.total | Integer | Total number of restaurants at the property. | ||
| restaurantInformation.restaurants | List<Restaurant> | List of restaurants at the property. | ||
| restaurantInformation.restaurants.id | String | Unique identifier for the restaurant. | ||
| restaurantInformation.restaurants.nameLangs | List<I18N> | Names of the restaurant in multiple languages. | ||
| restaurantInformation.restaurants.descriptionLangs | List<I18N> | Descriptions of the restaurant in different languages. | ||
| restaurantInformation.restaurants.maxCapacity | Integer | Maximum seating capacity of the restaurant. | ||
| restaurantInformation.restaurants.proximityCode | String | Denotes whether a service is onsite, offsite or information is not available. Refer to OpenTravel Code Table Proximity (PRX). | ||
| restaurantInformation.restaurants.reservationsRequired | Boolean | If TRUE, a reservation must be made to dine in the restaurant. | ||
| restaurantInformation.restaurants.mealOffers | List<String> | Enum: [ BREAKFAST, LUNCH, DINNER, BRUNCH ] | ||
| restaurantInformation.restaurants.relativePosition | Object<RelativePosition> | Position details relative to the property or facility. | ||
| restaurantInformation.restaurants.relativePosition.direction | String | Defines the cardinal direction (e.g., north, south, southwest). | ||
| restaurantInformation.restaurants.relativePosition.distance | String | Defines the distance between two points. | ||
| restaurantInformation.restaurants.relativePosition.unit | String | Unit of measure code based on OpenTravel Unit of Measure Code (UOM). | ||
| restaurantInformation.restaurants.relativePosition.toFrom | String | Used to indicate whether the context is to a facility or from a facility. | ||
| restaurantInformation.restaurants.restaurantTypeCodes | List<RestaurantType> | Types of restaurant at the property. | ||
| restaurantInformation.restaurants.restaurantTypeCodes.code | String | Refer to OpenTravel Code List Restaurant Category (RES). | ||
| restaurantInformation.restaurants.restaurantTypeCodes.detailLangs | List<I18N> | May be used to give further detail on the code. | ||
| restaurantInformation.restaurants.cuisines | List<Cuisine> | Cuisine types offered by the restaurant. | ||
| restaurantInformation.restaurants.cuisines.code | String | Collection of cuisine types of restaurant. Refer to OpenTravel Code List Main Cuisine Code (CUI). | ||
| restaurantInformation.restaurants.cuisines.detailLangs | List<I18N> | May be used to give further detail on the code. | ||
| restaurantInformation.restaurants.cuisines.main | Boolean | Indicates whether this cuisine code is the main cuisine offered by restaurant. | ||
| restaurantInformation.restaurants.schedules | Object<OperationScheduleTime> | Restaurant operating schedule details. | ||
| restaurantInformation.restaurants.schedules.weekDays | List<String> | Day of operation. Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ] | ||
| restaurantInformation.restaurants.schedules.start | String | Start time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| restaurantInformation.restaurants.schedules.end | String | End time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| restaurantInformation.restaurants.schedules.descriptionLangs | List<I18N> | Descriptions of the restaurant schedule in multiple languages. | ||
| restaurantInformation.restaurants.restaurantServices | List<RestaurantService> | List of services offered by the restaurant. | ||
| restaurantInformation.restaurants.restaurantServices.code | String | Refer to OpenTravel Code List Restaurant Srvc Info (RSI). | ||
| restaurantInformation.restaurants.restaurantServices.detailLangs | List<I18N> | May be used to give further detail on the code. | ||
| restaurantInformation.restaurants.images | List<Image> | Collection of multimedia images. | ||
| restaurantInformation.restaurants.images.categoryCode | String | Image category. Refer to OpenTravel Picture Category Code (PIC). | ||
| restaurantInformation.restaurants.images.sort | Integer | Display order of images. | ||
| restaurantInformation.restaurants.images.sourceId | String | Unique ID of the image source (e.g., original file identifier). | ||
| restaurantInformation.restaurants.images.captionLangs | List<I18N> | Multilingual image captions. | ||
| restaurantInformation.restaurants.images.applicableStart | Date Format: yyyy-MM-dd | Start date or recurring start period when the image is relevant (e.g., season start). | ||
| restaurantInformation.restaurants.images.applicableEnd | Date Format: yyyy-MM-dd | End date or recurring end period when the image is relevant (e.g., season end). | ||
| restaurantInformation.restaurants.images.mainUrl | The main image url is required. | |||
| restaurantInformation.restaurants.images.items | List<ImageItem> | List of image file variations. | ||
| restaurantInformation.restaurants.images.items.url | String | URL of the image. | ||
| restaurantInformation.restaurants.images.items.width | Integer | Image width (unit defined by UOM). | ||
| restaurantInformation.restaurants.images.items.height | Integer | Image height (unit defined by UOM). | ||
| restaurantInformation.restaurants.images.items.size | String | Image file size (e.g., MB, KB). | ||
| restaurantInformation.restaurants.images.items.unit | String | Unit of measurement. Refer to OpenTravel Unit of Measure (UOM). | ||
| restaurantInformation.restaurants.images.items.fileSize | Integer | File size in bytes. | ||
| restaurantInformation.restaurants.images.items.formatCode | String | Image format (e.g., JPEG, PNG). Refer to OpenTravel Content Format Code (CFC). | ||
| host | Object<Host> | Refers to the individual or entity providing accommodation services, typically the owner or operator of a house, apartment, or lodging establishment. The host is responsible for managing and offering the services needed by guests, ensuring a pleasant and smooth stay. | ||
| host.id | String | A unique identifier for the host. | ||
| host.name | String | The name of the host. | ||
| host.introductionLangs | List<I18N> | A description of the host. | ||
| host.jobLangs | List<I18N> | The host's occupation or role. | ||
| closeSeasons | List<CloseSeason> | List of close seasons for the property. | ||
| closeSeasons.startDate | String | Start date. Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22. | ||
| closeSeasons.endDate | String | End date. Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22. | ||
| loyaltyPrograms | List<LoyaltyProgram> | List of loyalty programs available for the property. | ||
| loyaltyPrograms.nameLangs | List<I18N> | This identifies the loyalty program. | ||
| loyaltyPrograms.descriptionLangs | List<I18N> | The loyalty program descriptions. | ||
| loyaltyPrograms.travelSector | String | Used to identify the specific travel sector to which the loyalty program applies. Refer to OpenTravel Codelist Travel Sector (TVS). | ||
| refPoints | List<ReferencePoint> | List of reference points related to the property. | ||
| refPoints.id | String | Unique ID for the reference point. | ||
| refPoints.nameLangs | List<I18N> | This is used to accommodate a city name, rail station name etc. when using the indexPoint attribute. | ||
| refPoints.descriptionLangs | List<I18N> | Descriptions of the reference point in different languages. | ||
| refPoints.detailLangs | List<I18N> | Further details about the reference point. | ||
| refPoints.indexPointCode | String | Refers to the object related to the reference point (e.g., cross street, airport). Refer to OpenTravel Code List (IPC). | ||
| refPoints.categoryCode | String | Code for the type of reference point (e.g., landmark, station). Refer to OpenTravel Code List (REF). | ||
| refPoints.direction | Enum<Direction> | Defines the cardinal direction. Enum: [ N, S, E, W, NE, NW, SE, SW ] | ||
| refPoints.distance | String | Defines the distance between two points. | ||
| refPoints.unit | String | Unit of measure code based on OpenTravel Unit of Measure Code (UOM). | ||
| refPoints.countryCode | String | Country code (ISO format). | ||
| refPoints.stateCode | String | State or province code. | ||
| refPoints.cityCode | String | |||
| refPoints.position | Object<Position> | Position details for the reference point. | ||
| refPoints.position.latitude | String | The measure of the angular distance on a meridian north or south of the equator. | ||
| refPoints.position.longitude | String | The measure of the angular distance on a meridian east or west of the prime meridian. | ||
| refPoints.position.positionAccuracyCode | String | Accuracy of the geo-coding for the reference point. Refer to OpenTravel Code List Position Accuracy Code (PAC). | ||
| refPoints.nearest | Boolean | The indicator for whether this location is nearest. | ||
| refPoints.primary | Boolean | Indicates whether the reference point is considered the main reference point for the specific type of IndexPointCode (e.g., in Dallas, where IndexPointCode=airport Dallas/Fort Worth airport would be the primary airport even if another airport such as Love Field is closer). | ||
| refPoints.sort | String | Defines the display order of the reference points. | ||
| refPoints.toFrom | String | Used to indicate whether the context is to a facility or from a facility. | ||
| refPoints.transportations | List<ReferencePointTransportation> | Collection of directions to/from a specific location via various modes of transportation.Defines the type of transportation offered. | ||
| refPoints.transportations.code | String | This attribute is used to explicitly define whether the type of transportation applies. Refer to OpenTravel Code list Option Type Code (OTC). | ||
| refPoints.transportations.chargeUnitCode | String | This is the unit for which the charge applies (e.g. room, person, seat). Refer to OpenTravel Code List Charge Type (CHG). | ||
| refPoints.transportations.chargeFrequencyCode | String | This is the timeframe used to apply the charge during the course of the reservation (e.g. Daily, Weekly, Stay). Refer to OpenTravel Code List Charge Type (CHG). | ||
| refPoints.transportations.chargeAmount | String | |||
| refPoints.transportations.currencyCode | String | Currency code for the charge. | ||
| refPoints.transportations.included | Boolean | When true there is no additional charge for transportation. | ||
| refPoints.transportations.descriptionLangs | List<I18N> | |||
| refPoints.transportations.detailLangs | List<I18N> | |||
| refPoints.transportations.schedules | List<OperationScheduleDate> | Defines service availability, including operating dates, hours, and applicable fees. | ||
| refPoints.transportations.schedules.start | String | Start date. Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22. | ||
| refPoints.transportations.schedules.end | String | End date. Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22. | ||
| refPoints.transportations.schedules.operationTimes | List<OperationScheduleTime> | List of operation times. | ||
| refPoints.transportations.schedules.operationTimes.weekDays | List<String> | Day of operation. Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ] | ||
| refPoints.transportations.schedules.operationTimes.start | String | Start time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| refPoints.transportations.schedules.operationTimes.end | String | End time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| attractions | List<Attraction> | List of attractions near the property. | ||
| attractions.id | String | Unique identifier for the attraction. | ||
| attractions.categoryCode | String | The code for the type of attraction in the proximity of the hotel facility. Refer to OpenTravel Code List Attraction Category Code (ACC). | ||
| attractions.nameLangs | List<I18N> | Multilingual names of the attraction. | ||
| attractions.detailLangs | List<I18N> | May be used to give further detail on the code. | ||
| attractions.descriptionLangs | List<I18N> | Multilingual descriptions of the attraction. | ||
| attractions.proximityCode | String | Indicates if the attraction is onsite, offsite, or unavailable. Refer to OpenTravel Code Table Proximity (PRX). | ||
| attractions.applicableStart | String | Start date. | ||
| attractions.applicableEnd | String | End date. | ||
| attractions.url | String | List of URLs for contacting the attraction. | ||
| attractions.tags | List<AttractionTag> | Tags related to the attraction for categorization or filtering. | ||
| attractions.tags.textLangs | List<I18N> | Descriptions of the attraction tags in different languages. | ||
| attractions.refPoints | List<RefPoint> | Reference points for the attraction's location. | ||
| attractions.refPoints.countryCode | String | Country code (ISO format). | ||
| attractions.refPoints.stateCode | String | State or province code. | ||
| attractions.refPoints.direction | String | Defines the cardinal direction (e.g., north, south, southwest). | ||
| attractions.refPoints.distance | String | Defines the distance between two points. | ||
| attractions.refPoints.unit | String | Unit of measure code based on OpenTravel Unit of Measure Code (UOM). | ||
| attractions.refPoints.position | Object<Position> | Position details for the reference point. | ||
| attractions.refPoints.position.latitude | String | Latitude of the reference point. | ||
| attractions.refPoints.position.longitude | String | Longitude of the reference point. | ||
| attractions.refPoints.position.positionAccuracyCode | String | Accuracy of the geo-coding for the reference point. Refer to OpenTravel Code List Position Accuracy Code (PAC). | ||
| recreations | List<Recreation> | List of recreation services. | ||
| recreations.id | String | Unique ID for the recreation. | ||
| recreations.serviceCode | String | Refer to OpenTravel Code List Recreation Srvc Type (RST). | ||
| recreations.nameLangs | List<I18N> | The name of the recreation. | ||
| recreations.detailLangs | List<I18N> | May be used to give further detail on the code. | ||
| recreations.descriptionLangs | List<I18N> | Descriptions of the recreation in different languages. | ||
| recreations.proximityCode | String | Indicates if the recreation is onsite, offsite, or unknown. Refer to OpenTravel Proximity (PRX). | ||
| recreations.included | Boolean | If TRUE, this recreation is included with basic room rates. | ||
| recreations.schedules | List<OperationScheduleDate> | Defines service availability, including operating dates, hours, and applicable fees. | ||
| recreations.schedules.start | String | Start date. Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22. | ||
| recreations.schedules.end | String | End date. Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22. | ||
| recreations.schedules.operationTimes | List<OperationScheduleTime> | List of operation times. | ||
| recreations.schedules.operationTimes.weekDays | List<String> | Day of operation. Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ] | ||
| recreations.schedules.operationTimes.start | String | Start time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| recreations.schedules.operationTimes.end | String | End time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| recreations.schedules.charges | List<ServiceCharge> | Charges for the recreation. | ||
| recreations.schedules.charges.amount | Double | Fixed fee amount. | ||
| recreations.schedules.charges.currencyCode | String | Currency code for the charge. | ||
| recreations.schedules.charges.unitCode | String | Charge unit. Refer to OpenTravel Charge Type (CHG). | ||
| recreations.schedules.charges.frequencyCode | String | This is the timeframe used to apply the charge during the course of the reservation (e.g. Daily, Weekly, Stay). Refer to OpenTravel Code List Charge Type (CHG). | ||
| recreations.services | List<RecreationService> | |||
| recreations.services.code | String | Refer to OpenTravel Code List Recreation Srvc Detail Code (REC). | ||
| recreations.services.detailLangs | List<I18N> | May be used to give further detail on the code. | ||
| recreations.services.descriptionLangs | List<I18N> | Multilingual description of the service. | ||
| additionalDescriptions | List<AdditionalDescription> | A collection of additional descriptive details for the property. | ||
| additionalDescriptions.id | String | Unique identifier for the description. | ||
| additionalDescriptions.additionalDetailCode | String | Refer to OpenTravel Code List Additional Detail Type (ADT). | ||
| additionalDescriptions.recordId | String | Uniquely identifies this file in the message. | ||
| additionalDescriptions.sourceId | String | Unique ID for the source of the description. | ||
| additionalDescriptions.title | String | Title of the TextItem description. | ||
| additionalDescriptions.descriptionLangs | List<I18N> | Text item description. | ||
| additionalDescriptions.applicableStart | String | Start date. Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22. | ||
| additionalDescriptions.applicableEnd | String | End date. Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22. | ||
| promotions | List<Promotion> | List of property promotions or packages. | ||
| promotions.category | Enum<PromotionCategory> | Indicates whether it is a package or a promotion. Enum: [ PACKAGE, PROMOTION ] | ||
| promotions.code | String | Unique identifier for the promotion or package. | ||
| promotions.packageTypeCode | String | Type of package or promotion. Refer to OpenTravel Package Type (PKG). | ||
| promotions.titleLangs | List<I18N> | Multilingual title of the package or promotion. | ||
| promotions.descriptionLangs | List<I18N> | Multilingual description of the package or promotion. | ||
| promotions.minLos | Integer | Minimum length of stay (in days) required for the promotion. | ||
| promotions.sort | Integer | Display order of the promotion. | ||
| promotions.schedules | List<CommonScheduleDate> | List of schedule-based validity periods. | ||
| promotions.schedules.weekDays | List<String> | Day of operation. Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ] | ||
| promotions.schedules.start | String | Start time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| promotions.schedules.end | String | End time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| policyInformation | Object<PolicyInformation> | Contains details about the property's policies. | ||
| policyInformation.propertyPolicy | Object<PropertyPolicy> | Contains specific policies for the property. | ||
| policyInformation.propertyPolicy.acceptedGuestType | Enum<AcceptedGuestType> | Types of guest accepted: AdultOnly, CouplesOnly. Enum: [ ADULT_ONLY, COUPLES_ONLY ] | ||
| policyInformation.propertyPolicy.roomGuaranteedLateArrival | Boolean | If true, the property guarantees the room for late arrival. | ||
| policyInformation.propertyPolicy.descriptionLangs | List<I18N> | Multilingual policy descriptions. | ||
| policyInformation.propertyPolicy.petsAllowed | Enum<PetsAllowed> | Specifies at a high level the pet policy at the hotel. Enum: [ PETS_ALLOWED, PETS_NOT_ALLOWED, ASSISTIVE_ANIMALS_ONLY, PETS_BY_ARRANGEMENTS, PETS_FOR_FREE ] | ||
| policyInformation.childPolicy | Object<ChildPolicy> | Contains details about the property's children policy. | ||
| policyInformation.childPolicy.minGuestAge | Integer | The minimum guest age allowed for a guest at the hotel facility. | ||
| policyInformation.childPolicy.maxChildAge | Integer | The maximum age for a child price. | ||
| policyInformation.childPolicy.freeCutOffAge | Integer | The usual age limit at which a child can stay free with an adult at the property facility. If this value is not set, then there is no cutoff limit. | ||
| policyInformation.childPolicy.freeChildPerAdult | Integer | The usual number of children meeting the UsualStayFreeCutoffAge allowed to stay free with an adult at the property. If this value is not set, then there is no cutoff limit. | ||
| policyInformation.childPolicy.kidsStayFree | Boolean | If true there is no charge for children. | ||
| policyInformation.checkInPolicy | Object<CheckinPolicy> | Contains details about the property's check-in policy. | ||
| policyInformation.checkInPolicy.start | String | Earliest check-in time (e.g., "14:00"). | ||
| policyInformation.checkInPolicy.end | String | Latest check-in time (e.g., "22:00"). | ||
| policyInformation.checkInPolicy.option | String | Specifies the type of check-in offered by the host. Supported values: doorman_entry, lockbox, smartlock, keypad, host_checkin, other_checkin. | ||
| policyInformation.checkInPolicy.instructionLangs | List<I18N> | Instructions for guests on how to check in. These details are only shared with confirmed guests. | ||
| policyInformation.checkOutPolicy | Object<CheckOutPolicy> | Contains details related to the property's check-out policy. | ||
| policyInformation.checkOutPolicy.start | String | Earliest check-out time (e.g., "08:00"). | ||
| policyInformation.checkOutPolicy.end | String | Latest check-out time (e.g., "12:00"). | ||
| policyInformation.checkOutPolicy.type | Enum<CheckOutPolicyType> | Number of nights used to calculate fees. Enum: [ EARLY, LATE ] | ||
| policyInformation.checkOutPolicy.chargeNights | Integer | The fixed monetary amount charged. | ||
| policyInformation.checkOutPolicy.chargeAmount | Double | Percentage of the total stay amount charged as a fee. | ||
| policyInformation.checkOutPolicy.chargePercent | Double | The percentage of the total stay amount charged for early check-in or late checkout. | ||
| policyInformation.checkOutPolicy.currencyCode | String | Currency code for the charge. | ||
| policyInformation.checkOutPolicy.balanceOfStay | Boolean | If true, the charge for early checkout is equivalent to the cost of the remaining nights in the original reservation. | ||
| policyInformation.checkOutPolicy.descriptionLangs | List<I18N> | Multilingual policy descriptions. | ||
| policyInformation.commissionPolicy | Object<CommissionPolicy> | Contains details about the property's commission policy. | ||
| policyInformation.commissionPolicy.amount | Double | The fixed monetary amount of the commission fee. | ||
| policyInformation.commissionPolicy.percent | Double | The commission fee as a percentage. If 0, the amount attribute is used instead (either amount or percent must be set to 0). | ||
| policyInformation.commissionPolicy.currencyCode | String | Currency code for the charge. | ||
| policyInformation.commissionPolicy.paymentCompanyLangs | List<I18N> | The name of the company processing the commission payment for the property. | ||
| policyInformation.commissionPolicy.descriptionLangs | List<I18N> | Multilingual policy descriptions. | ||
| policyInformation.generalPolicies | List<GeneralPolicy> | A list of general policies applicable to the property. | ||
| policyInformation.generalPolicies.nameLangs | List<I18N> | The localized name of the general policy. | ||
| policyInformation.generalPolicies.descriptionLangs | List<I18N> | Multilingual policy descriptions. | ||
| policyInformation.cancelPolicies | List<CancelPolicy> | A list of cancellation policies that apply to the property. | ||
| policyInformation.cancelPolicies.code | String | A unique identifier for the cancellation policy. | ||
| policyInformation.cancelPolicies.nonRefundable | Boolean | Indicates whether the reservation is non-refundable. If true, a 100% penalty on the prepayment is applied, regardless of the cancellation deadline. | ||
| policyInformation.cancelPolicies.roomTypeCode | String | A system specific room type to which this cancellation penalty applies. | ||
| policyInformation.cancelPolicies.cancelPenalty | Object<CancelPenalty> | Defines the penalty details for cancellations under this policy. | ||
| policyInformation.cancelPolicies.cancelPenalty.taxInclusive | Boolean | Indicates whether taxes are included when figuring the base amount. | ||
| policyInformation.cancelPolicies.cancelPenalty.feeInclusive | Boolean | Indicates whether fees are included when calculating the penalty amount. | ||
| policyInformation.cancelPolicies.cancelPenalty.chargeNights | Integer | The number of nights used to calculate the cancellation fee. | ||
| policyInformation.cancelPolicies.cancelPenalty.chargeAmount | Double | The fixed monetary amount charged as a cancellation fee. | ||
| policyInformation.cancelPolicies.cancelPenalty.chargePercent | Double | The percentage of the total stay amount used to calculate the cancellation fee. | ||
| policyInformation.cancelPolicies.cancelPenalty.currencyCode | String | Currency code for the charge. | ||
| policyInformation.cancelPolicies.cancelPenalty.descriptionLangs | List<I18N> | Multilingual policy descriptions. | ||
| policyInformation.cancelPolicies.cancelDeadline | Object<CancelDeadline> | Defines the deadline for cancellations before penalties apply. | ||
| policyInformation.cancelPolicies.cancelDeadline.absoluteDeadline | String | Defines the absolute deadline. Either this or the offset attributes may be used. | ||
| policyInformation.cancelPolicies.cancelDeadline.offsetTimeUnit | Enum<OffsetTimeUnit> | The units of time. Enum: [ YEAR, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, FULL_DURATION ] | ||
| policyInformation.cancelPolicies.cancelDeadline.offsetUnitMultiplier | Integer | The number of units of DeadlineTimeUnit. | ||
| policyInformation.cancelPolicies.cancelDeadline.offsetDropTimeType | Enum<OffsetDropTimeType> | Indicates when the deadline takes effect. Enum: [ BEFORE_ARRIVAL, AFTER_ARRIVAL, AFTER_BOOKING, AFTER_CONFIRMATION, AFTER_DEPARTURE ] | ||
| policyInformation.cancelPolicies.schedules | List<CommonScheduleDate> | A list of schedule-based cancellation policies that apply on specific days or date ranges. | ||
| policyInformation.cancelPolicies.schedules.weekDays | List<String> | Day of operation. Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ] | ||
| policyInformation.cancelPolicies.schedules.start | String | Start time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| policyInformation.cancelPolicies.schedules.end | String | End time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| policyInformation.guaranteePaymentPolicies | List<GuaranteePaymentPolicy> | List of guarantee and payment policies. | ||
| policyInformation.guaranteePaymentPolicies.code | String | Unique identifier for the policy. | ||
| policyInformation.guaranteePaymentPolicies.type | Enum<GuaranteePaymentPolicyType> | Type of guarantee or payment policy. Enum: [ REQUIRED_PAYMENT, GUARANTEE_POLICY, ACCEPTED_PAYMENT_FORMS ] | ||
| policyInformation.guaranteePaymentPolicies.retributionType | Enum<RetributionType> | Type of action taken when guarantee deadline has been exceeded. Enum: [ RES_AUTO_CANCELLED, RES_NOT_CANCELLED ] | ||
| policyInformation.guaranteePaymentPolicies.guaranteeType | Enum<GuaranteeType> | GuaranteeType: GuaranteeType An enumerated type defining the guarantee to be applied to this reservation. Enum: [ GUARANTEE_REQUIRED, CC_DC_VOUCHER, PROFILE, DEPOSIT, PREPAY, NONE ] | ||
| policyInformation.guaranteePaymentPolicies.roomTypeCode | String | Room type applicable to this policy. | ||
| policyInformation.guaranteePaymentPolicies.nonRefundable | Boolean | If true, prepayments are non-refundable, and a 100% penalty applies regardless of the deadline. | ||
| policyInformation.guaranteePaymentPolicies.holdTime | String | The room will held up until this time without a guarantee. | ||
| policyInformation.guaranteePaymentPolicies.offsetTimeUnit | Enum<OffsetTimeUnit> | The units of time. Enum: [ YEAR, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, FULL_DURATION ] | ||
| policyInformation.guaranteePaymentPolicies.offsetUnitMultiplier | Integer | The number of units of DeadlineTimeUnit. | ||
| policyInformation.guaranteePaymentPolicies.offsetDropTimeType | Enum<OffsetDropTimeType> | Indicates when the deadline takes effect. Enum: [ BEFORE_ARRIVAL, AFTER_ARRIVAL, AFTER_BOOKING, AFTER_CONFIRMATION, AFTER_DEPARTURE ] | ||
| policyInformation.guaranteePaymentPolicies.chargeNights | Integer | Number of nights used to calculate fees. | ||
| policyInformation.guaranteePaymentPolicies.chargeAmount | Double | The fixed monetary amount charged. | ||
| policyInformation.guaranteePaymentPolicies.chargePercent | Double | Percentage of the total stay amount charged as a fee. | ||
| policyInformation.guaranteePaymentPolicies.currencyCode | String | Currency code for the charge. | ||
| policyInformation.guaranteePaymentPolicies.descriptions | List<GuaranteePaymentPolicyDescription> | Descriptions of the policy. | ||
| policyInformation.guaranteePaymentPolicies.descriptions.descriptionLangs | List<I18N> | Multilingual policy descriptions. | ||
| policyInformation.guaranteePaymentPolicies.schedules | List<CommonScheduleDate> | Policy schedule based on specific days or date ranges. | ||
| policyInformation.guaranteePaymentPolicies.schedules.weekDays | List<String> | Day of operation. Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ] | ||
| policyInformation.guaranteePaymentPolicies.schedules.start | String | Start time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| policyInformation.guaranteePaymentPolicies.schedules.end | String | End time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22. | ||
| policyInformation.guaranteePaymentPolicies.acceptedPayments | List<AcceptedPayment | Accepted payment and guarantee methods. | ||
| policyInformation.guaranteePaymentPolicies.acceptedPayments.guarantee | Boolean | If true, this represents a guarantee rather than a payment method. | ||
| policyInformation.guaranteePaymentPolicies. acceptedPayments.paymentTypeCode | String | AmericanExpress, BritishAirways,CarteBlanche, ChinaUnionPay, UnionCredit, ContinentalAirlines, DeltaAirlines, DinersClub, DiscoverCard, Disney, Eurocard, Forbrugsforeningskort, Hilton, Hyatt, JapanCreditBureau, Maestro, Marriott, Mastercard, RitzCarlton, SouthwestAirlines, StarwoodHotels, UnitedAirlines, USAirways, VISA | ||
| policyInformation.guaranteePaymentPolicies.acceptedPayments.cardTypeCode | String | Type of payment card. | ||
| policyInformation.guaranteePaymentPolicies. acceptedPayments.cardTypeDescriptionLangs | List<I18N> | Multilingual card type descriptions. | ||
| policyInformation.guaranteePaymentPolicies.addresses | Payment recipient and address details. | |||
| policyInformation.guaranteePaymentPolicies.addresses.paymentReceiverName | String | Name of payment recipient. | ||
| policyInformation.guaranteePaymentPolicies.addresses.useTypeCode | String | Address purpose (e.g., billing, delivery) based on OpenTravel Code List Address Use Type (AUT). | ||
| policyInformation.guaranteePaymentPolicies.addresses.postalCode | String | Post Office Code number. | ||
| policyInformation.guaranteePaymentPolicies.addresses.countryCode | String | Country code (ISO format). | ||
| policyInformation.guaranteePaymentPolicies.addresses.stateCode | String | State or province code. | ||
| policyInformation.guaranteePaymentPolicies.addresses. streetNumberPoBoxLangs | List<I18N> | May contain the street number and optionally the street name. | ||
| policyInformation.guaranteePaymentPolicies.addresses.countryNameLangs | List<I18N> | Country name (e.g., Ireland).The name or code of a country (e.g. as used in an address or to specify citizenship of a traveller). | ||
| policyInformation.guaranteePaymentPolicies.addresses.stateNameLangs | List<I18N> | State or Province name (e.g., Texas).State, province, or region name or code needed to identify location. | ||
| policyInformation.guaranteePaymentPolicies.addresses.cityNameLangs | List<I18N> | City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address). | ||
| policyInformation.guaranteePaymentPolicies.addresses.addressLines | List<AddressLine> | List of address lines (e.g., street, suite). | ||
| policyInformation.guaranteePaymentPolicies.addresses. addressLines.addressLineLangs | List<I18N> | Multilingual address line descriptions. | ||
| policyInformation.petPolicies | List<PetPolicy> | List of pet policies. | ||
| policyInformation.petPolicies.code | String | Pet policy code from OpenTravel Code Table (PET). | ||
| policyInformation.petPolicies.unit | String | Unit of measure code based on OpenTravel Unit of Measure Code (UOM). | ||
| policyInformation.petPolicies.size | Double | This is the numeric value associated with the measurement. | ||
| policyInformation.petPolicies.maxPetQuantity | Integer | Maximum number of pets allowed (0-99). | ||
| policyInformation.petPolicies.refundableDeposit | Double | Refundable deposit amount for pet stays. | ||
| policyInformation.petPolicies.nonRefundableFee | Double | Specifies the charge associated with a pet staying in the room. | ||
| policyInformation.petPolicies.chargeUnitCode | String | Charge unit code. Refer to OpenTravel Charge Type (CHG). | ||
| policyInformation.petPolicies.currencyCode | String | Currency code for the charge. | ||
| policyInformation.petPolicies.restriction | Boolean | If true, there are restrictions on pet policies; if false, no restrictions apply. | ||
| policyInformation.petPolicies.descriptionLangs | List<I18N> | Multilingual policy descriptions. | ||
| policyInformation.taxPolicies | List<TaxPolicy> | List of applicable taxes. | ||
| policyInformation.taxPolicies.type | Enum<TaxFeePolicyType> | Enum: [ INCLUSIVE, EXCLUSIVE, CUMULATIVE ] | ||
| policyInformation.taxPolicies.code | String | Tax code (e.g., agency fee, municipality fee). Refer to OpenTravel Fee Tax Type (FTT). | ||
| policyInformation.taxPolicies.chargeAmount | Double | The fixed monetary amount charged. | ||
| policyInformation.taxPolicies.chargePercent | Double | Percentage of the total stay amount charged as a fee. | ||
| policyInformation.taxPolicies.currencyCode | String | Currency code for the charge. | ||
| policyInformation.taxPolicies.effectiveDate | String | Starting date of the policy | ||
| policyInformation.taxPolicies.expireDate | String | Ending date of the policy | ||
| policyInformation.taxPolicies.chargeUnitCode | String | Charge unit code. Refer to OpenTravel Charge Type (CHG). | ||
| policyInformation.taxPolicies.chargeFrequencyCode | String | Frequency of tax application (e.g., Daily, Weekly, Stay). Refer to OpenTravel Charge Type (CHG). | ||
| policyInformation.taxPolicies.sort | Integer | Used to define the display order. | ||
| policyInformation.taxPolicies.descriptionLangs | List<I18N> | Multilingual policy descriptions. | ||
| policyInformation.feePolicies | List<FeePolicy> | List of applicable fees. | ||
| policyInformation.feePolicies.type | Enum<TaxFeePolicyType> | Enum: [ INCLUSIVE, EXCLUSIVE, CUMULATIVE ] | ||
| policyInformation.feePolicies.code | String | Fee code (e.g., agency fee, municipality fee). Refer to OpenTravel Fee Tax Type (FTT). | ||
| policyInformation.feePolicies.chargeAmount | Double | The fixed monetary amount charged. | ||
| policyInformation.feePolicies.chargePercent | Double | Percentage of the total stay amount charged as a fee. | ||
| policyInformation.feePolicies.currencyCode | String | Currency code for the charge. | ||
| policyInformation.feePolicies.effectiveDate | String | Starting date of the policy | ||
| policyInformation.feePolicies.expireDate | String | Ending date of the policy | ||
| policyInformation.feePolicies.mandatory | Boolean | If true, the fee is mandatory; otherwise, it is optional. | ||
| policyInformation.feePolicies.chargeUnitCode | String | Charge unit code. Refer to OpenTravel Charge Type (CHG). | ||
| policyInformation.feePolicies.chargeFrequencyCode | String | Frequency of tax application (e.g., Daily, Weekly, Stay). Refer to OpenTravel Charge Type (CHG). | ||
| policyInformation.feePolicies.taxableIndicator | Boolean | If true, the fee is subject to tax. | ||
| policyInformation.feePolicies.descriptionLangs | List<I18N> | Multilingual policy descriptions. | ||
| policyInformation.ratePolicies | List<RatePolicy> | |||
| policyInformation.ratePolicies.corporateIdRequired | Boolean | If true, a corporate ID is required to book a corporate rate. | ||
| policyInformation.ratePolicies.type | Enum<RatePolicyType> | Type of rate policy. Enum: [ GOVERNMENT, NEGOTIATED, PREFERRED, OTHER ] | ||
| policyInformation.ratePolicies.identifyRequired | Boolean | If true, an ID is required at check-in. | ||
| policyInformation.ratePolicies.guestTypeCode | String | Guest type(s) applicable to the policy. Use values from OpenTravel property Guest Type (GUE) code list. | ||
| policyInformation.ratePolicies.minRoomNightCommitment | Integer | Minimum number of nights required to qualify for the rate. | ||
| policyInformation.ratePolicies.rateOfferTypeCode | String | Specifies an alternate rate plan type. Refer to OpenTravel Rate Plan Type (RPT) code list. | ||
| policyInformation.ratePolicies.descriptions | List<RatePolicyDescription> | Descriptions of the policy. | ||
| policyInformation.ratePolicies.descriptions.nameLangs | List<I18N> | Multilingual policy names. | ||
| policyInformation.ratePolicies.descriptions.descriptionLangs | List<I18N> | Multilingual policy descriptions. | ||
| otherProperties | List<OtherProperty> | Collection of nearby or related properties. | ||
| otherProperties.propertyCode | String | Unique code identifying a competitor property. | ||
| otherProperties.propertyNameLangs | List<I18N> | Multilingual property name. | ||
| otherProperties.chainCode | String | Code identifying the property's chain. | ||
| otherProperties.brandCode | String | Code identifying the property's brand. | ||
| otherProperties.segmentCode | String | Segment classification of the property. | ||
| otherProperties.contextCode | String | Identifies the context of the data. | ||
| otherProperties.competitor | Boolean | If true, the property is considered a competitor. | ||
| propertyMappings | List<PropertyMapping> | Collection of property channel codes. | ||
| propertyMappings.sourceCode | String | Identifies the source of the data. | ||
| propertyMappings.sourceName | String | Name of the source system. | ||
| propertyMappings.sourceType | Enum<SourceType> | Type of source system. Enum: [ GDS, CRS, OTA, WHOLESALER, TOUR_OPERATOR, TECHNICAL_PLATFORM, OTHER ] | ||
| propertyMappings.propertyCode | String | Unique code for the property in the source system. | ||
| propertyMappings.chainCode | String | Code identifying the property's chain. | ||
| propertyMappings.propertyName | String | Multilingual property name. | ||
| propertyMappings.propertyShortName | String | Multilingual short name of the property. | ||
| environmentImpact | Object<EnvironmentImpact> | Environmental sustainability details. | ||
| environmentImpact.carbonFootprint | Object<CarbonFootprint> | Carbon dioxide emissions data. | ||
| environmentImpact.carbonFootprint.meetingEvent | BigDecimal | CO₂ emissions (in pounds) for meetings/events. | ||
| environmentImpact.carbonFootprint.roomNight | BigDecimal | CO₂ emissions (in pounds) per room night. | ||
| environmentImpact.carbonFootprint.weatherNormalized | BigDecimal | Weather-normalized CO₂ emissions (in pounds). | ||
| environmentImpact.carbonFootprint.unit | String | Unit of measurement for carbon footprint. | ||
| environmentImpact.water | Object<Water> | Water usage and conservation details. | ||
| environmentImpact.water.grayWater | Boolean | Indicates if grey water recycling is used. | ||
| environmentImpact.water.waterProgram | Boolean | Indicates if a water conservation program is in place. | ||
| environmentImpact.water.perRoomNightUsage | BigDecimal | Water consumption per room per night. | ||
| environmentImpact.water.perRoomDayUsage | BigDecimal | Water consumption per room per day. | ||
| environmentImpact.water.wasteDiversionPercentage | BigDecimal | Waste diversion rate as a percentage. | ||
| environmentImpact.water.unit | String | Unit of measurement for water usage. | ||
| environmentImpact.water.descriptions | List<CommonDescription> | Multilingual description of water conservation efforts. | ||
| environmentImpact.water.descriptions.descriptionLangs | List<I18N> | |||
| environmentImpact.energy | Object<Energy> | Energy efficiency and renewable energy details. | ||
| environmentImpact.energy.efficientAppliances | Boolean | Indicates the use of energy-efficient appliances. | ||
| environmentImpact.energy.efficientLighting | Boolean | Indicates if energy-efficient lighting is used. | ||
| environmentImpact.energy.heatPowerComb | Boolean | Indicates if combined heat and power units are used. | ||
| environmentImpact.energy.heatPump | Boolean | Indicates if heat pumps are in use. | ||
| environmentImpact.energy.powerSavingPolicy | Boolean | Indicates if a power-saving policy is implemented. | ||
| environmentImpact.energy.solar | Boolean | Indicates if solar energy is used. | ||
| environmentImpact.energy.temperatureControl | Boolean | Indicates if temperature control measures are in place. | ||
| environmentImpact.energy.windTurbine | Boolean | Indicates if wind turbines are used. | ||
| environmentImpact.energy.energyGenerated | Integer | Amount of renewable energy generated (kilowatts). | ||
| environmentImpact.energy.energyStarRating | String | Energy Star rating of the property. | ||
| environmentImpact.energy.energyUsages | List<EnergyUsage> | Breakdown of energy consumption. | ||
| environmentImpact.energy.energyUsages.powerType | Enum<PowerType> | Type of energy used. Enum: [ DIESEL, ELECTRIC, GAS, OIL, SOLAR, DIESEL_FOR_EMERGENCY, PETROL_FOR_EMERGENCY, OTHER ] | ||
| environmentImpact.energy.energyUsages.unit | String | Unit of measurement for energy consumption. | ||
| environmentImpact.energy.energyUsages.quantity | Integer | Amount of energy consumed. | ||
| environmentImpact.energy.energyUsages.descriptionLangs | List<I18N> | Multilingual description of energy programs. | ||
| environmentImpact.recycling | Object<Recycling> | Recycling and waste reduction efforts. | ||
| environmentImpact.recycling.activeProgram | Boolean | Indicates if a recycling program is active. | ||
| environmentImpact.recycling.ecologicalDishware | Boolean | Indicates the use of non-disposable dishware. | ||
| environmentImpact.recycling.descriptions | List<CommonDescription> | Multilingual description of the recycling program. | ||
| environmentImpact.recycling.descriptions.descriptionLangs | List<I18N> | |||
| environmentImpact.environmentGeneral | Object<EnvironmentGeneral> | General environmental sustainability policies. | ||
| environmentImpact.environmentGeneral.certificationAvail | Boolean | Indicates if environmental certifications are available. | ||
| environmentImpact.environmentGeneral.chemicalAllergies | Boolean | Indicates if the property accommodates guests with chemical sensitivities. | ||
| environmentImpact.environmentGeneral.environmentCleaner | Boolean | Indicates if environmentally friendly cleaning products are used. | ||
| environmentImpact.environmentGeneral.linenReuse | Boolean | Indicates if a linen reuse program is in place. | ||
| environmentImpact.environmentGeneral.procurementPolicy | Boolean | Indicates if the property has a sustainable procurement policy. | ||
| environmentImpact.environmentGeneral.certifications | List<Certification> | List of environmental certifications obtained. | ||
| environmentImpact.environmentGeneral.certifications.nameLangs | Multilingual certification names. | |||
| environmentImpact.environmentGeneral.environments | List<Environment> | Additional environmental policies. | ||
| environmentImpact.environmentGeneral.environments.nameLangs | List<I18N> | Multilingual names of environmental policies. | ||
| environmentImpact.environmentGeneral.environments.descriptionLangs | List<I18N> | Multilingual descriptions of environmental policies. | ||
| viewerShips | List<ViewerShip> | List of property distribution channels. | ||
| viewerShips.distributorCode | String | Unique code identifying the distributor. | ||
| viewerShips.distributorTypeCode | String | Code representing the type of distributor. | ||
| viewerShips.descriptionLangs | List<I18N> | Multilingual description of the distributor. | ||
| images | List<Image> | Collection of multimedia images. | ||
| images.categoryCode | String | Image category. Refer to OpenTravel Picture Category Code (PIC). | ||
| images.sort | Integer | Display order of images. | ||
| images.sourceId | String | Unique ID of the image source (e.g., original file identifier). | ||
| images.captionLangs | List<I18N> | Multilingual image captions. | ||
| images.applicableStart | Date Format: yyyy-MM-dd | Start date or recurring start period when the image is relevant (e.g., season start). | ||
| images.applicableEnd | Date Format: yyyy-MM-dd | End date or recurring end period when the image is relevant (e.g., season end). | ||
| images.lastUpdated | Date Format: yyyy-MM-ddTHH:mm:ssZ | |||
| images.mainUrl | The main image is required. | |||
| images.items | List<ImageItem> | List of image file variations. | ||
| images.items.url | String | URL of the image. | ||
| images.items.width | Integer | Image width (unit defined by UOM). | ||
| images.items.height | Integer | Image height (unit defined by UOM). | ||
| images.items.size | String | Image file size (e.g., MB, KB). | ||
| images.items.unit | String | Unit of measurement. Refer to OpenTravel Unit of Measure (UOM). | ||
| images.items.fileSize | Integer | File size in bytes. | ||
| images.items.formatCode | String | Image format (e.g., JPEG, PNG). Refer to OpenTravel Content Format Code (CFC). | ||
| images.items.resolution | Integer | Image resolution in DPI (Dots Per Inch). | ||
| images.items.recordId | String | Unique identifier for this image record. |
Example Request
{
"basicInformation": {
"propertyNameLangs": [
{
"languageCode": "EN-US",
"value": "DerbySoft DEMO"
}
],
"propertyShortNameLangs": [
{
"languageCode": "EN-US",
"value": "DerbySoft"
}
],
"propertyDescriptionLangs": [
{
"languageCode": "EN-US",
"value": "A luxury demo hotel located in downtown Los Angeles, offering premium amenities and services."
}
],
"status": "OPEN",
"countryCode": "US",
"hotelCityCode": "LAX",
"chainCode": "100",
"chainNameLangs": [
{
"languageCode": "EN-US",
"value": "DerbySoft Hotels"
}
],
"brandCode": "200",
"brandNameLangs": [
{
"languageCode": "EN-US",
"value": "DerbySoft Luxury Collection"
}
],
"timeZone": "America/Los_Angeles",
"currencyCode": "USD",
"whenBuilt": "2010",
"firstOpenDate": "2011-06-01",
"renovations": [
{
"completionDate": "2020-01-15",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Extensive renovation of rooms and public areas, adding modern amenities."
}
]
}
],
"floors": [
{
"start": 1,
"end": 20
}
],
"propertyCategories": [
{
"code": "500",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Luxury Hotel"
}
]
}
],
"segmentCategories": [
{
"code": "300",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Business Travelers"
}
]
}
],
"locationCategories": [
{
"code": "400",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Located in the heart of the city"
}
]
}
],
"position": {
"latitude": 34.0522,
"longitude": -118.2437,
"positionAccuracyCode": "1"
},
"contacts": [
{
"companyNameLangs": [
{
"languageCode": "EN-US",
"value": "DerbySoft DEMO Hotel"
}
],
"departmentLangs": [
{
"languageCode": "EN-US",
"value": "Front Desk"
}
],
"addresses": [
{
"useTypeCode": "1",
"postalCode": "90015",
"countryCode": "US",
"stateCode": "CA",
"cityCode": "100",
"countryNameLangs": [
{
"languageCode": "EN-US",
"value": "United States"
}
],
"stateNameLangs": [
{
"languageCode": "EN-US",
"value": "California"
}
],
"cityNameLangs": [
{
"languageCode": "EN-US",
"value": "Los Angeles"
}
],
"countyNameLangs": [
{
"languageCode": "EN-US",
"value": "Los Angeles County"
}
],
"addressLines": [
{
"addressLineLangs": [
{
"languageCode": "EN-US",
"value": "1234 Sunset Blvd"
}
]
}
]
}
],
"phones": [
{
"locationType": "1",
"techType": "1",
"countryAccessCode": "+1",
"areaCityCode": "310",
"phoneNumber": "555-1234"
}
],
"emails": [
{
"type": "GENERAL",
"address": "info@derbysoftdemo.com"
}
],
"urls": [
"https://www.derbysoftdemo.com"
],
"lastUpdated": "2024-01-01"
}
],
"capacities": [
{
"code": "TOTAL_ROOMS",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Total Guest Rooms"
}
],
"quantity": 200
},
{
"code": "MAX_OCCUPANCY",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Maximum Occupancy"
}
],
"quantity": 450
}
],
"awards": [
{
"date": "2023-01-01",
"providerLangs": [
{
"languageCode": "EN-US",
"value": "TripAdvisor"
}
],
"ratingLangs": [
{
"languageCode": "EN-US",
"value": "Certificate of Excellence"
}
],
"officialAppointment": true,
"ratingSymbol": "5"
}
],
"spokenLanguages": [
{
"primaryLanguage": true,
"languageCode": "EN-US"
},
{
"primaryLanguage": false,
"languageCode": "ES-US"
},
{
"primaryLanguage": false,
"languageCode": "ZH-CN"
}
],
"labels": [
{
"code": "LUXURY",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "5-Star Luxury Accommodation"
}
]
},
{
"code": "BUSINESS_FRIENDLY",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Business Travel Approved"
}
]
}
],
"goIds": [
{
"channelCode": "AGODA",
"id": "AGD123456"
},
{
"channelCode": "BOOKING",
"id": "BKG789012"
}
],
"richMedias": [
{
"url": "https://www.derbysoftdemo.com/videos/hotel-tour.mp4"
}
],
"lastUpdated": "2024-01-01",
"facilityLastUpdated": "2024-01-01",
"policyLastUpdated": "2024-01-01",
"referencePointLastUpdated": "2024-01-01",
"attractionsLastUpdated": "2024-01-01",
"recreationLastUpdated": "2024-01-01",
"otherHotelsLastUpdated": "2024-01-01",
"affiliationsLastUpdated": "2024-01-01",
"imagesLastUpdated": "2024-01-01",
"masterChainCode": "100",
"generalUnit": "METRIC",
"generalWeightUnit": "KG",
"generalAreaUnit": "SQ_M",
"generalDistanceUnit": "KM"
},
"facilityInformation": {
"amenities": [
{
"id": "001",
"code": "101",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Free High-Speed WiFi"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Complimentary 1Gbps WiFi in all rooms and public areas"
}
],
"included": true,
"proximityCode": "INDOOR",
"quantity": 1,
"operationSchedules": [
{
"start": "2024-01-01",
"end": "2024-12-31",
"operationTimes": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "00:00",
"end": "24:00",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "24/7 Availability"
}
]
}
],
"charges": []
}
],
"features": []
},
{
"id": "002",
"code": "102",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Outdoor Swimming Pool"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Heated outdoor pool with cabanas and pool bar"
}
],
"included": true,
"proximityCode": "OUTDOOR",
"quantity": 1,
"operationSchedules": [
{
"start": "2024-03-01",
"end": "2024-10-31",
"operationTimes": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "08:00",
"end": "20:00",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Seasonal Availability (Mar-Oct)"
}
]
}
],
"charges": []
}
],
"features": [
{
"id": "F001",
"code": "POOL_BAR",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Pool Bar Service"
}
],
"quantity": 1,
"unit": "UNIT",
"chargeCurrencyCode": "USD",
"chargeAmount": 0,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Complimentary access to pool bar (food/drinks extra)"
}
]
}
]
},
{
"id": "003",
"code": "103",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Full-Service Spa"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Luxury spa offering massages, facials and body treatments"
}
],
"included": false,
"proximityCode": "INDOOR",
"quantity": 1,
"operationSchedules": [
{
"start": "2024-01-01",
"end": "2024-12-31",
"operationTimes": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "09:00",
"end": "19:00",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "By Appointment Only"
}
]
}
],
"charges": [
{
"amount": 150,
"percent": 0,
"currencyCode": "USD",
"unitCode": "HOUR",
"frequencyCode": "PER_SERVICE"
}
]
}
],
"features": [
{
"id": "F002",
"code": "SPA_TREATMENTS",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Customized Spa Packages"
}
],
"quantity": 10,
"unit": "TREATMENT",
"chargeCurrencyCode": "USD",
"chargeAmount": 200,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "90-minute signature massage package"
}
]
}
]
}
],
"businessServices": [
{
"id": "B001",
"code": "BUSINESS_CENTER",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "24-Hour Business Center"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Full-service business center with printing, scanning and meeting facilities"
}
],
"included": true,
"proximityCode": "INDOOR",
"quantity": 1,
"operationSchedules": [
{
"start": "2024-01-01",
"end": "2024-12-31",
"operationTimes": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "00:00",
"end": "24:00",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "24/7 Availability"
}
]
}
],
"charges": [
{
"amount": 0,
"percent": 0,
"currencyCode": "USD",
"unitCode": "PAGE",
"frequencyCode": "PER_USE"
}
]
}
],
"features": [
{
"id": "BF001",
"code": "PRINTING_SERVICE",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Complimentary Printing"
}
],
"quantity": 2,
"unit": "PRINTER",
"chargeCurrencyCode": "USD",
"chargeAmount": 0,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "First 10 pages complimentary, $0.10 per page thereafter"
}
]
}
]
}
],
"meetingServices": [
{
"id": "M001",
"code": "MEETING_ROOMS",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Flexible Meeting Spaces"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "5 meeting rooms accommodating 10-200 guests with AV equipment"
}
],
"included": false,
"proximityCode": "INDOOR",
"quantity": 5,
"operationSchedules": [
{
"start": "2024-01-01",
"end": "2024-12-31",
"operationTimes": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI"],
"start": "08:00",
"end": "18:00",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Weekday Availability"
}
]
}
],
"charges": [
{
"amount": 200,
"percent": 0,
"currencyCode": "USD",
"unitCode": "HOUR",
"frequencyCode": "PER_ROOM"
}
]
}
],
"features": [
{
"id": "MF001",
"code": "AV_EQUIPMENT",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "AV Equipment Rental"
}
],
"quantity": 10,
"unit": "SET",
"chargeCurrencyCode": "USD",
"chargeAmount": 50,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Projector, sound system and microphone package"
}
]
}
]
}
],
"mealServices": [
{
"id": "ME001",
"code": "BREAKFAST_SERVICE",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Complimentary Breakfast Buffet"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "International breakfast buffet with hot and cold options"
}
],
"included": true,
"proximityCode": "INDOOR",
"quantity": 1,
"operationSchedules": [
{
"start": "2024-01-01",
"end": "2024-12-31",
"operationTimes": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI"],
"start": "06:30",
"end": "09:30",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Weekday Breakfast Hours"
}
]
},
{
"weekDays": ["SAT", "SUN"],
"start": "07:00",
"end": "10:30",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Weekend Breakfast Hours"
}
]
}
],
"charges": []
}
],
"features": [
{
"id": "MEF001",
"code": "VEGETARIAN_OPTIONS",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Vegetarian & Vegan Options"
}
],
"quantity": 1,
"unit": "OPTION",
"chargeCurrencyCode": "USD",
"chargeAmount": 0,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Complimentary vegetarian and vegan breakfast options"
}
]
}
]
}
],
"accessibleService": {
"id": "A001",
"code": "ACCESSIBLE_FACILITIES",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "ADA Compliant Facilities"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Wheelchair accessible rooms, ramps and elevators"
}
],
"included": true,
"proximityCode": "INDOOR",
"quantity": 1,
"operationSchedules": [
{
"start": "2024-01-01",
"end": "2024-12-31",
"operationTimes": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "00:00",
"end": "24:00",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "24/7 Availability"
}
]
}
],
"charges": []
}
],
"features": [
{
"id": "AF001",
"code": "ACCESSIBLE_ROOMS",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Wheelchair Accessible Rooms"
}
],
"quantity": 10,
"unit": "ROOM",
"chargeCurrencyCode": "USD",
"chargeAmount": 0,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Complimentary accessible room upgrade (subject to availability)"
}
]
}
]
},
"securityService": {
"id": "S001",
"code": "24_7_SECURITY",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "24-Hour Security"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "On-site security personnel and CCTV surveillance"
}
],
"included": true,
"proximityCode": "INDOOR",
"quantity": 1,
"operationSchedules": [
{
"start": "2024-01-01",
"end": "2024-12-31",
"operationTimes": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "00:00",
"end": "24:00",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "24/7 Availability"
}
]
}
],
"charges": []
}
],
"features": [
{
"id": "SF001",
"code": "KEY_CARD_ACCESS",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Key Card Access System"
}
],
"quantity": 1,
"unit": "SYSTEM",
"chargeCurrencyCode": "USD",
"chargeAmount": 0,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Secure key card access to guest floors and rooms"
}
]
}
]
}
},
"meetingRoomInformation": {
"total": 5,
"totalRoomSpace": 1000,
"totalSeatingCapacity": 500,
"largestRoomSpace": 300,
"smallestRoomSpace": 50,
"largestSeatingCapacity": 200,
"smallestSeatingCapacity": 10,
"unit": "SQ_M",
"meetingRooms": [
{
"id": "MR001",
"nameLangs": [
{
"languageCode": "EN-US",
"value": "Sunset Ballroom"
}
],
"dimension": {
"area": 300,
"height": 3.5,
"width": 15,
"length": 20,
"unit": "SQ_M"
},
"capacities": [
{
"formatCode": "THEATER",
"maxOccupancy": 200
},
{
"formatCode": "BOARDROOM",
"maxOccupancy": 50
}
],
"services": [
{
"code": "CATERING",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Catering Service"
}
],
"quantity": 1,
"chargeAmount": 50,
"chargePercent": 0,
"chargeCurrencyCode": "USD",
"chargeUnitCode": "PER_PERSON",
"chargeFrequencyCode": "PER_EVENT"
}
],
"images": [
{
"mainUrl": "https://www.derbysoftdemo.com/images/meeting-rooms/sunset-ballroom.jpg",
"richMediaUrl": "https://www.derbysoftdemo.com/videos/meeting-rooms/sunset-ballroom.mp4",
"categoryCode": "MEETING_ROOM",
"sort": 1,
"sourceId": "MR_IMG_001",
"captionLangs": [
{
"languageCode": "EN-US",
"value": "Sunset Ballroom - Theater Style"
}
],
"applicableStart": "2024-01-01",
"applicableEnd": "2024-12-31",
"items": [
{
"url": "https://www.derbysoftdemo.com/images/meeting-rooms/sunset-ballroom-large.jpg",
"width": 1920,
"height": 1080,
"size": "LARGE",
"unit": "PIXEL",
"fileSize": 2048,
"resolution": 300,
"recordId": "MR_IMG_ITEM_001",
"formatCode": "JPG"
}
],
"lastUpdated": "2024-01-01"
}
]
}
]
},
"restaurantInformation": {
"total": 2,
"restaurants": [
{
"id": "R001",
"nameLangs": [
{
"languageCode": "EN-US",
"value": "Sunset Grill"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Fine dining restaurant specializing in American cuisine with ocean views"
}
],
"maxCapacity": 100,
"proximityCode": "OUTDOOR",
"reservationsRequired": true,
"mealOffers": ["LUNCH", "DINNER"],
"relativePosition": {
"direction": "W",
"distance": "0.5",
"unit": "KM",
"toFrom": "HOTEL"
},
"restaurantTypeCodes": [
{
"code": "FINE_DINING",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Fine Dining Restaurant"
}
]
}
],
"cuisines": [
{
"code": "AMERICAN",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "American Cuisine"
}
],
"main": true
}
],
"schedules": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "12:00",
"end": "22:00",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Daily Lunch & Dinner Service"
}
]
}
],
"restaurantServices": [
{
"code": "WINE_PAIRING",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Wine Pairing Service"
}
]
}
],
"images": [
{
"mainUrl": "https://www.derbysoftdemo.com/images/restaurants/sunset-grill.jpg",
"richMediaUrl": "https://www.derbysoftdemo.com/videos/restaurants/sunset-grill.mp4",
"categoryCode": "RESTAURANT",
"sort": 1,
"sourceId": "R_IMG_001",
"captionLangs": [
{
"languageCode": "EN-US",
"value": "Sunset Grill - Outdoor Dining Area"
}
],
"applicableStart": "2024-01-01",
"applicableEnd": "2024-12-31",
"items": [
{
"url": "https://www.derbysoftdemo.com/images/restaurants/sunset-grill-large.jpg",
"width": 1920,
"height": 1080,
"size": "LARGE",
"unit": "PIXEL",
"fileSize": 1536,
"resolution": 300,
"recordId": "R_IMG_ITEM_001",
"formatCode": "JPG"
}
],
"lastUpdated": "2024-01-01"
}
]
}
]
},
"closeSeasons": [
{
"startDate": "2024-01-15",
"endDate": "2024-01-30"
}
],
"loyaltyPrograms": [
{
"nameLangs": [
{
"languageCode": "EN-US",
"value": "DerbySoft Rewards"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Earn points for every stay, redeemable for free nights, upgrades and exclusive benefits"
}
],
"travelSector": "HOSPITALITY"
}
],
"refPoints": [
{
"id": "RP001",
"nameLangs": [
{
"languageCode": "EN-US",
"value": "Los Angeles International Airport (LAX)"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Major international airport serving Los Angeles"
}
],
"detailLangs": [
{
"languageCode": "EN-US",
"value": "15 minutes from the hotel by car"
}
],
"indexPointCode": "AIRPORT",
"categoryCode": "TRANSPORTATION",
"direction": "SW",
"distance": "10",
"countryCode": "US",
"stateCode": "CA",
"cityCode": "100",
"position": {
"latitude": 33.9425,
"longitude": -118.4081,
"positionAccuracyCode": "1"
},
"unit": "KM",
"nearest": false,
"primary": true,
"sort": 1,
"toFrom": "HOTEL",
"transportations": [
{
"code": "SHUTTLE",
"chargeUnitCode": "PER_PERSON",
"chargeFrequencyCode": "PER_TRIP",
"chargeAmount": "25",
"currencyCode": "USD",
"included": false,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Hotel shuttle service to/from LAX"
}
],
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Shuttles depart every hour from 5:00 AM to 10:00 PM"
}
],
"schedules": [
{
"start": "2024-01-01",
"end": "2024-12-31",
"operationTimes": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "05:00",
"end": "22:00",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Hourly Shuttle Service"
}
]
}
],
"charges": [
{
"amount": 25,
"percent": 0,
"currencyCode": "USD",
"unitCode": "PER_PERSON",
"frequencyCode": "PER_TRIP"
}
]
}
]
}
]
}
],
"attractions": [
{
"id": "AT001",
"categoryCode": "LANDMARK",
"nameLangs": [
{
"languageCode": "EN-US",
"value": "Hollywood Walk of Fame"
}
],
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Famous sidewalk with stars honoring celebrities"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "5 minutes from the hotel by car, 15 minutes by public transport"
}
],
"proximityCode": "NEARBY",
"applicableStart": "2024-01-01",
"applicableEnd": "2024-12-31",
"url": "https://www.walkoffame.com",
"refPoints": [
{
"countryCode": "US",
"stateCode": "CA",
"position": {
"latitude": 34.1016,
"longitude": -118.3265,
"positionAccuracyCode": "1"
},
"direction": "N",
"distance": "3",
"unit": "KM"
}
],
"tags": [
{
"textLangs": [
{
"languageCode": "EN-US",
"value": "Tourist Attraction"
}
]
}
]
}
],
"recreations": [
{
"id": "REC001",
"serviceCode": "FITNESS_CENTER",
"nameLangs": [
{
"languageCode": "EN-US",
"value": "24-Hour Fitness Center"
}
],
"detailLangs": [
{
"languageCode": "EN-US",
"value": "State-of-the-art gym with cardio and strength training equipment"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Complimentary access for hotel guests"
}
],
"proximityCode": "INDOOR",
"included": true,
"schedules": [
{
"start": "2024-01-01",
"end": "2024-12-31",
"operationTimes": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "00:00",
"end": "24:00",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "24/7 Availability"
}
]
}
],
"charges": []
}
],
"services": [
{
"code": "PERSONAL_TRAINING",
"detailLangs": [
{
"languageCode": "EN-US",
"value": "Personal Training Sessions"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Available for an additional fee (by appointment only)"
}
]
}
]
}
],
"additionalDescriptions": [
{
"id": "AD001",
"additionalDetailCode": "HOTEL_FEATURES",
"recordId": "FEAT_001",
"sourceId": "HOTEL",
"title": "Hotel Features",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "This luxury hotel offers panoramic city views, personalized concierge service, and proximity to top attractions. All rooms feature premium bedding, flat-screen TVs, and marble bathrooms with rainfall showers."
}
],
"applicableStart": "2024-01-01",
"applicableEnd": "2024-12-31"
}
],
"promotions": [
{
"category": "PACKAGE",
"code": "STAY3_GET1",
"packageTypeCode": "STAY_LONGER",
"titleLangs": [
{
"languageCode": "EN-US",
"value": "Stay 3 Nights, Get 1 Free"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Book 3 consecutive nights and receive the 4th night complimentary. Valid for stays between March 1 and October 31, 2024."
}
],
"minLos": 3,
"sort": 1,
"schedules": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "2024-03-01",
"end": "2024-10-31"
}
]
}
],
"policyInformation": {
"propertyPolicy": {
"acceptedGuestType": "1",
"roomGuaranteedLateArrival": true,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Late arrival guaranteed with credit card. Check-in after midnight requires prior notification."
}
],
"petsAllowed": "YES"
},
"childPolicy": {
"minGuestAge": 0,
"maxChildAge": 12,
"freeCutOffAge": 6,
"freeChildPerAdult": 2,
"kidsStayFree": true
},
"checkOutPolicy": {
"start": "06:00",
"end": "11:00",
"type": "STANDARD",
"chargeNights": 1,
"chargeAmount": 199.00,
"chargePercent": 0,
"currencyCode": "USD",
"balanceOfStay": false,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Late check-out after 11:00 AM subject to availability. 50% of nightly rate charged for check-out between 11:00 AM and 6:00 PM. Full nightly rate charged for check-out after 6:00 PM."
}
]
},
"commissionPolicy": {
"amount": 0,
"percent": 15,
"currencyCode": "USD",
"paymentCompanyLangs": [
{
"languageCode": "EN-US",
"value": "DerbySoft Payment Services"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "15% commission paid to authorized travel agents. Commission payments processed on a monthly basis."
}
]
},
"generalPolicies": [
{
"nameLangs": [
{
"languageCode": "EN-US",
"value": "Smoking Policy"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Hotel is 100% non-smoking. Smoking in guest rooms will result in a $250 cleaning fee."
}
]
}
],
"cancelPolicies": [
{
"code": "C001",
"nonRefundable": false,
"roomTypeCode": "ALL",
"cancelPenalty": {
"taxInclusive": true,
"feeInclusive": true,
"chargeNights": 1,
"chargeAmount": 199.00,
"chargePercent": 0,
"currencyCode": "USD",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "1 night's stay charged for cancellations made less than 48 hours prior to arrival."
}
]
},
"cancelDeadline": {
"absoluteDeadline": "",
"offsetTimeUnit": "HOUR",
"offsetUnitMultiplier": 48,
"offsetDropTimeType": "ARRIVAL"
},
"schedules": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "2024-01-01",
"end": "2024-12-31"
}
]
}
],
"guaranteePaymentPolicies": [
{
"code": "G001",
"type": "CREDIT_CARD",
"retributionType": "CHARGE",
"guaranteeType": "PRE_AUTH",
"roomTypeCode": "ALL",
"nonRefundable": false,
"holdTime": "72",
"offsetTimeUnit": "HOUR",
"offsetUnitMultiplier": 24,
"offsetDropTimeType": "ARRIVAL",
"chargeNights": 1,
"chargeAmount": 199.00,
"chargePercent": 0,
"currencyCode": "USD",
"descriptions": [
{
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Credit card required to guarantee reservation. 1 night's stay pre-authorized 24 hours prior to arrival."
}
]
}
],
"schedules": [
{
"weekDays": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
"start": "2024-01-01",
"end": "2024-12-31"
}
],
"acceptedPayments": [
{
"guarantee": true,
"paymentTypeCode": "CREDIT_CARD",
"cardTypeCode": "VISA",
"cardTypeDescriptionLangs": [
{
"languageCode": "EN-US",
"value": "Visa Credit Card"
}
]
},
{
"guarantee": true,
"paymentTypeCode": "CREDIT_CARD",
"cardTypeCode": "MASTERCARD",
"cardTypeDescriptionLangs": [
{
"languageCode": "EN-US",
"value": "Mastercard Credit Card"
}
]
}
],
"addresses": [
{
"paymentReceiverName": "DerbySoft DEMO Hotel",
"useTypeCode": "BILLING",
"postalCode": "90015",
"countryCode": "US",
"stateCode": "CA",
"streetNumberPoBoxLangs": [
{
"languageCode": "EN-US",
"value": "1234 Sunset Blvd"
}
],
"countryNameLangs": [
{
"languageCode": "EN-US",
"value": "United States"
}
],
"stateNameLangs": [
{
"languageCode": "EN-US",
"value": "California"
}
],
"cityNameLangs": [
{
"languageCode": "EN-US",
"value": "Los Angeles"
}
],
"addressLines": [
{
"addressLineLangs": [
{
"languageCode": "EN-US",
"value": "1234 Sunset Blvd, Los Angeles, CA 90015"
}
]
}
]
}
]
}
],
"petPolicies": [
{
"code": "P001",
"unit": "KG",
"size": 20,
"maxPetQuantity": 1,
"refundableDeposit": 100.00,
"nonRefundableFee": 50.00,
"chargeUnitCode": "PER_STAY",
"currencyCode": "USD",
"restriction": true,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Pets up to 20kg allowed in designated rooms. $100 refundable deposit and $50 non-refundable cleaning fee required. Pets must be crated when left unattended in the room."
}
]
}
],
"taxPolicies": [
{
"type": "HOTEL_TAX",
"code": "CA_HOTEL_TAX",
"chargeAmount": 0,
"chargePercent": 12,
"currencyCode": "USD",
"effectiveDate": "2024-01-01",
"expireDate": "2024-12-31",
"chargeUnitCode": "PER_NIGHT",
"chargeFrequencyCode": "PER_STAY",
"sort": 1,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "12% hotel occupancy tax applied to all stays. Tax is subject to change without notice."
}
]
}
],
"feePolicies": [
{
"type": "RESORT_FEE",
"code": "RESORT_FEE",
"chargeAmount": 35.00,
"chargePercent": 0,
"currencyCode": "USD",
"effectiveDate": "2024-01-01",
"expireDate": "2024-12-31",
"mandatory": true,
"chargeUnitCode": "PER_NIGHT",
"chargeFrequencyCode": "PER_STAY",
"taxableIndicator": true,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "$35 per night resort fee includes WiFi, pool access, fitness center access and local calls. Fee is taxable."
}
]
}
],
"ratePolicies": [
{
"corporateIdRequired": false,
"type": "PUBLIC",
"identifyRequired": false,
"guestTypeCode": "ALL",
"minRoomNightCommitment": 1,
"rateOfferTypeCode": "STANDARD",
"descriptions": [
{
"nameLangs": [
{
"languageCode": "EN-US",
"value": "Standard Public Rate"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Public rate available to all guests with no restrictions. Includes complimentary breakfast and WiFi."
}
]
}
]
}
],
"checkInPolicy": {
"start": "15:00",
"end": "24:00",
"option": "STANDARD",
"instructionLangs": [
{
"languageCode": "EN-US",
"value": "Check-in begins at 3:00 PM. Early check-in subject to availability. Please contact the hotel in advance to request early check-in."
}
]
}
},
"otherProperties": [
{
"propertyCode": "derbydemo002",
"propertyNameLangs": [
{
"languageCode": "EN-US",
"value": "DerbySoft DEMO - New York"
}
],
"chainCode": "100",
"brandCode": "200",
"segmentCode": "300",
"contextCode": "derbydemo",
"competitor": false
}
],
"propertyMappings": [
{
"sourceCode": "AMADEUS",
"sourceName": "Amadeus GDS",
"sourceType": "GDS",
"propertyCode": "DBSF_LAX",
"chainCode": "100",
"propertyName": "DerbySoft DEMO Hotel Los Angeles",
"propertyShortName": "DerbySoft LAX"
},
{
"sourceCode": "SABRE",
"sourceName": "Sabre GDS",
"sourceType": "GDS",
"propertyCode": "DSLAX123",
"chainCode": "100",
"propertyName": "DerbySoft DEMO Hotel Los Angeles",
"propertyShortName": "DerbySoft LAX"
}
],
"environmentImpact": {
"carbonFootprint": {
"meetingEvent": 50,
"roomNight": 15,
"weatherNormalized": 12,
"unit": "KG_CO2"
},
"water": {
"grayWater": true,
"waterProgram": true,
"perRoomNightUsage": 200,
"perRoomDayUsage": 150,
"wasteDiversionPercentage": 75,
"unit": "LITERS",
"descriptions": [
{
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Hotel implements water conservation program, including low-flow fixtures and gray water recycling."
}
]
}
]
},
"energy": {
"efficientAppliances": true,
"efficientLighting": true,
"heatPowerComb": false,
"heatPump": true,
"powerSavingPolicy": true,
"solar": false,
"temperatureControl": true,
"windTurbine": false,
"energyGenerated": 0,
"energyStarRating": "4",
"energyUsages": [
{
"powerType": "ELECTRICITY",
"unit": "KWH",
"quantity": 50000,
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Monthly electricity consumption (average)"
}
]
}
]
},
"recycling": {
"activeProgram": true,
"ecologicalDishware": true,
"descriptions": [
{
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Comprehensive recycling program for paper, plastic, glass and metal. Biodegradable dishware used in restaurants and events."
}
]
}
]
},
"environmentGeneral": {
"certificationAvail": true,
"chemicalAllergies": true,
"environmentCleaner": true,
"linenReuse": true,
"procurementPolicy": true,
"certifications": [
{
"nameLangs": [
{
"languageCode": "EN-US",
"value": "LEED Silver Certification"
}
]
}
],
"environments": [
{
"nameLangs": [
{
"languageCode": "EN-US",
"value": "Sustainable Operations Program"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Hotel is committed to reducing environmental impact through sustainable operations and responsible sourcing."
}
]
}
]
}
},
"viewerShips": [
{
"distributorCode": "BOOKING",
"distributorTypeCode": "OTA",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Booking.com - Global OTA Distribution Channel"
}
]
},
{
"distributorCode": "EXPEDIA",
"distributorTypeCode": "OTA",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Expedia Group - Global OTA Distribution Channel"
}
]
},
{
"distributorCode": "AMADEUS",
"distributorTypeCode": "GDS",
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Amadeus GDS - Travel Agent Distribution Channel"
}
]
}
],
"images": [
{
"mainUrl": "https://www.derbysoftdemo.com/images/exterior.jpg",
"richMediaUrl": "https://www.derbysoftdemo.com/videos/exterior.mp4",
"categoryCode": "1",
"sort": 1,
"sourceId": "IMG_001",
"captionLangs": [
{
"languageCode": "EN-US",
"value": "Hotel Exterior"
}
],
"applicableStart": "2024-01-01",
"applicableEnd": "2024-12-31",
"items": [
{
"url": "https://www.derbysoftdemo.com/images/exterior-large.jpg",
"width": 1920,
"height": 1080,
"size": "LARGE",
"unit": "PIXEL",
"fileSize": 2048,
"resolution": 300,
"recordId": "IMG_ITEM_001",
"formatCode": "JPG"
},
{
"url": "https://www.derbysoftdemo.com/images/exterior-small.jpg",
"width": 640,
"height": 360,
"size": "SMALL",
"unit": "PIXEL",
"fileSize": 512,
"resolution": 72,
"recordId": "IMG_ITEM_002",
"formatCode": "JPG"
}
],
"lastUpdated": "2024-01-01"
},
{
"mainUrl": "https://www.derbysoftdemo.com/images/room.jpg",
"richMediaUrl": "https://www.derbysoftdemo.com/videos/room.mp4",
"categoryCode": "2",
"sort": 2,
"sourceId": "IMG_002",
"captionLangs": [
{
"languageCode": "EN-US",
"value": "Deluxe King Room"
}
],
"applicableStart": "2024-01-01",
"applicableEnd": "2024-12-31",
"items": [
{
"url": "https://www.derbysoftdemo.com/images/room-large.jpg",
"width": 1920,
"height": 1080,
"size": "LARGE",
"unit": "PIXEL",
"fileSize": 1800,
"resolution": 300,
"recordId": "IMG_ITEM_003",
"formatCode": "JPG"
}
],
"lastUpdated": "2024-01-01"
}
],
"host": {
"id": "HOST_001",
"name": "John Smith",
"introductionLangs": [
{
"languageCode": "EN-US",
"value": "With over 15 years of hospitality experience, John leads the hotel team in delivering exceptional guest service."
}
],
"jobLangs": [
{
"languageCode": "EN-US",
"value": "General Manager"
}
]
},
"extensions": {
"additionalProp1": "WiFi_SPEED=1Gbps",
"additionalProp2": "SMOKING_POLICY=NON_SMOKING",
"additionalProp3": "PARKING_FEE=35_USD_PER_DAY"
},
"contextCode": "derbydemo",
"supplierCode": "DERBYHOTEL",
"propertyCode": "derbydemo001",
"operateStatus": "ENABLED",
"richMedia": {
"url": "https://www.derbysoftdemo.com/videos/hotel-overview.mp4"
}
}Response Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
contextCode | string | Context Code in DerbySoft's system. | DERBYDEMO |
supplierCode | string | Supplier Code in DerbySoft's system. | DERBYDEMO |
propertyCode | string | Property code provided by content suppliers, only the following characters are allowed. 1. Digits (0-9) 2. Uppercase letters (A-Z) 3. Hyphen ('-') | BONITAPROPERTY |
operateStatus | String | Indicates the operational status of the property. Enum: [ ENABLED, PAUSED ] | ENABLED |
Example Response
Success Response (HTTP Status 200)
{
"data": {
"contextCode": "derbydemo",
"supplierCode": "DERBYHOTEL",
"propertyCode": "derbydemo001",
"operateStatus": "ENABLED"
}
}Error Response (HTTP Status 403)
{
"error": {
"code": "FORBIDDEN",
"message": "Lack of permissions, please configure permissions."
}
}Error Response (HTTP Status 500)
{
"error": {
"code": "Invalid latitude",
"message": "latitude should be in the range of [-90, 90]"
}
}Related Articles:
Did you find it helpful? Yes No
Send feedbackSorry we couldn't be helpful. Help us improve this article with your feedback.