> ## 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. # Get the session scope > Get the session scope ## OpenAPI ````yaml booking-engine-api/open-api/booking-engine-api.json GET /v2/{sessionId}/session/scope 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}/session/scope: get: tags: - Session summary: Get the session scope description: "Provides the boundaries of the session usage:\r\n* `hotelIds`, `roomIds`, and `rateIds` list the ids that can be used with the session. The values come from the engine configuration.\r\n* `ActivePromoCode` details the configuration of the promo code set up in the property `session.context.promoCode`.\r\n* `selectedRateIds` list all ids matching the property `session.context.selectedRateCode`\r\n* `selectedroomIds` list all ids matching the property `session.context.selectedRoomCode`\r\n* `highlightedRateIds` list all ids matching the property `session.context.highlightedRateCode`" operationId: Session_GetScope parameters: - name: X-AVP-Impersonation in: header description: '' required: false schema: type: string - name: sessionId in: path required: true schema: type: string responses: '200': description: Returns the user session scope content: application/json: schema: $ref: '#/components/schemas/Session.HubSessionScope' examples: response: value: hotelIds: - '10133' roomIds: - 1234 rateIds: - 1234 extraIds: [] activePromoCode: type: DiscountCode code: DISCOUNT rateIds: - 1234 selectedRateIds: - 1234 selectedRoomIds: - 1234 highlightedRateIds: - 1234 highlightedRoomIds: - 1234 highlightedHotelIds: [] defaultDisplayType: Room roomDisplayTypes: {} mealPlanIds: [] text/json: schema: $ref: '#/components/schemas/Session.HubSessionScope' examples: response: value: hotelIds: - '10133' roomIds: - 1234 rateIds: - 1234 extraIds: [] activePromoCode: type: DiscountCode code: DISCOUNT rateIds: - 1234 selectedRateIds: - 1234 selectedRoomIds: - 1234 highlightedRateIds: - 1234 highlightedRoomIds: - 1234 highlightedHotelIds: [] defaultDisplayType: Room roomDisplayTypes: {} mealPlanIds: [] '400': description: The session is invalid or does not exist 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: Session.HubSessionScope: description: >- The scope of the session. It defines which engine, hotels, rooms and rates the session is allowed to use. required: - hotelIds - roomIds - rateIds - extraIds - activePromoCode - selectedRateIds - selectedRoomIds - highlightedRateIds - highlightedRoomIds - highlightedHotelIds - roomDisplayTypes - mealPlanIds - defaultDisplayType type: object properties: hotelIds: description: Hotel ids of the current scope. default: [] type: array items: $ref: '#/components/schemas/Common.HubHotelId' roomIds: description: Room ids of the current scope. default: [] type: array items: $ref: '#/components/schemas/HotelBusiness.RoomId' rateIds: description: Rate ids of the current scope. default: [] type: array items: $ref: '#/components/schemas/HotelBusiness.RateId' extraIds: description: Extra ids of the current scope. default: [] type: array items: $ref: '#/components/schemas/HotelBusiness.ExtraId' activePromoCode: description: >- This property is filled with the details of the promocode if the one configured in the context is a valid one. default: type: None rateIds: [] allOf: - $ref: '#/components/schemas/Session.HubSessionPromoCode' selectedRateIds: default: [] type: array items: $ref: '#/components/schemas/HotelBusiness.RateId' selectedRoomIds: default: [] type: array items: $ref: '#/components/schemas/HotelBusiness.RoomId' highlightedRateIds: default: [] type: array items: $ref: '#/components/schemas/HotelBusiness.RateId' highlightedRoomIds: default: [] type: array items: $ref: '#/components/schemas/HotelBusiness.RoomId' highlightedHotelIds: default: [] type: array items: $ref: '#/components/schemas/Common.HubHotelId' defaultDisplayType: $ref: '#/components/schemas/Search.Room.HubSearchRoomDisplayType' roomDisplayTypes: default: {} type: object additionalProperties: $ref: '#/components/schemas/Search.Room.HubSearchRoomDisplayType' mealPlanIds: description: MealPlan ids of the current scope. default: [] type: array items: $ref: '#/components/schemas/HotelBusiness.ExtraId' 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 Common.HubHotelId: type: string HotelBusiness.RoomId: format: int32 type: integer HotelBusiness.RateId: format: int32 type: integer HotelBusiness.ExtraId: format: int32 type: integer Session.HubSessionPromoCode: required: - rateIds - type type: object properties: type: $ref: '#/components/schemas/Session.HubOfferCodeType' code: type: string rateIds: default: [] type: array items: $ref: '#/components/schemas/HotelBusiness.RateId' Search.Room.HubSearchRoomDisplayType: description: Whether search results are displayed as a room or an accommodation. enum: - Room - Accommodation type: string 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 Session.HubOfferCodeType: description: >- Category of code entered by the end user to unlock a specific rate or discount. - **None** — No code applies. - **RateCode** — Code that unlocks a specific rate (typically a corporate or private rate). - **OfferCode** — Code that unlocks a private offer. - **DiscountCode** — Code that applies a discount to the booking. enum: - None - RateCode - OfferCode - DiscountCode type: string ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.