Content Solutions Open API

TABLE OF CONTENTS

Introduction
Get Guestroom
Get Guestroom Content with {guestRoomCode}
POST Guestroom Content
Related Articles:

Introduction

Get Guestroom: This API retrieves a list of guest rooms for a specified property within the system, providing detailed room information.
Get Guestroom Content with {guestRoomCode}: This API retrieves the content details of a specific guest room using the provided {guestroomCode}, allowing users to query a single room's information within a specified property.
POST Guestroom Content: This API performs a full update of guest room content in the system, replacing all existing data with the new submission for a specified property.

Get Guestroom

This API retrieves a list of guest rooms for a specified property within the system, providing detailed room information.

API Endpoints & Methods

Base URL: https://contentsolutions-supplier.derbysoftsec.com
HTTP method	URL
GET	/api/content/guest_rooms

Headers

Name	Type	Required	Description	Example
Authorization	String	required	Basic Authentication token for API access.	Basic VzM4dFI4S1lvNzh2OnczMnowME15RXk2Q1hGMTI=
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)	Yes	Context Code in DerbySoft's system.	DERBYDEMO
propertyCode	String(query)	Yes	Property code provided by content suppliers, only the following characters are allowed. 1. Digits (0-9) 2. Uppercase letters (A-Z) 3. Hyphen ('-')	BONITAPROPERTY

Parameter

Type

Required

Description

Example

contextCode

String(query)

Yes

Context Code in DerbySoft's system.

DERBYDEMO

propertyCode

String(query)

Yes

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

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
guestRooms	List<RoomType>	List of property room types.
code	String	Unique code identifying the room type.
nameLangs	List<I18N>	Multilingual name of the room type.
descriptionLangs	List<I18N>	Multilingual description of the room type.
area	Integer	Room size in square units (feet/meters).
unit	String	Number of rooms that form a composite unit (e.g., a two-bedroom suite).
roomCategory Code	String	Room category (e.g., Moderate, Standard, Deluxe). Refer to OpenTravel Segment Category Code (SEG).
roomLocation Code	String	Room location within the property (e.g., Near Exit, Low Floor). Refer to OpenTravel Room Location Type (RLT).
roomView Code	String	Room view type (e.g., Ocean View, Garden View). Refer to OpenTravel Room View Type (RVT).
window	Boolean	If true, the room has a window.
nonsmoking	Boolean	If true, the room is non-smoking.
accessible Room	Boolean	If true, the room is accessible.
occupancy	Object<Occupancy>	Maximum and minimum occupancy details.
occupancy.max Occupancy	Integer	Maximum guests allowed.
occupancy.minOccupancy	Integer	Minimum guests required.
occupancy.max AdultOccupancy	Integer	Maximum number of adults allowed.
occupancy.max ChildOccupancy	Integer	Maximum number of children allowed.
numberOfRoom	Object<Number OfRoom>	Breakdown of room composition.
numberOfRoom. bedrooms	Integer	Number of bedrooms.
numberOfRoom. bathrooms	Integer	Number of bathrooms.
numberOfRoom. livingRooms	Integer	Number of living rooms.
bedInformation	Object <BedInformation>	Details on bed types and availability.
bedInformation. maxRollaways	Integer	Maximum rollaway beds allowed.
bedInformation. maxCribs	Integer	Maximum cribs allowed.
bedInformation. bedTypes	List<BedType>	List of available bed types.
bedInformation. bedTypes.code	String	Bed type (e.g., Double, Queen, King). Refer to OpenTravel Bed Type Code (BED).
bedInformation. bedTypes.count	Integer	Number of beds of this type.
amenities	List<Amenity>	List of room amenities.
amenities.id	String	Unique ID for the amenity.
amenities.code	String	Amenity type. Refer to OpenTravel Room Amenity Type (RMA).
amenities.detailLangs	List<I18N>	Multilingual details of the amenity.
amenities. descriptionLangs	List<I18N>	Multilingual description of the amenity.
amenities.included	Boolean	If true, the amenity is included in the room rate.
amenities. proximityCode	String	Amenity availability (onsite/offsite). Refer to OpenTravel Proximity Code (PRX).
amenities. quantity	Integer	Number of this amenity in the room.
amenities. operationSchedules	List <OperationSchedule>	Amenity operating times and charges.
amenities.operation Schedules.start	String	Start date. Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22.
amenities.operation Schedules.end	String	End date. Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22.
amenities.operation Schedules.operationTimes	List<OperationTime>	List of operation times.
amenities.operation Schedules.operationTimes. weekDays	String	Day of operation. Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ]
amenities.operation Schedules.operationTimes. startTime	String	Start time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22.
amenities.operationSchedules. operationTimes.endTime	String	End time. Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22.
amenities.operationSchedules. charges	List<ServiceCharge>	Charges for the amenity.
amenities.operationSchedules. charges.amount	Double	Fixed fee amount.
amenities.operationSchedules. charges.percent	Double	Fee percentage of total stay.
amenities.operationSchedules. charges.currency	String	Currency code for the charge.
amenities.operationSchedules. charges.unitCode	String	Charge unit. Refer to OpenTravel Charge Type (CHG).
amenities.operationSchedules. charges.frequencyCode	String	Frequency of charge (e.g., Daily, Stay).
accessibleFeatures	List<Feature>	Accessibility features of the room.
accessibleFeatures.id	String	Unique ID.
accessibleFeatures.code	String	Accessibility feature. Refer to OpenTravel Disability Feature Code (PHY).
accessibleFeatures.detailLangs	List<I18N>	Multilingual details of accessibility features.
accessibleFeatures.quantity	Integer	Number of accessible units.
accessibleFeatures.unit	String	Unit of measure (e.g., meters, feet).
accessibleFeatures. chargeCurrencyCode	String	Currency for accessibility-related charges.
accessibleFeatures. chargeAmount	Double	Fixed charge amount.
accessibleFeatures. descriptionLangs	List<I18N>	Multilingual description of accessibility features.
securityFeatures	List<Feature>	Security features available in the room.
securityFeatures.id	String	Unique ID.
securityFeatures.code	String	Security feature type. Refer to OpenTravel Proximity Code (PRX).
securityFeatures.detailLangs	List<I18N>	Multilingual details of security features.
securityFeatures.quantity	Integer	Number of security features in the room.
securityFeatures.unit	String	Unit of measure (e.g., meters, feet).
securityFeatures. chargeCurrencyCode	String	Currency for security-related charges.
securityFeatures. chargeAmount	Double	Fixed charge amount.
securityFeatures. descriptionLangs	List<I18N>	Multilingual description of security features.
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.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 Response

Success Response (HTTP Status 200)

{
    "data": {
        "contextCode": "derbydemo",
        "supplierCode": "DERBYHOTEL",
        "propertyCode": "derbydemo001",
        "operateStatus": "ENABLED",
        "guestRooms": [
            {
                "contextCode": "derbydemo",
                "propertyCode": "DSJPRLWHD6J90Z4",
                "code": "DLX-KING",
                "nameLangs": [
                    {
                        "languageCode": "EN-US",
                        "value": "Deluxe King Room"
                    }
                ],
                "descriptionLangs": [
                    {
                        "languageCode": "EN-US",
                        "value": "Spacious room with a king-size bed and city view, offering modern amenities."
                    }
                ],
                "area": 35,
                "unit": "sqm",
                "roomCategoryCode": "101",
                "roomLocationCode": "LOW_FLOOR",
                "roomViewCode": "CITY",
                "window": true,
                "nonsmoking": true,
                "accessibleRoom": false,
                "occupancy": {
                    "maxOccupancy": 3,
                    "minOccupancy": 1,
                    "maxAdultOccupancy": 2,
                    "maxChildOccupancy": 1
                },
                "numberOfRoom": {
                    "bedrooms": 1,
                    "bathrooms": 1,
                    "livingRooms": 0
                },
                "bedInformation": {
                    "bedTypes": [
                        {
                            "code": "KING",
                            "count": 1
                        }
                    ],
                    "maxRollaways": 1,
                    "maxCribs": 1
                },
                "amenities": [
                    {
                        "id": "wifi",
                        "code": "101",
                        "detailLangs": [
                            {
                                "languageCode": "EN-US",
                                "value": "Free High-Speed WiFi"
                            }
                        ],
                        "descriptionLangs": [
                            {
                                "languageCode": "EN-US",
                                "value": "Complimentary high-speed internet access available in the room."
                            }
                        ],
                        "included": true,
                        "proximityCode": "ONSITE",
                        "quantity": 1,
                        "operationSchedules": [
                            {
                                "start": "2023-01-01",
                                "end": "2023-12-31",
                                "operationTimes": [
                                    {
                                        "weekDay": "MONDAY",
                                        "start": "00:00",
                                        "end": "23:59",
                                        "descriptionLangs": [
                                            {
                                                "languageCode": "EN-US",
                                                "value": "Available 24/7"
                                            }
                                        ]
                                    }
                                ],
                                "charges": [
                                    {
                                        "amount": "0",
                                        "percent": "0",
                                        "currencyCode": "USD",
                                        "unitCode": "N/A",
                                        "frequencyCode": "N/A"
                                    }
                                ]
                            }
                        ]
                    }
                ],
                "securityFeatures": [
                    {
                        "id": "security1",
                        "code": "SAFE",
                        "detailLangs": [
                            {
                                "languageCode": "EN-US",
                                "value": "In-room Safe"
                            }
                        ],
                        "quantity": 1,
                        "unit": "room",
                        "chargeCurrencyCode": "USD",
                        "chargeAmount": "0",
                        "descriptionLangs": [
                            {
                                "languageCode": "EN-US",
                                "value": "An in-room safe is provided for guest valuables."
                            }
                        ]
                    }
                ],
                "images": [
                    {
                        "mainUrl": "https://www.derbysoftdemo.com/images/room.jpg",
                        "categoryCode": "ROOM",
                        "sort": 1,
                        "sourceId": "image001",
                        "captionLangs": [
                            {
                                "languageCode": "EN-US",
                                "value": "Deluxe King Room"
                            }
                        ],
                        "applicableStart": "2023-01-01",
                        "applicableEnd": "2023-12-31",
                        "items": [
                            {
                                "url": "https://www.derbysoftdemo.com/images/room_large.jpg",
                                "width": 1920,
                                "height": 1080,
                                "size": "2MB",
                                "unit": "MB",
                                "fileSize": 2048,
                                "resolution": 300,
                                "recordId": "image001_large",
                                "formatCode": "JPEG"
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

Error Response (HTTP Status 403)

{
    "error": {
        "code": "FORBIDDEN",
        "message": "Lack of permissions, please configure permissions."
    }
}

Error Response (HTTP Status 400)

{
    "error": {
        "code": "MissingField",
        "message": "Required request parameter 'contextCode' for method parameter type String is not present"
    }
}

Get Guestroom Content with {guestRoomCode}

This API retrieves the content details of a specific guest room using the provided {guestroomCode}, allowing users to query a single room's information within a specified property.

API Endpoints & Methods

Base URL: https://contentsolutions-supplier.derbysoftsec.com
HTTP method	URL
GET	/api/content/guest_rooms/{guestRoomCode}

Headers

Name	Type	Required	Description	Example
Authorization	String	required	Basic Authentication token for API access.	Basic VzM4dFI4S1lvNzh2OnczMnowME15RXk2Q1hGMTI=
Content-Type	String	required	Specifies the media type of the request.	application/json;charset=UTF-8

Query Parameters

Parameter	Type	Required	Description	Example
guestRoomCode	String(path)	Yes	Unique code identifying the room type.	DLX-KING
contextCode	String(query)	Yes	Context Code in DerbySoft's system.	DERBYDEMO
propertyCode	String(query)	Yes	Property code provided by content suppliers, only the following characters are allowed. 1. Digits (0-9) 2. Uppercase letters (A-Z) 3. Hyphen ('-')	BONITAPROPERTY

Parameter

Type

Required

Description

Example

guestRoomCode

String(path)

Yes

Unique code identifying the room type.

DLX-KING

contextCode

String(query)

Yes

Context Code in DerbySoft's system.

DERBYDEMO

propertyCode

String(query)

Yes

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 [GET Guestroom] Response Parameters.

Example Response

Success Response (HTTP Status 200)

{
    "data": {
        "contextCode": "derbydemo",
        "supplierCode": "DERBYHOTEL",
        "propertyCode": "derbydemo001",
        "operateStatus": "ENABLED",
        "code": "DLX-KING",
        "nameLangs": [
            {
                "languageCode": "EN-US",
                "value": "Deluxe King Room"
            }
        ],
        "descriptionLangs": [
            {
                "languageCode": "EN-US",
                "value": "Spacious room with a king-size bed and city view, offering modern amenities."
            }
        ],
        "area": 35,
        "unit": "sqm",
        "roomCategoryCode": "101",
        "roomLocationCode": "LOW_FLOOR",
        "roomViewCode": "CITY",
        "window": true,
        "nonsmoking": true,
        "accessibleRoom": false,
        "occupancy": {
            "maxOccupancy": 3,
            "minOccupancy": 1,
            "maxAdultOccupancy": 2,
            "maxChildOccupancy": 1
        },
        "numberOfRoom": {
            "bedrooms": 1,
            "bathrooms": 1,
            "livingRooms": 0
        },
        "bedInformation": {
            "bedTypes": [
                {
                    "code": "KING",
                    "count": 1
                }
            ],
            "maxRollaways": 1,
            "maxCribs": 1
        },
        "amenities": [
            {
                "id": "wifi",
                "code": "101",
                "detailLangs": [
                    {
                        "languageCode": "EN-US",
                        "value": "Free High-Speed WiFi"
                    }
                ],
                "descriptionLangs": [
                    {
                        "languageCode": "EN-US",
                        "value": "Complimentary high-speed internet access available in the room."
                    }
                ],
                "included": true,
                "proximityCode": "ONSITE",
                "quantity": 1,
                "operationSchedules": [
                    {
                        "start": "2023-01-01",
                        "end": "2023-12-31",
                        "operationTimes": [
                            {
                                "weekDay": "MONDAY",
                                "start": "00:00",
                                "end": "23:59",
                                "descriptionLangs": [
                                    {
                                        "languageCode": "EN-US",
                                        "value": "Available 24/7"
                                    }
                                ]
                            }
                        ],
                        "charges": [
                            {
                                "amount": "0",
                                "percent": "0",
                                "currencyCode": "USD",
                                "unitCode": "N/A",
                                "frequencyCode": "N/A"
                            }
                        ]
                    }
                ]
            }
        ],
        "securityFeatures": [
            {
                "id": "security1",
                "code": "SAFE",
                "detailLangs": [
                    {
                        "languageCode": "EN-US",
                        "value": "In-room Safe"
                    }
                ],
                "quantity": 1,
                "unit": "room",
                "chargeCurrencyCode": "USD",
                "chargeAmount": "0",
                "descriptionLangs": [
                    {
                        "languageCode": "EN-US",
                        "value": "An in-room safe is provided for guest valuables."
                    }
                ]
            }
        ],
        "images": [
            {
                "mainUrl": "https://www.derbysoftdemo.com/images/room.jpg",
                "categoryCode": "ROOM",
                "sort": 1,
                "sourceId": "image001",
                "captionLangs": [
                    {
                        "languageCode": "EN-US",
                        "value": "Deluxe King Room"
                    }
                ],
                "applicableStart": "2023-01-01",
                "applicableEnd": "2023-12-31",
                "items": [
                    {
                        "url": "https://www.derbysoftdemo.com/images/room_large.jpg",
                        "width": 1920,
                        "height": 1080,
                        "size": "2MB",
                        "unit": "MB",
                        "fileSize": 2048,
                        "resolution": 300,
                        "recordId": "image001_large",
                        "formatCode": "JPEG"
                    }
                ]
            }
        ]
    }
}

Error Response (HTTP Status 403)

{
    "error": {
        "code": "FORBIDDEN",
        "message": "Lack of permissions, please configure permissions."
    }
}

Error Response (HTTP Status 400)

{
    "error": {
        "code": "MissingField",
        "message": "Required request parameter 'contextCode' for method parameter type String is not present"
    }
}

POST Guestroom Content

This API performs a full update of guest room content in the system, replacing all existing data with the new submission for a specified property.

API Endpoints & Methods

Base URL: https://contentsolutions-supplier.derbysoftsec.com
HTTP method	URL
POST	/api/content/guest_rooms/batch_save

Headers

Name	Type	Required	Description	Example
Authorization	String	required	Basic Authentication token for API access.	Basic VzM4dFI4S1lvNzh2OnczMnowME15RXk2Q1hGMTI=
Content-Type	String	required	Specifies the media type of the request.	application/json;charset=UTF-8

Query Parameters

Parameter	Required	Type	Description	Example
contextCode	Yes	String	Context Code in DerbySoft's system.	derbydemo
propertyCode	Yes	String	Property code provided by content suppliers, only the following characters are allowed. 1. Digits (0-9) 2. Uppercase letters (A-Z) 3. Hyphen ('-')	derbydemo001
guestRooms	Yes(create guestrooms)	List<RoomType>	List of property room types.
code	Yes(create guestrooms)	String	Unique code identifying the room type.
nameLangs	Yes(create guestrooms)	List<I18N>	Multilingual name of the room type.
descriptionLangs		List<I18N>	Multilingual description of the room type.
area		Integer	Room size in square units (feet/meters).
unit		String	Number of rooms that form a composite unit (e.g., a two-bedroom suite).
roomCategoryCode		String	Room category (e.g., Moderate, Standard, Deluxe). Refer to OpenTravel Segment Category Code (SEG).
roomLocationCode		String	Room location within the property (e.g., Near Exit, Low Floor). Refer to OpenTravel Room Location Type (RLT).
roomViewCode		String	Room view type (e.g., Ocean View, Garden View). Refer to OpenTravel Room View Type (RVT).
window		Boolean	If true, the room has a window.
nonsmoking		Boolean	If true, the room is non-smoking.
accessibleRoom		Boolean	If true, the room is accessible.
occupancy		Object <Occupancy>	Maximum and minimum occupancy details.
occupancy. maxOccupancy		Integer	Maximum guests allowed.
occupancy. minOccupancy		Integer	Minimum guests required.
occupancy. maxAdultOccupancy		Integer	Maximum number of adults allowed.
occupancy. maxChildOccupancy		Integer	Maximum number of children allowed.
numberOfRoom		Object <NumberOfRoom>	Breakdown of room composition.
numberOfRoom. bedrooms		Integer	Number of bedrooms.
numberOfRoom. bathrooms		Integer	Number of bathrooms.
numberOfRoom. livingRooms		Integer	Number of living rooms.
bedInformation		Object <BedInformation>	Details on bed types and availability.
bedInformation. maxRollaways		Integer	Maximum rollaway beds allowed.
bedInformation. maxCribs		Integer	Maximum cribs allowed.
bedInformation. bedTypes		List<BedType>	List of available bed types.
bedInformation.bedTypes.code		String	Bed type (e.g., Double, Queen, King). Refer to OpenTravel Bed Type Code (BED).
bedInformation.bedTypes.count		Integer	Number of beds of this type.
amenities		List<Amenity>	List of room amenities.
amenities.id		String	Unique ID for the amenity.
amenities.code		String	Amenity type. Refer to OpenTravel Room Amenity Type (RMA).
amenities.detailLangs		List<I18N>	Multilingual details of the amenity.
amenities.descriptionLangs		List<I18N>	Multilingual description of the amenity.
amenities.included		Boolean	If true, the amenity is included in the room rate.
amenities. proximityCode		String	Amenity availability (onsite/offsite). Refer to OpenTravel Proximity Code (PRX).
amenities.quantity		Integer	Number of this amenity in the room.
amenities. operationSchedules		List <OperationSchedule>	Amenity operating times and charges.
amenities.operationSchedules.start		String	Start date of availability.
amenities.operationSchedules.end		String	End date of availability.
amenities.operationSchedules. operationTimes		List<OperationTime>	List of operation times.
amenities.operationSchedules. operationTimes.weekDay		String	Day of operation. Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ]
amenities.operationSchedules. operationTimes.startTime		String	Start time.
amenities.operationSchedules. operationTimes.endTime		String	End time.
amenities.operationSchedules. charges		List<ServiceCharge>	Charges for the amenity.
amenities.operationSchedules. charges.amount		Double	Fixed fee amount.
amenities.operationSchedules. charges.percent		Double	Fee percentage of total stay.
amenities.operationSchedules. charges.currency		String	Currency code for the charge.
amenities.operationSchedules. charges.unitCode		String	Charge unit. Refer to OpenTravel Charge Type (CHG).
amenities.operationSchedules. charges.frequencyCode		String	Frequency of charge (e.g., Daily, Stay).
accessibleFeatures		List<Feature>	Accessibility features of the room.
accessibleFeatures.id		String	Unique ID.
accessibleFeatures.code		String	Accessibility feature. Refer to OpenTravel Disability Feature Code (PHY).
accessibleFeatures.detailLangs		List<I18N>	Multilingual details of accessibility features.
accessibleFeatures.quantity		Integer	Number of accessible units.
accessibleFeatures.unit		String	Unit of measure (e.g., meters, feet).
accessibleFeatures.chargeCurrencyCode		String	Currency for accessibility-related charges.
accessibleFeatures.chargeAmount		Double	Fixed charge amount.
accessibleFeatures.descriptionLangs		List<I18N>	Multilingual description of accessibility features.
securityFeatures		List<Feature>	Security features available in the room.
securityFeatures.id		String	Unique ID.
securityFeatures.code		String	Security feature type. Refer to OpenTravel Proximity Code (PRX).
securityFeatures.detailLangs		List<I18N>	Multilingual details of security features.
securityFeatures.quantity		Integer	Number of security features in the room.
securityFeatures.unit		String	Unit of measure (e.g., meters, feet).
securityFeatures.chargeCurrencyCode		String	Currency for security-related charges.
securityFeatures.chargeAmount		Double	Fixed charge amount.
securityFeatures.descriptionLangs		List<I18N>	Multilingual description of security features.
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.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

{
  "contextCode": "derbydemo",
  "propertyCode": "derbydemo001",
  "guestRooms": [
    {
      "code": "DLX-KING",
      "nameLangs": [
        {
          "languageCode": "EN-US",
          "value": "Deluxe King Room"
        }
      ],
      "descriptionLangs": [
        {
          "languageCode": "EN-US",
          "value": "Spacious room with a king-size bed and city view, offering modern amenities."
        }
      ],
      "area": 35,
      "unit": "sqm",
      "roomCategoryCode": "101",
      "roomLocationCode": "LOW_FLOOR",
      "roomViewCode": "CITY",
      "window": true,
      "nonsmoking": true,
      "accessibleRoom": false,
      "occupancy": {
        "maxOccupancy": 3,
        "minOccupancy": 1,
        "maxAdultOccupancy": 2,
        "maxChildOccupancy": 1
      },
      "numberOfRoom": {
        "bedrooms": 1,
        "bathrooms": 1,
        "livingRooms": 0
      },
      "bedInformation": {
        "bedTypes": [
          {
            "code": "KING",
            "count": 1
          }
        ],
        "maxRollaways": 1,
        "maxCribs": 1
      },
      "amenities": [
        {
          "id": "wifi",
          "code": "101",
          "detailLangs": [
            {
              "languageCode": "EN-US",
              "value": "Free High-Speed WiFi"
            }
          ],
          "descriptionLangs": [
            {
              "languageCode": "EN-US",
              "value": "Complimentary high-speed internet access available in the room."
            }
          ],
          "included": true,
          "proximityCode": "ONSITE",
          "quantity": 1,
          "operationSchedules": [
            {
              "start": "2023-01-01",
              "end": "2023-12-31",
              "operationTimes": [
                {
                  "weekDay": "MONDAY",
                  "start": "00:00",
                  "end": "23:59",
                  "descriptionLangs": [
                    {
                      "languageCode": "EN-US",
                      "value": "Available 24/7"
                    }
                  ]
                }
              ],
              "charges": [
                {
                  "amount": 0,
                  "percent": 0,
                  "currencyCode": "USD",
                  "unitCode": "N/A",
                  "frequencyCode": "N/A"
                }
              ]
            }
          ]
        }
      ],
      "accessibleFeatures": [
        {
          "id": "access1",
          "code": "ADA",
          "detailLangs": [
            {
              "languageCode": "EN-US",
              "value": "Wheelchair Accessible Bathroom"
            }
          ],
          "quantity": 1,
          "unit": "room",
          "chargeCurrencyCode": "USD",
          "chargeAmount": 0,
          "descriptionLangs": [
            {
              "languageCode": "EN-US",
              "value": "Accessible bathroom for guests with mobility impairments."
            }
          ]
        }
      ],
      "securityFeatures": [
        {
          "id": "security1",
          "code": "SAFE",
          "detailLangs": [
            {
              "languageCode": "EN-US",
              "value": "In-room Safe"
            }
          ],
          "quantity": 1,
          "unit": "room",
          "chargeCurrencyCode": "USD",
          "chargeAmount": 0,
          "descriptionLangs": [
            {
              "languageCode": "EN-US",
              "value": "An in-room safe is provided for guest valuables."
            }
          ]
        }
      ],
      "images": [
        {
          "mainUrl": "https://www.derbysoftdemo.com/images/room.jpg",
          "categoryCode": "ROOM",
          "sort": 1,
          "sourceId": "image001",
          "captionLangs": [
            {
              "languageCode": "EN-US",
              "value": "Deluxe King Room"
            }
          ],
          "applicableStart": "2023-01-01",
          "applicableEnd": "2023-12-31",
          "items": [
            {
              "url": "https://www.derbysoftdemo.com/images/room_large.jpg",
              "width": 1920,
              "height": 1080,
              "size": "2MB",
              "unit": "MB",
              "fileSize": 2048,
              "resolution": 300,
              "recordId": "image001_large",
              "formatCode": "JPEG"
            }
          ]
        }
      ]
    }
  ]
}

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 400)

{
    "error": {
        "code": "MissingField",
        "message": "Required request parameter 'contextCode' for method parameter type String is not present"
    }
}

Guestroom API

Introduction

Get Guestroom

API Endpoints & Methods

Headers

Query Parameters

Response Parameters

Example Response

Get Guestroom Content with {guestRoomCode}

API Endpoints & Methods

Headers

Query Parameters

Response Parameters

Example Response

POST Guestroom Content

API Endpoints & Methods

Headers

Query Parameters

Example Request

Response Parameters

Example Response

About Content Supplier API

Supplier API Documentation

Property API

Rateplan API

Appendix

Guestroom API

Introduction

Get Guestroom

API Endpoints & Methods

Headers

Query Parameters

Response Parameters

Example Response

Get Guestroom Content with {guestRoomCode}

API Endpoints & Methods

Headers

Query Parameters

Response Parameters

Example Response

POST Guestroom Content

API Endpoints & Methods

Headers

Query Parameters

Example Request

Response Parameters

Example Response

Related Articles:

About Content Supplier API

Supplier API Documentation

Property API

Rateplan API

Appendix