home > support > API > Marketplace API > API: channel information

Show Channel

Purpose	Return channel information. Think of this as company/brand information
Notes	Most TourCMS accounts will only have one channel however it is possible for TourCMS accounts to follow a multi-channel strategy. The data fields with _private in are not for public display. They are provided to make it easy for you to create a management system to review multiple channels
REST info	Call	/c/channel/show
	Formats	XML
	Example	/c/channel/show.xml
	Verb	GET
Code	PHP C# VB PHP examples use the PHP Client Library with SimpleXML Description `object show_channel ( int $channel )` Parameters `$channel ID for the channel (supplier) we want the details` Example `// ID for the channel (supplier) we want the details for $channel = 6; // Query the TourCMS API $result = $tourcms->show_channel($channel); // Get the channel node $channel = $result->channel; // Print out a link to the channel website print '<a href="'.$channel->home_url.'">'.$channel->channel_name.' website</a>';` `Example Tours website` C# examples use the .Net Client Library Overload list `XmlDocument ShowChannel (int ChannelId)` Parameters `channelId ID for the channel (supplier) we want the details` Example `// ID for the channel (supplier) we want the details for int channelId = 3; // Query the TourCMS API XmlDocument doc = myTourCMS.ShowChannel(channelId); // Display the Channel name and web address String chanName = doc.SelectSingleNode("//channel/channel_name"); String chanWeb = doc.SelectSingleNode("//channel/home_url"); Console.WriteLine(chanName + " website - " + chanWeb);` `Example Tours website - http://www.example.com` VB examples use the .Net Client Library Overload list `XmlDocument ShowChannel (int ChannelId)` Parameters `channelId ID for the channel (supplier) we want the details` Example `' ID for the channel (supplier) we want the details for Dim channelId As Integer = 6 ' Query the TourCMS API Dim doc As XmlDocument = myTourCMS.ShowChannel(channelId) ' Display the Channel name and web address Dim chanName As String = doc.SelectSingleNode("//channel/channel_name") Dim chanWeb As String = doc.SelectSingleNode("//channel/home_url") Console.WriteLine(chanName & " website - " & chanWeb)` `Example Tours website - http://www.example.com`

Querystring parameters

There are no querystring parameters supported by this method.

Response fields

XML Node

Notes

request

Confirmation of the request that you sent

error

Any error message returned, if there is no error this will just contain the text OK

channel

The channel node contains the following child nodes.

XML Node	Notes
channel_id	Channel ID
account_id	Account ID
channel_name	Channel name (Company name)
get_perm_custbook	API GET permission - Customers / Bookings
get_perm_agsup	API GET permission - Agents / Suppliers. Permission settings
post_perm_custbook	API POST permission - Customers / Bookings
post_perm_agsup	API POST permission - Agents / Suppliers
post_perm_dpa	API POST permission - Products / Dates / Prices / Availability
home_url	URL website homepage
home_url_tracked	URL website homepage (with agent tracking)
logo_url	Channel logo URL
lang	Channel language
utc_offset_mins	Local time: Offset (minutes) from UTC
sale_currency	Sale currency (prices returned in this currency)
base_currency	Base currency - for accounting integrations only
connection_date	Date you connected to this channel (YYYY-MM-DD)
booking_style	ENQUIRY, QUOTE, BOOKING Permits you to use text such as book now or enquire now It describes what the channel uses their booking engine for
short_desc	Short description
long_desc	Long description
very_long_desc	Very long description
why_desc	Why us?
bonding_desc	Bonding / financial protection
certification	e.g. for activity companies could be industry association memberships
cancel_policy	Cancellation policy
terms_and_conditions	Terms and conditions for booking
email_customer	Sales enquiry email address that can be shown to customers
phone_customer	Sales enquiry telephone number that can be shown to customers
office_hours	Office hours
twitter	Twitter handle (excludes the @)
tripadvisor	URL for TripAdvisor entry
youtube	URL for Youtube channel
facebook	URL for Facebook page
flickr	URL for Flickr photo page
othersm	URL for some other social media site (e.g. Ning, blog, forums etc)
address_1	Address line 1
address_2	Address line 2
address_city	City
address_state	State
address_postcode	Postcode / Zipcode
address_country	Country code
commercial_email_private	Email address for partners to use to contact the channel
commercial_contactname_private	Name of the channel contact
commercial_pitch_private	What the standard deal for this channel is
commercial_ppl_private	Interested in pay per lead
commercial_dir_private	Interested in directory listings / pay to list
commercial_ppc_private	Interested in pay per click
commercial_aff_private	Interested in affiliate deals (consumer books with channel directly)
commercial_ag_private	Interested in agent deals (agent takes money)
commercial_any_private	Interested in all sorts of promotional ideas!
commercial_avleadtime_private	Average leadtime (Days between when booking made and start date)
commercial_avtransaction_private	Average transaction size (in sale currency)
commercial_avpeople_private	Average number of people (pax) in a booking
commercial_avclick2book_private	Average number of unique visitors (via tracking script) to deliver 1 booking
commercial_avduration_private	Average duration of a booking (days) (i.e. whether day tours or longer)
commercial_percent_online_private	% bookings received online
commercial_percent_convert_private	% of bookings that ultimately convert to confirmed bookings

Sample XML Response

/c/channel/show.xml

16 commercial information fields have been removed in this live data example

<?xml version="1.0" encoding="utf-8"?>
<response>
    <request>GET /c/channel/show.xml</request>
    <error>OK</error>
    <channel>
        <channel_id>6</channel_id>
        <account_id>5</account_id>
        <channel_name>Egypt Uncovered</channel_name>
        <connection_permission>2</connection_permission>
        <utc_offset_mins>0</utc_offset_mins>
        <lang>en</lang>
        <tour_count>43</tour_count>
        <sale_currency>GBP</sale_currency>
        <base_currency>GBP</base_currency>
        <connection_date>2009-12-12 09:30:54</connection_date>
        <home_url>http://www.egypt-uncovered.com</home_url>
        <home_url_tracked>http://live.tourcms.com/track/t.php?p=46&amp;m=0&amp;a=5&amp;k=2a552a58db22&amp;url=http%3A%2F%2Fwww.egypt-uncovered.com</home_url_tracked>
        <logo_url>http://media.tourcms.com/a/5/w6_logo.jpg</logo_url>
        <booking_style>ENQUIRY</booking_style>
        <short_desc>Cultural and adventure travel in Egypt &amp; Jordan</short_desc>
        <long_desc>Whether you want a city break in Cairo, a desert safari, a luxury Nile Cruise, to include Jordan in a longer itinerary, or a scuba-diving holiday in the Red Sea, Egypt Uncovered has the adventure travel holiday for you!</long_desc>
        <very_long_desc>Egypt Uncovered is a trading name of Uncover the World Ltd., which is a UK-based tour operator specialising in cultural and adventure travel in the Middle East, the Indian Subcontinent and South East Asia. 
        In Egypt they offer a complete range of tours from short city breaks, to luxury Nile cruises, desert safaris and scuba diving in the Red Sea. Jordan is also covered, including several itineraries starting in Egypt. Both small group tours with regular departures throughout the year, and also private, tailor-made holiday itineraries are available. 
        Uncover the World is a member of the Travel Trust Association (U3627) and holds an ATOL (T7231) for its customers financial protection.</very_long_desc>
        <bonding>We provide 100% financial protection to our clients through our membership with the Travel Trust Association (U3627) and our ATOL (T7231)</bonding>
        <certification>Travel Trust Association (U3627) 
        ATOL (T7231)</certification>
        <cancel_policy>Our cancellation policy is detailed in our booking conditions. In principle, your initial deposit is not refundable, and the amount of your remaining balance that we will refund will reduce the closer to departure that you cancel.</cancel_policy>
        <terms_and_conditions>Our cancellation policy is detailed in our booking conditions. In principle, your initial deposit is not refundable, and the amount of your remaining balance that we will refund will reduce the closer to departure that you cancel.</terms_and_conditions>
        <email_customer>tours@egypt-uncovered.com</email_customer>
        <phone_customer>44 (0)845 130 4849</phone_customer>
        <office_hours>Mon-Fri 09:00-18:00, Sat 09:30-12:30</office_hours>
        <twitter>utworld</twitter>
        <youtube>http://www.youtube.com/uncovertheworld</youtube>
        <facebook>http://www.facebook.com/pages/Uncover-the-World/146259382088758</facebook>
        <flickr>http://www.flickr.com/photos/uncovertheworld/</flickr>
        <address_1>Teazle House, Sunnybank Mills</address_1>
        <address_2>Town Street, Farsley</address_2>
        <address_city>Pudsey</address_city>
        <address_state>West Yorkshire</address_state>
        <address_postcode>LS28 5UJ</address_postcode>
        <address_country>GB</address_country>
    </channel>
</response>

More information

Back to API list

Show Channel

Description

Parameters

Example

Overload list

Parameters

Example

Overload list

Parameters

Example

Querystring parameters

Response fields

Sample XML Response

More information