Skip to content

MixVel Platform 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 GetDictionary* 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.

The request type is determined by an optional FromDate attribute.

Its absence means a request for complete directory data.

Example of a Carrier Directory Request with attribute FromDate.

<MixEnv:Envelope xmlns:MixEnv="https://www.mixvel.com/API/XSD/mixvel_envelope/1_06">
    <Header/>
    <Body id="ID1">
        <MessageInfo MessageId="703423d1-595c-49f5-98c2-5dcabe950276" TimeSent="2025-01-01T00:00:00Z"/>
        <AppData>
            <GetDictionaryCarriersRQ FromDate="2025-01-01" xmlns="https://www.mixvel.com/API/XSD/mixvel_dictionaries/1_00"/>
        </AppData>
    </Body>
</MixEnv:Envelope>

List of dictionaries available to the Agent

Dictionaries without parameters

  1. Carriers dictionary (/api/get/Dictionary/carriers).

  2. Cities dictionary (/api/get/Dictionary/cities).

  3. Countries dictionary (/api/get/Dictionary/countries).

  4. Payment forms dictionary (/api/get/Dictionary/formsofpayment).

  5. Payment systems dictionary (/api/get/Dictionary/paymentsystems).

  6. Stations dictionary (/api/get/Dictionary/stations).

  7. TCH forms dictionary (/api/get/Dictionary/tchblanks).

  8. Aircraft types dictionary (/api/get/Dictionary/aircrafts)

  9. Passenger documents directory (/api/get/Dictionary/passenger-documents).

Customizable dictionaries

Exchange rates dictionary (/api/get/Dictionary/currency-rates).

In the request for the exchange rate dictionary, it is required to transfer at least the currency codes for conversion (CurrencyFrom and CurrencyTo). A description of all parameters is given below.

XPath параметра Описание
CurrencyFrom/CurCode Currency code to convert
CurrencyTo/CurCode Final currency conversion code
Amount The value to convert (optional)
CurrencyConversionSource Conversion source: IATA_IROE, IATA_ICER, Airline or Agency (optional). If not specified, all sources are searched
AirlineDesigCode Airline code. Specified only when CurrencyConversionSource= Airline

Example of GetDictionaryCurrencyRatesRQ:

Show the request example 
<MixEnv:Envelope xmlns:MixEnv="https://www.mixvel.com/API/XSD/mixvel_envelope/1_06">
    <Header/>
    <Body id="ID1">
        <MessageInfo MessageId="703423d1-595c-49f5-98c2-5dcabe950276" TimeSent="2025-04-17T19:37:48Z"/>
        <AppData>
            <m:GetDictionaryCurrencyRatesRQ xmlns:m="https://www.mixvel.com/API/XSD/mixvel_dictionaries/1_00">
                <CurrencyFrom>
                    <CurCode>USD</CurCode>
                </CurrencyFrom>
                <CurrencyTo>
                    <CurCode>RUB</CurCode>
                </CurrencyTo>
                <Amount>10</Amount>
                <CurrencyConversionSource>IATA_IROE</CurrencyConversionSource>
            </m:GetDictionaryCurrencyRatesRQ>
        </AppData>
    </Body>
</MixEnv:Envelope>