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 LoginPassword 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).

...

LoginPassword. 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 LoginPasswordConvertNotesToText (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 SupplierDataelements for the specified supplier(s).

...

LoginPassword. 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).

...

Data itemTypeDescription
OptionCodeString &nbsp (17)Seventeen character full option code for the new option (it is an error if an option with this code already exists). Characters 1 to 3 must be a location code setup in Tourplan, characters 4 and 5 must be a service code setup in Tourplan and characters 6 to 11 must be a supplier code setup in Tourplan. Required.
Opt_IDIntegerInternal Tourplan option identifier (ignored for AddOption; used in ChangeOption and GetOption).
AcString (1)Option type. Possible values are A (Apartment), F (Flight), I (Itinerary), N (Non-Accommodation), P (Package), Y (Accommodation). At present this field cannot be specified in the AddOption and ChangeOption requests; it is returned by the GetOption request.
DeletedBooleanSpecifies whether the option is marked as deleted or not. Optional.
DescriptionString (60)Option description. Optional.
CommentString (60)Option comment. Optional.
LocalityString &nbsp (3)Code for a locality that has been setup in Tourplan. Optional.
ClassString &nbsp (3)Code for a class that has been setup in Tourplan. Optional.
Durationhhhh.mmDuration in hours (0 to 9999) dot minutes (0 to 59). The value specified must contain a dot and values for hours and minutes. Optional.
Analysis1 to Analysis6String (2)Option analysis codes. Each must be a valid code for that particular database analysis code. Optional.
Message_codeString (2)A message format code that has been setup in Tourplan. Optional.
Invoice_text1String (60)Invoice text line 1. Optional.
Invoice_text2String (60)Invoice text line 2. Optional.

...

Data itemTypeDescription
FCUString (6)First charge unit. Common values are person (where charges are per person), room (where charges are per room), vehicle and so on. Optional.
SCUString (6)Second charge unit. What the charge is for. Common values include night (for accommodation services), day (car rental), tour (for a packaged tour), meal (for meals). Optional.
MPFCUInteger (1..999)Maximum pax per first charge unit. Where the first charge unit is some sort of group unit (such as vehicle), then MPFCU specifies the number of pax that can fit in one first charge unit. Ignored (and set to 1) for the Accommodation and Package service categories, and if the first charge unit is person. For the Apartment service category the maximum value is 11. Optional.
PeriodsInteger (0..)Number of 24 hour periods per second charge unit. When producing a voucher this field is used to control production of the out date. If periods is 0, then no out date is produced. Otherwise, periods multiplied by the numberof number of second charge units gives the out date. Basically this field gives the duration of one second charge unit in days. Set to 1 if the SCU supplied is day or night, and to 0 if the SCU supplied is blank. Optional.
Periods_BaseString (1)Basis of the second charge unit. Possible values are D (per calendar day) and P (per 24 hour period). Optional.
Pxb1 to
Pxb24
IntegerSome non-accommodation and package options have rates that depend on the number of pax in the booking. In this case these Pxb values specifiy specify the different pax ranges. The first range is for 1 to Pxb1 pax, the second for Pxb1 + 1 to Pxb2 pax, and so on. The final range has a Pxb value of 9999, and this value must appear in the input. Optional.
Child_In_PxbBooleanAre children counted when determining which pax break applies? Optional.
Infant_In_PxbBooleanAre infants counted when determining which pax break applies? Optional.
Ex1 to Ex5String (20)Each option can have up to 5 optional extras defined for it. These five fields give descriptions for these extras (if a description is blank then that particular extra does not exist for this service option). Optional.
ChgEx1 to ChgEx5String (1)Charge basis for extras 1 to 5 (in each case, is only relevant if the matching extra exists). Each must be one of the values F (FCU/SCU), G (Group), P (Person), R (Room), S (SCU). Optional.
Ex1Description to Ex5DescriptionString (60)Extended descriptions for extras 1 to 5. Optional.
Int_Hide_Ex1 to Int_Hide_Ex5BooleanFor each extra, is it displayed in iCom? Optional.

...

Retrieves details of a Tourplan option. Inputs are LoginPasswordConvertNotesToText (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.

...

Output data items are one or more of the Allocation elements accepted by SetInventory. The allocations returned are those that meet the filter conditions specified by the input paramtersparameters.

Input data items

Inputs are LoginPassword plus the fields listed below.

...