Skip to content

MixVel Hotels Dictionaries

General terms

The agent uses the Mixvel codifiers and dictionaries namespace to interact with Mixvel services.

To maintain correct interaction with Mixvel, the agent downloads codifiers and dictionaries and updates them at some time intervals determined by the rules for interaction with Mixvel web services.

A separate external API is not allocated for the delivery of dictionaries to an agent - the corresponding methods are added to the general API.

Methods description are described in the XSD scheme Mixvel_Dictionaries_1_00.xsd

Requests are sent from the external API to the Mixvel Dictionaries Management Subsystem.

Authorization is required when activating methods for obtaining directories.

Dictionaries data obtaining methods

All the DictionaryHotel* methods allow to obtain:

  • full up-to-date dictionary data at the time of the request;

  • modified dictionary objects after a specific date in the status as per the time of the request.

Example request for the Hotel Countries Dictionary:

<MixEnv:Envelope xmlns:MixEnv="https://www.mixvel.com/API/XSD/mixvel_envelope/1_06">
    <Header/>
    <Body>
        <MessageInfo MessageId="703423d1-595c-49f5-98c2-5dcabe950276" ReplyTo="79b67a26-6fc3-41e3-8ac4-14e0ac0245c8" TimeSent="2025-10-10T13:37:48Z"/>
        <AppData>
            <a:GetDictionaryHotelCountriesRQ xmlns:a="https://www.mixvel.com/API/XSD/mixvel_dictionaries/1_00"/>
        </AppData>
    </Body>
</MixEnv:Envelope>

Hotel Dictionaries Available to the Agent

  1. Hotels Dictionary (/api/get/Dictionary/Hotels).

  2. Hotel Countries Dictionary (/api/get/Dictionary/Hotel/Countries).

  3. Hotel Cities Dictionary (/api/get/Dictionary/Hotel/Cities).

Configurable Dictionary Parameters

The Hotels Dictionary (/api/get/Dictionary/Hotels) and the Hotel Cities Dictionary (/api/get/Dictionary/Hotel/Cities) support configurable but optional parameters.

For example, the optional FromDate attribute is used to retrieve only the dictionary changes starting from the specified date. If this attribute is not provided, the full set of dictionary data is returned.

The table below describes all available parameters:

Parameter XPath Description
IsActive Indicator of an active record.
FromDate Used to retrieve only dictionary changes starting from the specified date. If not specified, the full dictionary dataset is returned.
CountryID Identifier of the country to which the city belongs.
CityID Identifier of the city to which the hotel belongs. Used only for the Dictionary/Hotels dictionary.

Example GetDictionaryHotelsRQ request:

Show request example 
<MixEnv:Envelope xmlns:MixEnv="https://www.mixvel.com/API/XSD/mixvel_envelope/1_06">
    <Header/>
    <Body>
        <MessageInfo MessageId="703423d1-595c-49f5-98c2-5dcabe950276" ReplyTo="79b67a26-6fc3-41e3-8ac4-14e0ac0245c8" TimeSent="2025-10-10T13:37:48Z"/>
        <AppData>
            <a:GetDictionaryHotelsRQ xmlns:a="https://www.mixvel.com/API/XSD/mixvel_dictionaries/1_00">
                <IsActive>true</IsActive>
                <FromDate>2025-10-10</FromDate>
                <CityID>070f89a1-8a7b-4013-af9a-5de019806427</CityID>
                <CountryID>070f89a1-8a7b-4013-af9a-5de019806427</CountryID>
            </a:GetDictionaryHotelsRQ>
        </AppData>
    </Body>
</MixEnv:Envelope>