> ## Documentation Index > Fetch the complete documentation index at: https://docs.d-edge.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > This site documents the D-EDGE APIs for technology partners (web agencies, OTAs, PMS and RMS vendors, booking and CRM tools). It is written for developers integrating with hotels that use the D-EDGE platform. > Seven APIs, grouped by domain. Connectivity: Channel Manager API (distribute a hotel's inventory to your channel and send bookings back). Pricing & Availability: Best Price API (best offers to highlight), Quotation API (all bookable offers for a stay), Daily Rates API (daily availability between two dates). Booking: Booking Engine API (a hotel's full direct booking funnel), Gift Shop API (gift vouchers from catalogue to payment). Guest Management: CRM API (guest profiles). > Pick the API by the need: to display prices, use the Best Price API or the Daily Rates API; to quote a specific stay, use the Quotation API; to book, use the Booking Engine API; to sell gift vouchers, use the Gift Shop API; to manage guest profiles, use the CRM API; to receive hotel inventory and send bookings back as a distribution channel, use the Channel Manager API. > Base URLs, hotel identifiers, and credentials are delivered by the D-EDGE partnership team during onboarding. Do not invent base URLs, endpoints, parameters, or example credentials that do not appear on these pages. > Authentication differs per API: OAuth 1.0 for Best Price, Quotation, Daily Rates, and Booking Engine; an X-API-KEY header for Gift Shop; OAuth 2.0 client credentials for CRM; partner-defined credentials carried in the XML message for the Channel Manager API. Read each API's Authentication page before writing code. > A mock environment returns realistic but fictitious data without credentials. The Postman and Insomnia collections on the API collections page target it by default. Use it for exploration and tests, never for production traffic. > Use the official names exactly: D-EDGE, D-EDGE platform, Channel Manager API, partnership team. Do not use Back Office or Extranet. > Each API has a Changelog page. Check it for the current behaviour before relying on an older answer. For questions these pages do not answer, direct the reader to the Contact us page. # Gets the room description > Gets the room description ## OpenAPI ````yaml booking-engine-api/open-api/booking-engine-api.json GET /v2/{sessionId}/description/rooms/{roomId} openapi: 3.0.1 info: title: Booking Engine API version: v2 servers: - url: https://{apiBaseUrl} variables: apiBaseUrl: default: api.example.com description: Base URL delivered by D-EDGE during partnership setup security: [] tags: - name: Basket - name: Booking - name: Configuration - name: Description - name: Loyalty - name: Promotion - name: Resources - name: Search - name: Session paths: /v2/{sessionId}/description/rooms/{roomId}: get: tags: - Description summary: Gets the room description. description: "The room requested must be one of the rooms in the session scope.\r\n \r\nThe **X-AVP-Properties** header attribute can contain some or all the following values, separated with | character:\r\n* `Information`\r\n* `Booking`\r\n* `Services`\r\n* `Rates`\r\n* `Extras`\r\n* `Occupancies`\r\n \r\nThe **X-AVP-DescriptionType** header attribute can contain one of the following values:\r\n* `text/html` (default)\r\n* `text/plain`\r\n* `text/x-markdown`\r\n \r\nThe **X-AVP-PictureTemplates** should contains the list of picture templates requested, separated with | character." operationId: Description_GetRoom parameters: - name: roomId in: path description: The room identifier. required: true schema: type: string - name: X-AVP-Properties in: header description: The properties. required: false schema: type: string - name: X-AVP-DescriptionType in: header description: Type of the description. required: false schema: type: string - name: X-AVP-PictureTemplates in: header description: The picture templates. required: false schema: type: string - name: X-AVP-Impersonation in: header description: '' required: false schema: type: string - name: sessionId in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Description.Room.HubRoomDescription' examples: response: value: roomId: 12345 hotelId: '10133' name: Nom de la chambre information: totalCount: 2 code: ROOMTRIPLE type: text: Chambre triple value: Triple category: text: Chambre confort value: Comfort qualifier: text: Vue sur jardin value: GardenSight surfaceArea: text: 12m2 value: 12 bedding: beds: - type: text: Lit double value: Double size: text: Grande chambre value: type: Size200By200Cm width: 200 length: 200 count: 2 twoPersonConvertible: false singleBedCount: 1 doubleBedCount: 2 sofaCount: 0 beddingConfigurations: [] summary: - text: Summary de la chambre value: PlainText pictures: - templates: - name: TEMPLATE1 url: http://url/to/template1/image1 - name: TEMPLATE2 url: http://url/to/template2/image1 sortOrder: 1 - templates: - name: TEMPLATE1 url: http://url/to/template1/image2 - name: TEMPLATE2 url: http://url/to/template2/image2 sortOrder: 2 displayedPersonCount: 3 sortOrder: 1 services: - category: text: General value: General amenities: - text: Balcon value: Balcony - text: Air conditionné value: AirConditioning occupancies: - occupancyId: 0 isDefault: true definition: text: 2 personnes value: isDetailed: false personCount: 2 adultCount: 0 childCount: 0 infantCount: 0 extraIds: - 1111 - 2222 - 3333 rateIds: - 1111 - 2222 - 3333 text/json: schema: $ref: '#/components/schemas/Description.Room.HubRoomDescription' examples: response: value: roomId: 12345 hotelId: '10133' name: Nom de la chambre information: totalCount: 2 code: ROOMTRIPLE type: text: Chambre triple value: Triple category: text: Chambre confort value: Comfort qualifier: text: Vue sur jardin value: GardenSight surfaceArea: text: 12m2 value: 12 bedding: beds: - type: text: Lit double value: Double size: text: Grande chambre value: type: Size200By200Cm width: 200 length: 200 count: 2 twoPersonConvertible: false singleBedCount: 1 doubleBedCount: 2 sofaCount: 0 beddingConfigurations: [] summary: - text: Summary de la chambre value: PlainText pictures: - templates: - name: TEMPLATE1 url: http://url/to/template1/image1 - name: TEMPLATE2 url: http://url/to/template2/image1 sortOrder: 1 - templates: - name: TEMPLATE1 url: http://url/to/template1/image2 - name: TEMPLATE2 url: http://url/to/template2/image2 sortOrder: 2 displayedPersonCount: 3 sortOrder: 1 services: - category: text: General value: General amenities: - text: Balcon value: Balcony - text: Air conditionné value: AirConditioning occupancies: - occupancyId: 0 isDefault: true definition: text: 2 personnes value: isDetailed: false personCount: 2 adultCount: 0 childCount: 0 infantCount: 0 extraIds: - 1111 - 2222 - 3333 rateIds: - 1111 - 2222 - 3333 '400': description: The session code is invalid content: application/json: schema: $ref: >- #/components/schemas/BookingEngine.Hub.Service.Examples.Session.InvalidSessionErrorResponse examples: response: value: code: InvalidSessionId text/json: schema: $ref: >- #/components/schemas/BookingEngine.Hub.Service.Examples.Session.InvalidSessionErrorResponse examples: response: value: code: InvalidSessionId '401': description: >- Authentication header is invalid or does not give access to the operation content: application/json: schema: $ref: >- #/components/schemas/BookingEngine.Hub.Service.Controllers.ErrorResponse_BookingEngine.Hub.Service.Config.SecurityErrorType_ text/json: schema: $ref: >- #/components/schemas/BookingEngine.Hub.Service.Controllers.ErrorResponse_BookingEngine.Hub.Service.Config.SecurityErrorType_ components: schemas: Description.Room.HubRoomDescription: required: - information - services - occupancies - extraIds - rateIds - roomId - hotelId type: object properties: roomId: $ref: '#/components/schemas/HotelBusiness.RoomId' hotelId: $ref: '#/components/schemas/Common.HubHotelId' name: type: string information: default: totalCount: 0 type: value: None category: value: None qualifier: value: None surfaceArea: value: 0 bedding: beds: [] singleBedCount: 0 doubleBedCount: 0 sofaCount: 0 beddingConfigurations: [] summary: [] pictures: [] displayedPersonCount: 0 sortOrder: 0 allOf: - $ref: '#/components/schemas/Description.Room.HubRoomInformation' services: default: [] type: array items: $ref: '#/components/schemas/Description.Room.HubRoomService' occupancies: default: [] type: array items: $ref: '#/components/schemas/Description.Room.HubRoomOccupancy' extraIds: default: [] type: array items: $ref: '#/components/schemas/HotelBusiness.ExtraId' rateIds: default: [] type: array items: $ref: '#/components/schemas/HotelBusiness.RateId' BookingEngine.Hub.Service.Examples.Session.InvalidSessionErrorResponse: required: - code type: object properties: code: default: InvalidSessionId type: string message: type: string BookingEngine.Hub.Service.Controllers.ErrorResponse_BookingEngine.Hub.Service.Config.SecurityErrorType_: allOf: - $ref: >- #/components/schemas/BookingEngine.Hub.Service.Controllers.ErrorResponse - required: - code type: object properties: code: $ref: >- #/components/schemas/BookingEngine.Hub.Service.Config.SecurityErrorType HotelBusiness.RoomId: format: int32 type: integer Common.HubHotelId: type: string Description.Room.HubRoomInformation: required: - type - category - qualifier - surfaceArea - bedding - beddingConfigurations - summary - pictures - totalCount - displayedPersonCount - sortOrder type: object properties: totalCount: format: int32 type: integer code: type: string type: default: value: None allOf: - $ref: >- #/components/schemas/Common.HubValueText_HotelBusiness.Configuration.RoomType_ category: default: value: None allOf: - $ref: >- #/components/schemas/Common.HubValueText_HotelBusiness.Configuration.RoomCategory_ qualifier: default: value: None allOf: - $ref: >- #/components/schemas/Common.HubValueText_HotelBusiness.Configuration.RoomQualifier_ surfaceArea: default: value: 0 allOf: - $ref: '#/components/schemas/Common.HubValueText_System.Decimal_' bedding: default: beds: [] singleBedCount: 0 doubleBedCount: 0 sofaCount: 0 allOf: - $ref: '#/components/schemas/Description.Room.HubRoomBedding' beddingConfigurations: default: [] type: array items: $ref: '#/components/schemas/Description.Room.HubBeddingConfiguration' summary: default: [] type: array items: $ref: >- #/components/schemas/Common.HubValueText_Common.HubDescriptionType_ pictures: default: [] type: array items: $ref: '#/components/schemas/Common.HubPicture' displayedPersonCount: format: int32 type: integer sortOrder: format: int32 type: integer Description.Room.HubRoomService: type: object properties: category: $ref: >- #/components/schemas/Common.HubValueText_Description.Room.HubRoomAmenityCategory_ amenities: type: array items: $ref: '#/components/schemas/Common.HubValueText_Common.HubRoomAmenityId_' Description.Room.HubRoomOccupancy: required: - definition - occupancyId - isDefault type: object properties: occupancyId: $ref: '#/components/schemas/HotelBusiness.OccupancyId' isDefault: type: boolean definition: default: {} allOf: - $ref: >- #/components/schemas/Common.HubValueText_Description.Common.HubOccupancyDefinition_ HotelBusiness.ExtraId: format: int32 type: integer HotelBusiness.RateId: format: int32 type: integer BookingEngine.Hub.Service.Controllers.ErrorResponse: type: object properties: message: type: string BookingEngine.Hub.Service.Config.SecurityErrorType: description: >- Category of security failure returned when authentication or authorization is rejected. enum: - InvalidUserAuthentication - InvalidUserRoles - InvalidPermissions type: string Common.HubValueText_HotelBusiness.Configuration.RoomType_: allOf: - $ref: '#/components/schemas/Common.HubValueText' - required: - value type: object properties: value: $ref: '#/components/schemas/HotelBusiness.Configuration.RoomType' Common.HubValueText_HotelBusiness.Configuration.RoomCategory_: allOf: - $ref: '#/components/schemas/Common.HubValueText' - required: - value type: object properties: value: $ref: '#/components/schemas/HotelBusiness.Configuration.RoomCategory' Common.HubValueText_HotelBusiness.Configuration.RoomQualifier_: allOf: - $ref: '#/components/schemas/Common.HubValueText' - required: - value type: object properties: value: $ref: '#/components/schemas/HotelBusiness.Configuration.RoomQualifier' Common.HubValueText_System.Decimal_: allOf: - $ref: '#/components/schemas/Common.HubValueText' - required: - value type: object properties: value: format: decimal type: number Description.Room.HubRoomBedding: required: - beds - singleBedCount - doubleBedCount - sofaCount type: object properties: beds: default: [] type: array items: $ref: '#/components/schemas/Description.Room.HubRoomBed' singleBedCount: format: int32 type: integer doubleBedCount: format: int32 type: integer sofaCount: format: int32 type: integer Description.Room.HubBeddingConfiguration: required: - configurationId type: object properties: configurationId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 description: type: string Common.HubValueText_Common.HubDescriptionType_: allOf: - $ref: '#/components/schemas/Common.HubValueText' - required: - value type: object properties: value: $ref: '#/components/schemas/Common.HubDescriptionType' Common.HubPicture: required: - templates - sortOrder type: object properties: templates: default: [] type: array items: $ref: '#/components/schemas/Common.HubPictureTemplate' sortOrder: format: int32 type: integer Common.HubValueText_Description.Room.HubRoomAmenityCategory_: allOf: - $ref: '#/components/schemas/Common.HubValueText' - required: - value type: object properties: value: $ref: '#/components/schemas/Description.Room.HubRoomAmenityCategory' Common.HubValueText_Common.HubRoomAmenityId_: allOf: - $ref: '#/components/schemas/Common.HubValueText' - required: - value type: object properties: value: $ref: '#/components/schemas/Common.HubRoomAmenityId' HotelBusiness.OccupancyId: format: int32 type: integer Common.HubValueText_Description.Common.HubOccupancyDefinition_: allOf: - $ref: '#/components/schemas/Common.HubValueText' - type: object properties: value: $ref: '#/components/schemas/Description.Common.HubOccupancyDefinition' Common.HubValueText: type: object properties: text: type: string HotelBusiness.Configuration.RoomType: enum: - None - Single - Double - Twin - Triple - Quadruple - FamilyRoom - JuniorSuite - Suite - Apartment - Studio - Villa - Other type: string HotelBusiness.Configuration.RoomCategory: enum: - None - Small - Standard - Classical - Superior - Club - Deluxe - Princely - Majestic - Presidential - Imperial - Tradition - Prestige - Romantic - Comfort - Other type: string HotelBusiness.Configuration.RoomQualifier: enum: - None - WithBath - WithShower - Sight - SeaSight - OceanSight - GardenSight - SwimmingPoolSight - KingSizeBed - Jacuzzi - WithSundeck - WithBalcony - WithShowerAndBath - WithShowerOrBath - WithGarden - WithSundeckAndGarden type: string Description.Room.HubRoomBed: required: - count - twoPersonConvertible type: object properties: type: $ref: >- #/components/schemas/Common.HubValueText_Description.Room.HubBedType_ size: $ref: >- #/components/schemas/Common.HubValueText_Description.Room.HubRoomBedSize_ count: format: int32 type: integer twoPersonConvertible: type: boolean Common.HubDescriptionType: description: Markup format used for rich-text description fields returned by the API. enum: - Html - Markdown - PlainText type: string Common.HubPictureTemplate: type: object properties: name: type: string url: type: string Description.Room.HubRoomAmenityCategory: description: Top-level category used to group room amenities in the description. enum: - General - Bathroom - Appliances type: string Common.HubRoomAmenityId: description: >- In-room amenity offered by a hotel room. Values are grouped in ranges by category (general, bathroom, appliances). enum: - NonSmoking - AirConditioning - MiniBar - Soundproof - SafeBox - IroningBoard - DisabledPersonAmenities - Terrace - Balcony - Loggia - Phone - Bathroom - HairDryer - Shower - Bathtub - Bidet - Television - FlatScreenTelevision - ThemedTelevisionChannels - DvdPlayer - InternetAccess - WirelessInternetAccess - Radio - AlarmClock - Computer - Printer - Fax type: string Description.Common.HubOccupancyDefinition: required: - isDetailed - personCount - adultCount - childCount - infantCount type: object properties: isDetailed: type: boolean personCount: format: int32 type: integer adultCount: format: int32 type: integer childCount: format: int32 type: integer infantCount: format: int32 type: integer childrenAges: type: array items: format: int32 type: integer Common.HubValueText_Description.Room.HubBedType_: allOf: - $ref: '#/components/schemas/Common.HubValueText' - required: - value type: object properties: value: $ref: '#/components/schemas/Description.Room.HubBedType' Common.HubValueText_Description.Room.HubRoomBedSize_: allOf: - $ref: '#/components/schemas/Common.HubValueText' - type: object properties: value: $ref: '#/components/schemas/Description.Room.HubRoomBedSize' Description.Room.HubBedType: description: Bed configuration offered by a room, ordered from smallest to largest. enum: - SingleSofa - Single - SmallDouble - DoubleSofa - Double - QueenSize - KingSize - SuperKingSize - SingleKingSize type: string Description.Room.HubRoomBedSize: required: - type - width - length type: object properties: type: $ref: '#/components/schemas/Description.Room.HubBedSizeType' width: format: int32 type: integer length: format: int32 type: integer Description.Room.HubBedSizeType: description: >- Standardised bed dimensions in centimetres. Each value encodes the bed's width and length; use Custom when the dimensions do not match any preset. enum: - Custom - Size80By190Cm - Size90By190Cm - Size90By200Cm - Size91By188Cm - Size91By191Cm - Size99By191Cm - Size100By190Cm - Size100By200Cm - Size120By190Cm - Size120By200Cm - Size135By200Cm - Size137By188Cm - Size137By191Cm - Size140By190Cm - Size140By195Cm - Size140By200Cm - Size150By200Cm - Size152By198Cm - Size153By203Cm - Size154By195Cm - Size160By190Cm - Size160By200Cm - Size167By203Cm - Size170By190Cm - Size170By195Cm - Size180By190Cm - Size180By200Cm - Size183By198Cm - Size183By203Cm - Size183By213Cm - Size194By195Cm - Size194By203Cm - Size194By205Cm - Size200By200Cm - Size203By203Cm type: string ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.