Property | Type | Description | |
---|---|---|---|
_baseUrl | string | ||
_marketplaceId | int | ||
_privateKey | string |
Method | Description | |
---|---|---|
ApiRateLimitStatus ( ) : |
Check how many requests are left before throttling, handy for checking API connectivity
|
|
ApiRateLimitStatus ( int channelId ) : |
Check how many requests are left before throttling, handy for checking API connectivity
|
|
ChannelPerformance ( ) : XmlDocument |
Get the statistics on the top 50 performing Channels (Suppliers)
|
|
ChannelPerformance ( int channel ) : XmlDocument |
Show details on a specific Channel (Supplier)
|
|
CheckCustomerLogin ( string username, string password, int channelId ) : XmlDocument |
Validate a Customer Username and Password, retrieve their Name and User ID
|
|
CheckTourAvailability ( string queryString, int tourId, int channelId ) : XmlDocument |
Check Tour/Hotel availability for a specific number of people on specific rates on a specific date, generally used when making a booking
|
|
CommitNewBooking ( XmlDocument bookingData, int channelId ) : XmlDocument |
Convert a temporary booking to a confirmed booking
|
|
CreateCustomer ( XmlDocument customerData, int channelId ) : XmlDocument |
Create a new customer record, optionally include some enquiry data
|
|
CreateDeparture ( XmlDocument departureData, int channelId ) : XmlDocument |
Create a new departure
|
|
CreateEnquiry ( XmlDocument enquiryData, int channelId ) : XmlDocument |
Create an enquiry, either with a new customer record or associated with an existing one
|
|
CreatePayment ( XmlDocument paymentData, int channelId ) : XmlDocument |
Log details of a payment/refund on a booking sales ledger
|
|
DeleteDeparture ( int departure, int tourId, int channelId ) : XmlDocument |
Update an existing departure
|
|
GetBookingRedirectUrl ( XmlDocument urlData, int channelId ) : XmlDocument |
Get a redirect URL from TourCMS, send the customer via it to retrieve a booking key, Tour Op use only
|
|
ListChannels ( ) : XmlDocument |
List all connected Channels (Suppliers)
|
|
ListTourImages ( ) : XmlDocument |
Get a list of Image URLs, use this if you want to bulk-mirror product images on your own hosting
|
|
ListTourImages ( int channelId ) : XmlDocument |
Get a list of Image URLs for a specific Channel (Company), use this if you want to bulk-mirror product images on your own hosting
|
|
ListTourImages ( string queryString ) : XmlDocument |
Get a list of Image URLs for a specific Channel (Company), use this if you want to bulk-mirror product images on your own hosting
|
|
ListTourImages ( string queryString, int channelId ) : XmlDocument |
Get a list of Image URLs for a specific Channel (Company), use this if you want to bulk-mirror product images on your own hosting
|
|
ListTourLocations ( ) : XmlDocument |
Retrieve a list of connected tour locations
|
|
ListTourLocations ( int channelId ) : XmlDocument |
Retrieve a list of connected tour locations for a specific Channel (Company)
|
|
ListTourLocations ( string queryString ) : XmlDocument |
Retrieve a list of connected tour locations on any connected Channel, with a queryString
|
|
ListTourLocations ( string queryString, int channelId ) : XmlDocument |
Retrieve a list of connected tour locations for a specific Channel (Company)
|
|
ListTours ( ) : XmlDocument |
Get a list of Tours with only very basic information. Probably most useful when bulk importing. For a more detailed list use
|
|
ListTours ( int channelId ) : XmlDocument |
Get a list of Tours with only very basic information. Probably most useful when bulk importing. For a more detailed list use
|
|
ListTours ( int channelId, string queryString ) : XmlDocument |
Get a list of Tours with only very basic information. Probably most useful when bulk importing. For a more detailed list use
|
|
ListTours ( string queryString ) : XmlDocument |
Get a list of Tours with only very basic information. Probably most useful when bulk importing. For a more detailed list use
|
|
LogFailedPayment ( XmlDocument paymentData, int channelId ) : XmlDocument |
Log details of a payment/refund on a booking sales ledger
|
|
Request ( string path ) : XmlDocument |
Make a generic request to the API, most documented calls will have wrappers for this
|
|
Request ( string path, int channelId ) : XmlDocument |
Make a generic request to the API, most documented calls will have wrappers for this
|
|
Request ( string path, int channelId, string verb ) : XmlDocument |
Make a generic request to the API, most documented calls will have wrappers for this
|
|
Request ( string path, int channelId, string verb, XmlDocument postData ) : XmlDocument |
Make a generic request to the API, most documented calls will have wrappers for this
|
|
SearchBookings ( ) : XmlDocument |
Get a list of all bookings, optionally filter by channel / querystring
|
|
SearchBookings ( string queryString ) : XmlDocument |
Get a list of all bookings, optionally filter by channel / querystring
|
|
SearchBookings ( string queryString, int channelId ) : XmlDocument |
Get a list of all bookings, optionally filter by channel / querystring
|
|
SearchEnquiries ( ) : XmlDocument |
Get a list of enquiries, filter by date, channel etc
|
|
SearchEnquiries ( String queryString ) : XmlDocument |
Get a list of enquiries, filter by date, channel etc
|
|
SearchEnquiries ( String queryString, int channelId ) : XmlDocument |
Get a list of enquiries, filter by date, channel etc
|
|
SearchHotelsByRange ( ) : XmlDocument |
Search Hotel type tours by a date range, optionally filter by a search querystring and/or limit to a specific channel
|
|
SearchHotelsByRange ( string queryString ) : XmlDocument |
Search Hotel type tours by a date range, optionally filter by a search querystring and/or limit to a specific channel
|
|
SearchHotelsByRange ( string queryString, string tour ) : XmlDocument |
Search Hotel type tours by a date range, optionally filter by a search querystring and/or limit to a specific channel
|
|
SearchHotelsByRange ( string queryString, string tour, int channelId ) : XmlDocument |
Search Hotel type tours by a date range, optionally filter by a search querystring and/or limit to a specific channel
|
|
SearchHotelsBySpecific ( ) : XmlDocument |
Search Hotel type tours for specific dates/occupancy, optionally filter by a search querystring and/or limit to a specific channel
|
|
SearchHotelsBySpecific ( string queryString ) : XmlDocument |
Search Hotel type tours for specific dates/occupancy, optionally filter by a search querystring and/or limit to a specific channel
|
|
SearchHotelsBySpecific ( string queryString, string tour ) : XmlDocument |
Search Hotel type tours for specific dates/occupancy, optionally filter by a search querystring and/or limit to a specific channel
|
|
SearchHotelsBySpecific ( string queryString, string tour, int channelId ) : XmlDocument |
Search Hotel type tours for specific dates/occupancy, optionally filter by a search querystring and/or limit to a specific channel
|
|
SearchRawDepartures ( int tourId, int channelId ) : XmlDocument |
Get a list of "Raw" Departures for a particular Tour
|
|
SearchTours ( ) : XmlDocument |
Get a list of Tours, optionally filter by a search querystring and/or limit to a specific channel
|
|
SearchTours ( string queryString ) : XmlDocument |
Get a list of Tours, optionally filter by a search querystring and/or limit to a specific channel
|
|
SearchTours ( string queryString, int channelId ) : XmlDocument |
Get a list of Tours, optionally filter by a search querystring and/or limit to a specific channel
|
|
ShowBooking ( int bookingId, int channelId ) : XmlDocument |
Get details on a particular booking
|
|
ShowChannel ( int channel ) : XmlDocument |
Show details on a specific Channel (Supplier)
|
|
ShowCustomer ( int customerId, int channelId ) : XmlDocument |
Get information on a particular Customer, by passing their ID and Channel
|
|
ShowEnquiry ( int enquiryId, int channelId ) : XmlDocument |
Get information on a particular enquiry, by passing it's ID and Channel
|
|
ShowPromo ( string promo, int channel ) : XmlDocument |
Check a promo code is valid for a Channel and view some info
|
|
ShowSupplier ( int supplierId, int channelId ) : XmlDocument |
Get details on an internal Supplier ID (For Operator use only, not for Marketplace Partner use)
|
|
ShowTour ( int tourId, int ChannelId ) : XmlDocument |
Show all of the details on a specific Tour, all descriptions and other content etc
|
|
ShowTour ( int tourId, int ChannelId, bool showOptions ) : XmlDocument |
Show all of the details on a specific Tour, all descriptions and other content etc
|
|
ShowTour ( int tourId, int ChannelId, string queryString ) : XmlDocument |
Show all of the details on a specific Tour, all descriptions and other content etc
|
|
ShowTourDatesAndDeals ( int tourId, int channelId ) : XmlDocument |
Get a list of dates and deals/special offers for a particular Tour
|
|
ShowTourDepartures ( int tourId, int channelId ) : XmlDocument |
Get a list of all future Departures for a specific Tour/Hotel, useful if bulk importing availability information
|
|
ShowTourDepartures ( int tourId, int channelId, string queryString ) : XmlDocument |
Get a list of all future Departures for a specific Tour/Hotel, useful if bulk importing availability information
|
|
ShowTourFeesale ( int tourId, int channelId ) : XmlDocument |
Get a list of all future Freesale Seasons for a specific Tour/Hotel, useful if bulk importing availability information
|
|
StartNewBooking ( XmlDocument bookingData, int channelId ) : XmlDocument |
Create a temporary booking
|
|
UpdateBooking ( XmlDocument bookingData, int channelId ) : XmlDocument |
Update some of the details on a booking
|
|
UpdateCustomer ( XmlDocument customerData, int channelId ) : XmlDocument |
Update an existing customer record, e.g. contact details
|
|
UpdateDeparture ( XmlDocument departureData, int channelId ) : XmlDocument |
Update an existing departure
|
|
UpdateTour ( XmlDocument tourData, int channelId ) : XmlDocument |
Update a Tour/Hotel
|
|
UpdateTourUrl ( int tourId, int channelId, string tourUrl ) : XmlDocument |
Update the "Product URL" on a Tour/Hotel
|
|
marketplaceWrapper ( int marketplaceId, string privateKey ) : System |
Create a new instance of the TourCMS Marketplace wrapper, pass Marketplace ID and Key
|
Method | Description | |
---|---|---|
DateTimeToStamp ( DateTime value ) : int |
Convert a DateTime object (in UTC) to a Unix Timestapm, generally you won't neeed to call this directly
|
|
GenerateSignature ( string path, string verb, int channelId, DateTime outboundTime ) : string |
Create an encrypted signature for a particular request, generally you won't neeed to call this directly
|
|
StampToDateTime ( int value ) : DateTime |
Convert a Unix Timestamp to a UTC DateTime object, generally you won't need to call this directly
|
public ApiRateLimitStatus ( ) : |
||
return |
public ApiRateLimitStatus ( int channelId ) : |
||
channelId | int | |
return |
public ChannelPerformance ( int channel ) : XmlDocument | ||
channel | int | |
return | XmlDocument |
public CheckCustomerLogin ( string username, string password, int channelId ) : XmlDocument | ||
username | string | |
password | string | |
channelId | int | |
return | XmlDocument |
public CheckTourAvailability ( string queryString, int tourId, int channelId ) : XmlDocument | ||
queryString | string | |
tourId | int | |
channelId | int | |
return | XmlDocument |
public CommitNewBooking ( XmlDocument bookingData, int channelId ) : XmlDocument | ||
bookingData | XmlDocument | |
channelId | int | |
return | XmlDocument |
public CreateCustomer ( XmlDocument customerData, int channelId ) : XmlDocument | ||
customerData | XmlDocument | |
channelId | int | |
return | XmlDocument |
public CreateDeparture ( XmlDocument departureData, int channelId ) : XmlDocument | ||
departureData | XmlDocument | |
channelId | int | |
return | XmlDocument |
public CreateEnquiry ( XmlDocument enquiryData, int channelId ) : XmlDocument | ||
enquiryData | XmlDocument | |
channelId | int | |
return | XmlDocument |
public CreatePayment ( XmlDocument paymentData, int channelId ) : XmlDocument | ||
paymentData | XmlDocument | |
channelId | int | |
return | XmlDocument |
protected DateTimeToStamp ( DateTime value ) : int | ||
value | DateTime | |
return | int |
public DeleteDeparture ( int departure, int tourId, int channelId ) : XmlDocument | ||
departure | int | |
tourId | int | |
channelId | int | |
return | XmlDocument |
protected GenerateSignature ( string path, string verb, int channelId, DateTime outboundTime ) : string | ||
path | string | |
verb | string | |
channelId | int | |
outboundTime | DateTime | |
return | string |
public GetBookingRedirectUrl ( XmlDocument urlData, int channelId ) : XmlDocument | ||
urlData | XmlDocument | |
channelId | int | |
return | XmlDocument |
public ListTourImages ( int channelId ) : XmlDocument | ||
channelId | int | |
return | XmlDocument |
public ListTourImages ( string queryString ) : XmlDocument | ||
queryString | string | |
return | XmlDocument |
public ListTourImages ( string queryString, int channelId ) : XmlDocument | ||
queryString | string | |
channelId | int | |
return | XmlDocument |
public ListTourLocations ( int channelId ) : XmlDocument | ||
channelId | int | |
return | XmlDocument |
public ListTourLocations ( string queryString ) : XmlDocument | ||
queryString | string | |
return | XmlDocument |
public ListTourLocations ( string queryString, int channelId ) : XmlDocument | ||
queryString | string | |
channelId | int | |
return | XmlDocument |
public ListTours ( int channelId ) : XmlDocument | ||
channelId | int | |
return | XmlDocument |
public ListTours ( int channelId, string queryString ) : XmlDocument | ||
channelId | int | |
queryString | string | |
return | XmlDocument |
public ListTours ( string queryString ) : XmlDocument | ||
queryString | string | |
return | XmlDocument |
public LogFailedPayment ( XmlDocument paymentData, int channelId ) : XmlDocument | ||
paymentData | XmlDocument | |
channelId | int | |
return | XmlDocument |
public Request ( string path, int channelId ) : XmlDocument | ||
path | string | |
channelId | int | |
return | XmlDocument |
public Request ( string path, int channelId, string verb ) : XmlDocument | ||
path | string | |
channelId | int | |
verb | string | |
return | XmlDocument |
public Request ( string path, int channelId, string verb, XmlDocument postData ) : XmlDocument | ||
path | string | |
channelId | int | |
verb | string | |
postData | XmlDocument | |
return | XmlDocument |
public SearchBookings ( string queryString ) : XmlDocument | ||
queryString | string | |
return | XmlDocument |
public SearchBookings ( string queryString, int channelId ) : XmlDocument | ||
queryString | string | |
channelId | int | |
return | XmlDocument |
public SearchEnquiries ( String queryString ) : XmlDocument | ||
queryString | String | |
return | XmlDocument |
public SearchEnquiries ( String queryString, int channelId ) : XmlDocument | ||
queryString | String | |
channelId | int | |
return | XmlDocument |
public SearchHotelsByRange ( string queryString ) : XmlDocument | ||
queryString | string | |
return | XmlDocument |
public SearchHotelsByRange ( string queryString, string tour ) : XmlDocument | ||
queryString | string | |
tour | string | |
return | XmlDocument |
public SearchHotelsByRange ( string queryString, string tour, int channelId ) : XmlDocument | ||
queryString | string | |
tour | string | |
channelId | int | |
return | XmlDocument |
public SearchHotelsBySpecific ( ) : XmlDocument | ||
return | XmlDocument |
public SearchHotelsBySpecific ( string queryString ) : XmlDocument | ||
queryString | string | |
return | XmlDocument |
public SearchHotelsBySpecific ( string queryString, string tour ) : XmlDocument | ||
queryString | string | |
tour | string | |
return | XmlDocument |
public SearchHotelsBySpecific ( string queryString, string tour, int channelId ) : XmlDocument | ||
queryString | string | |
tour | string | |
channelId | int | |
return | XmlDocument |
public SearchRawDepartures ( int tourId, int channelId ) : XmlDocument | ||
tourId | int | |
channelId | int | |
return | XmlDocument |
public SearchTours ( string queryString ) : XmlDocument | ||
queryString | string | |
return | XmlDocument |
public SearchTours ( string queryString, int channelId ) : XmlDocument | ||
queryString | string | |
channelId | int | |
return | XmlDocument |
public ShowBooking ( int bookingId, int channelId ) : XmlDocument | ||
bookingId | int | |
channelId | int | |
return | XmlDocument |
public ShowChannel ( int channel ) : XmlDocument | ||
channel | int | |
return | XmlDocument |
public ShowCustomer ( int customerId, int channelId ) : XmlDocument | ||
customerId | int | |
channelId | int | |
return | XmlDocument |
public ShowEnquiry ( int enquiryId, int channelId ) : XmlDocument | ||
enquiryId | int | |
channelId | int | |
return | XmlDocument |
public ShowPromo ( string promo, int channel ) : XmlDocument | ||
promo | string | |
channel | int | |
return | XmlDocument |
public ShowSupplier ( int supplierId, int channelId ) : XmlDocument | ||
supplierId | int | |
channelId | int | |
return | XmlDocument |
public ShowTour ( int tourId, int ChannelId ) : XmlDocument | ||
tourId | int | |
ChannelId | int | |
return | XmlDocument |
public ShowTour ( int tourId, int ChannelId, bool showOptions ) : XmlDocument | ||
tourId | int | |
ChannelId | int | |
showOptions | bool | |
return | XmlDocument |
public ShowTour ( int tourId, int ChannelId, string queryString ) : XmlDocument | ||
tourId | int | |
ChannelId | int | |
queryString | string | |
return | XmlDocument |
public ShowTourDatesAndDeals ( int tourId, int channelId ) : XmlDocument | ||
tourId | int | |
channelId | int | |
return | XmlDocument |
public ShowTourDepartures ( int tourId, int channelId ) : XmlDocument | ||
tourId | int | |
channelId | int | |
return | XmlDocument |
public ShowTourDepartures ( int tourId, int channelId, string queryString ) : XmlDocument | ||
tourId | int | |
channelId | int | |
queryString | string | |
return | XmlDocument |
public ShowTourFeesale ( int tourId, int channelId ) : XmlDocument | ||
tourId | int | |
channelId | int | |
return | XmlDocument |
protected StampToDateTime ( int value ) : DateTime | ||
value | int | |
return | DateTime |
public StartNewBooking ( XmlDocument bookingData, int channelId ) : XmlDocument | ||
bookingData | XmlDocument | |
channelId | int | |
return | XmlDocument |
public UpdateBooking ( XmlDocument bookingData, int channelId ) : XmlDocument | ||
bookingData | XmlDocument | |
channelId | int | |
return | XmlDocument |
public UpdateCustomer ( XmlDocument customerData, int channelId ) : XmlDocument | ||
customerData | XmlDocument | |
channelId | int | |
return | XmlDocument |
public UpdateDeparture ( XmlDocument departureData, int channelId ) : XmlDocument | ||
departureData | XmlDocument | |
channelId | int | |
return | XmlDocument |
public UpdateTour ( XmlDocument tourData, int channelId ) : XmlDocument | ||
tourData | XmlDocument | |
channelId | int | |
return | XmlDocument |
public UpdateTourUrl ( int tourId, int channelId, string tourUrl ) : XmlDocument | ||
tourId | int | |
channelId | int | |
tourUrl | string | |
return | XmlDocument |
public marketplaceWrapper ( int marketplaceId, string privateKey ) : System | ||
marketplaceId | int | |
privateKey | string | |
return | System |