Access Keys:
Skip to content (Access Key - 0)

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Retrieves details of a Tourplan agent. Inputs are User, Password and AgentCode (the code of the agent whose details are required). Multiple agent codes can be given. Also, an agent code can be a pattern.

Output data items are AgentData elements for the specified agent(s).

...

User, Password. The remaining fields are discussed in groups: general supplier information, rate policy, amenities, notes, contacts, FYIs, and replicated locations. The note records must be of categories with category type CR or DS.

...

Retrieves details of a Tourplan supplier. Inputs are User, Password, ConvertNotesToText (an option boolean, default true, that specifies whether notes should be converted to plan text or left as RTF) and SupplierCode (the code of the supplier whose details are required). Multiple supplier codes can be given. Also, a supplier code can be a pattern.

Output data items are SupplierData elements for the specified supplier(s).

...

User, Password. Apart from DefaultOption, the other input data items can be split into groups, based on XML elements. Each of general data, cost data, voucher data and internet data is a simple list of data items. Enquiry notes contains zero or more enquiry notes of category type DB. See the contact info section in AddAgent for details on how contact information is formatted. Amenities are represented in the same way as for suppliers. Note that only option-level amenities are returned by GetOption (supplier-level amenities are returned by GetSupplier ).

...

Retrieves details of a Tourplan option. Inputs are User, Password, ConvertNotesToText (an option boolean, default true, that specifies whether notes should be converted to plan text or left as RTF) and OptionCode (the 17 character option code of the option whose details are required) or Opt_ID. Multiple option codes and/or option ids can be given. Also, each option code can be a pattern.

Output is one or more the OptionData elements.

...

Data itemTypeDescription
OptionCodeString (17)The option this set of rates belongs to. OptionCode or Opt_ID must be specified to identify the option.
Opt_IDIntegerInternal Tourplan option identifier. OptionCode or Opt_ID must be specified to identify the option.
Price_CodeString (2)The price code this set of rates belongs to (must be setup in Tourplan). Required.
Date_FromDateThe starting date of the rate period. Required.
Date_ToDateThe closing date of the rate period (must be no earlier than Date_From). Required.
Sale_FromDateThe starting date of the sale period. Required.
Sale_ToDateThe closing date of the sale period (must be no earlier than Sale_From). Required.
SellBeforeTravelIntegerThe number of days or months before travel that a booking must be made. Optional; defaults to 0 (which means no sell before threshold is set).
SellBeforeTypeString (1)The units of SellBeforeTravel. Must be D (for days) or M (for months). Optional; defaults to D.
Buy_CurrencyString (3)Currency the Cost rates are in (must be setup in Tourplan). Required.
Sell_CurrencyString (3)Currency the GroupSell and FITSell rates are in (must be setup in Tourplan). Required.
Exchange_Div_Rate,Exchange_Mut_RateDecimalExchange rate for converting from cost to sell (by dividing or multiplying by the specified rate; only one of the two can be supplied). Note the the exchange rate makes no difference to the rates saved; the exchange rate is simply saved and can be used later within Tourplan to adjust sell rates by adjusting the exchange rate. Optional (only permitted if the buy and sell currencies are different). Values must be greater than 0 and less than 10000.
ChargeExtra1 to ChargeExtra5BooleanIs extra 1 to 5 charged for on a day that is free of charge because of a stay / pay deal? A value for an extra that is not setup for the option is ignored. Optional (default false).
TaxString (3)Tourplan tax codes can be associated with this set of rates by having Tax elements within TaxInfo elements within a Taxes element. Required (the Taxes element is optional, but each TaxInfo supplier must contain a Tax element).
TaxMainOption, TaxSs, TaxTw, TaxTr, TaxQr, 
TaxEx1
, TaxEx2, TaxEx3, TaxEx4, TaxEx5
BooleanPer-component tax flags. Each is optional, and if not specified defaults to true.

...