Rateplan API
Modified on: 2025-06-10 16:32
TABLE OF CONTENTS
- Introduction
- Get Rateplan
- Get Rateplan Content with {ratePlanCode}
- POST Rateplan Content
- Related Articles:
Introduction
- Get Rateplan: This API retrieves a list of rate plans for a specified property from the system, providing available rate plan details.
- Get Rateplan Content with {ratePlanCode}: This API retrieves the content details of a specific rate plan using the provided {ratePlanCode}, allowing users to query a single rate plan's information within a specified property.
- POST Rateplan Content: This API performs a full update of rate plan content in the system, replacing all existing data with the new submission for a specified property.
Get Rateplan
This API retrieves a list of rate plans for a specified property from the system, providing available rate plan details.
API Endpoints & Methods
| Base URL: https://contentsolutions-supplier.derbysoftsec.com | |
|---|---|
HTTP method | URL |
GET | /api/content/rate_plans |
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 |
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 |
ratePlans | List<RatePlan> | Collection of rate plans. | |
ratePlans.code | String | Unique rate plan code. | BB-DELUXE |
ratePlans.nameLangs | List<I18N> | Multilingual rate plan names. | Deluxe Room - Bed & Breakfast. |
ratePlans.descriptionLangs | List<I18N> | Multilingual rate plan descriptions. | Deluxe room offering a king-size bed, complimentary breakfast, and free WiFi. |
ratePlans.distributors | List<string> | List of distributor codes. | ["OTA001", "OTA002"] |
Example Response
{
"data": {
"contextCode": "derbydemo",
"supplierCode": "DERBYHOTEL",
"propertyCode": "derbydemo001",
"operateStatus": "ENABLED",
"ratePlans": [
{
"code": "BB-DELUXE",
"nameLangs": [
{
"languageCode": "EN-US",
"value": "Deluxe Room - Bed & Breakfast"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Deluxe room offering a king-size bed, complimentary breakfast, and free WiFi."
}
],
"distributors": [
"OTA001",
"OTA002",
"OTA003"
]
},
{
"code": "HB-SUITE",
"nameLangs": [
{
"languageCode": "EN-US",
"value": "Suite Room - Half Board"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Suite room with a living area, breakfast and dinner included, and free WiFi."
}
],
"distributors": [
"OTA002",
"OTA003"
]
}
]
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Lack of permissions, please configure permissions."
}
}{
"error": {
"code": "MissingField",
"message": "Required request parameter 'contextCode' for method parameter type String is not present"
}
}Get Rateplan Content with {ratePlanCode}
This API retrieves the content details of a specific rate plan using the provided {ratePlanCode}, allowing users to query a single rate plan's information within a specified property.
API Endpoints & Methods
Base URL: https://contentsolutions-supplier.derbysoftsec.com | |
|---|---|
HTTP method | URL |
GET | /api/content/rate_plans/{ratePlanCode} |
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 |
|---|---|---|---|---|
ratePlanCode | String(path) | Yes | Unique rate plan code. | BB-DELUXE |
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 |
ratePlans | List<RatePlan> | Collection of rate plans. | |
ratePlans.code | String | Unique rate plan code. | BB-DELUXE |
ratePlans.nameLangs | List<I18N> | Multilingual rate plan names. | Deluxe Room - Bed & Breakfast. |
ratePlans.descriptionLangs | List<I18N> | Multilingual rate plan descriptions. | Deluxe room offering a king-size bed, complimentary breakfast, and free WiFi. |
ratePlans.distributors | List<string> | List of distributor codes. | ["OTA001", "OTA002"] |
Example Response
{
"data": {
"contextCode": "derbydemo",
"supplierCode": "DERBYHOTEL",
"propertyCode": "CCPC003",
"operateStatus": "derbydemo001",
"code": "BB-DELUXE",
"nameLangs": [
{
"languageCode": "EN-US",
"value": "Deluxe Room - Bed & Breakfast"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Deluxe room offering a king-size bed, complimentary breakfast, and free WiFi."
}
],
"distributors": [
"OTA001",
"OTA002",
"OTA003"
]
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Lack of permissions, please configure permissions."
}
}{
"error": {
"code": "MissingField",
"message": "Required request parameter 'contextCode' for method parameter type String is not present"
}POST Rateplan Content
This API performs a full update of rate plan 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/rate_plans/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 | Type | Required | Description | Example |
|---|---|---|---|---|
contextCode | String | Yes | Context Code in DerbySoft's system. | DERBYDEMO |
propertyCode | String | 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 |
ratePlans | List<RatePlan> | Yes | Collection of rate plans. | |
ratePlans.code | String | Yes | Unique rate plan code. | BB-DELUXE |
ratePlans.nameLangs | List<I18N> | No | Multilingual rate plan names. | Deluxe Room - Bed & Breakfast. |
ratePlans.descriptionLangs | List<I18N> | No | Multilingual rate plan descriptions. | Deluxe room offering a king-size bed, complimentary breakfast, and free WiFi. |
ratePlans.distributors | List<string> | No | List of distributor codes. | ["OTA001", "OTA002"] |
Example Request
{
"contextCode": "derbydemo",
"propertyCode": "derbydemo001",
"ratePlans": [
{
"code": "BB-DELUXE",
"nameLangs": [
{
"languageCode": "EN-US",
"value": "Deluxe Room - Bed & Breakfast"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Deluxe room offering a king-size bed, complimentary breakfast, and free WiFi."
}
],
"distributors": [
"OTA001",
"OTA002",
"OTA003"
]
},
{
"code": "HB-SUITE",
"nameLangs": [
{
"languageCode": "EN-US",
"value": "Suite Room - Half Board"
}
],
"descriptionLangs": [
{
"languageCode": "EN-US",
"value": "Suite room with a living area, breakfast and dinner included, and free WiFi."
}
],
"distributors": [
"OTA002",
"OTA003"
]
}
]
}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
{
"data": {
"contextCode": "derbydemo",
"supplierCode": "DERBYHOTEL",
"propertyCode": "derbydemo001",
"operateStatus": "ENABLED"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Lack of permissions, please configure permissions."
}
}{
"error": {
"code": "MissingField",
"message": "Required request parameter 'contextCode' for method parameter type String is not present"
}
}Related Articles:
Did you find it helpful? Yes No
Send feedback