Skip to main content

Manage Rates - Company Profile Assignment

SynXis CRS
Rates
Company Profiles
REST API
CRS Administration

Beta Release - Work in progress

New API - Seeking beta customers

Enhanced by the following feature: Company Profile Rate Descriptions – Support in DWH, Bulk Data, and REST APIs.

Read more

Company Profile Rate Descriptions – Support in DWH, Bulk Data, and REST APIs (FEA103378)

The REST Manage Rates – Company Profile Assignment API has been enhanced to allow customers to create, update, retrieve, and delete company profile rate descriptions in SynXis CRS removing the need for a user to log in and complete the task manually.

The following REST endpoints have been created or enhanced to support default company profile rate descriptions:

 OperationEndpointDescription
 POST/hotels/{hotelId}/rates/{code}/companyProfilesAssigns company profiles to a hotel rate
NewPUT/hotels/{hotelId}/rates/{code}/companyProfilesEdits company profile assignments for a hotel rate
 GET/hotels/{hotelId}/rates/{code}/companyProfilesRetrieves company profile assignments for a hotel rate
 POST/brands/{brandId}/rates/{code}/companyProfilesAssigns company profiles to a brand rate
NewPUT/brands/{brandId}/rates/{code}/companyProfilesEdits company profile assignments for a brand rate
 GET/brands/{brandId}/rates/{code}/companyProfilesRetrieves company profile assignments for a brand rate
 POST/chains/{chainId}/rates/{code}/companyProfilesAssigns company profiles to a chain rate
NewPUT/chains/{chainId}/rates/{code}/companyProfilesEdits company profile assignments for a chain rate
 GET/chains/{chainId}/rates/{code}/companyProfilesRetrieves company profile assignments for a chain rate

The following attributes were added to the request/response:

ParameterData typeDescription
codeTextCompany Profile code
Required
LevelTextUsed to indicate if the profile being assigned is a Chain or Hotel level profile
Valid values are:
• Chain
• Hotel
Required
StartDateDateValid dates are from the current date to 3 years in the future
Required
EndDateDateValid dates are from the current date to 3 years in the future
Optional – if an end date is not provided, the maximum supported calendar date is used as the end date of the season
DescriptionTextSupports text values of 1-47 characters
Required

The following new endpoints were created to support seasonal company profile rate descriptions:

OperationEndpointDescription
POST/hotels/{hotelId}/rates/{code}/companyProfiles/seasonalDescriptionsCreates seasonal company rate descriptions for existing hotel level rate/hotel level company profile assignment(s) and/or existing hotel level rate/chain level company profile assignment(s)
DELETE/hotels/{hotelId}/rates/{code}/companyProfiles/seasonalDescriptionsRemoves seasonal company rate descriptions for existing hotel level rate/hotel level company profile assignment(s) and/or existing hotel level rate/chain level company profile assignment(s)
GET/hotels/{hotelId}/rates/{code}/companyProfiles/seasonalDescriptionsRetrieves seasonal company rate descriptions for existing hotel level rate/hotel level company profile assignment(s) and/or existing hotel level rate/chain level company profile assignment(s)
POST/brands/{brandId}/rates/{code}/companyProfiles/seasonalDescriptionsCreates seasonal company rate descriptions for existing brand level rate/chain level company profile assignment(s)
DELETE/brands/{brandId}/rates/{code}/companyProfiles/seasonalDescriptionsRemoves seasonal company rate descriptions for existing brand level rate/chain level company profile assignment(s)
GET/brands/{brandId}/rates/{code}/companyProfiles/seasonalDescriptionsRetrieves seasonal company rate descriptions for existing brand level rate/chain level company profile assignment(s)
POST/chains/{chainId}/rates/{code}/companyProfiles/seasonalDescriptionsCreates seasonal company rate descriptions for existing chain level rate/chain level company profile assignment(s)
DELETE/chains/{chainId}/rates/{code}/companyProfiles/seasonalDescriptionsRemoves seasonal company rate descriptions for existing chain level rate/chain level company profile assignment(s)
GET/chains/{chainId}/rates/{code}/companyProfiles/seasonalDescriptionsRetrieves seasonal company rate descriptions for existing chain level rate/chain level company profile assignment(s)

The following attributes are included the request/response:

ParameterData typeDescription
StartDateDateValid dates are from the current date to 3 years in the future
Required
EndDateDateValid dates are from the current date to 3 years in the future
Optional – if an end date is not provided, the maximum supported calendar date is used as the end date of the season
DescriptionTextSupports text values of 1-47 characters
Required
CompanyProfileCodeTextCompany Profile code
Required