Content API
The API is available as either a SOAP webservice (XML) or a RESTful endpoint returning JSON data.
API Services for REST / JSON:
List Available Points: https://wetu.com/API/Pins/<APIKEY>/List
Get Detailed Information: https://wetu.com/API/Pins/<APIKEY>/Get
Search Available Points: https://wetu.com/API/Pins/<APIKEY>/Search/<TERMS>
Get Pins with paging::https://wetu.com/API/Pins/<APIKEY>/GetPinsWithPaging
You can also query a paged result set by changing the request endpoint to https://wetu.com/API/Pins/SAMPLE/GetPinsWithPaging?pageNumber=1
This endpoint adds one extra parameter, which is the page number you are looking for.
Each result set will be limited to 1000 results.
Get Service
The Get service allows you to filter down to a specific subset by a combination of two possible
query parameters:
- modifiedsince (ISO8601 date value)
- e.g. https://wetu.com/API/Pins/SAMPLE/Get?modifiedsince=2015-10-15T00:00:00
- ids (comma separated list of numeric ids for points)
- returns only those explicit points
- e.g. https://wetu.com/API/Pins/SAMPLE/Get?ids=1197,3733
You can also request content in a different language (default English) by appending using the lang query parameter. Please note that the behavior of this will vary depending on which options have been configured on the account - notably whether Machine Translations are enabled, and whether untranslated (i.e. English) content should be provided if not translation is available.
- lang (ISO 639-1 language codes)
- e.g. https://wetu.com/API/Pins/SAMPLE/Get?ids=1197,3733&lang=de
List
The List service has a four optional query parameters:
- all=include
- owned=y
- suppliers=y
- countries=AU,ZA
- filters results down to only content in the provided countries
- country codes are standard ISO 3166-1 Alpha-2 codes
- multiple country codes should be comma separated
-
modifiedsince (ISO8601 date value)
- returns only points modified after that date
- e.g. https://wetu.com/API/Pins/SAMPLE/Get?modifiedsince=2015-10-15T00:00:00
Search
The Search service has a single optional query parameter:
- all=include
The SOAP variant is available at: https://wetu.com/API/Pins.asmx (append ?wsdl for metadata if needed). For the REST variant, parameters may also be passed as POST values.
If you'd like to see an example of the content available, here is a formatted response for one of our better populated properties: https://wetu.com/API/Pins/SAMPLE/Get?ids=3733
Images referred to in the API are available raw; or can be requested scaled or cropped from our internal image scaler.
Image Scaler
The image scaler url structure is: http://wetu.com/ImageHandler/<SIZE>/<URL_FRAGMENT>
The size format is one of the following:
- cWxH
- http://wetu.com/ImageHandler/c400x300/3733/EVilla_Deck_Evening2.jpg
- hWxH
- http://wetu.com/ImageHandler/h400x300/3733/EVilla_Deck_Evening2.jpg
- wWxH
- http://wetu.com/ImageHandler/w400x300/3733/EVilla_Deck_Evening2.jpg
- WxH
- http://wetu.com/ImageHandler/400x300/3733/EVilla_Deck_Evening2.jpg
- nWxH
- http://wetu.com/ImageHandler/n400x300/3733/EVilla_Deck_Evening2.jpghttp://wetu.com/ImageHandler/n400x300/3733/EVilla_Deck_Evening2.jpg
- nfWxH
- http://wetu.com/ImageHandler/nf400x300/3733/EVilla_Deck_Evening2.jpg
For convenience, the API already provides the image url_fragment alongside the full image url. All you need to to do is decide on the resolution and crop behavior you need in a given situation, and append that fragment. Please note the leading / is not included in the fragment.
Data Structures
The REST / JSON and SOAP / XML versions of the API use different naming standards for properties. Documented below are the SOAP / XML values, for REST / JSON simply convert these to snake case (e.g. MapObjectId becomes map_object_id).
Pinprimary type - the API will return an array of these |
||
|
MapObjectId |
int |
Unique identifier used within Wetu. This field is being renamed within Wetu, documentation for other systems may refer to this as a ContentEntityId. |
|
Name |
string |
|
|
Status |
string |
Enhanced, Managed or Unmanaged. Enhanced and Managed properties are content managed directly by their owners / operators. |
|
LastModified |
string |
ISO8601 Date/Time; indicates last time the content was updated. |
|
Type |
string |
Classification of content type - Accommodation is most frequently encountered. Other options are Destination, Activity, Person, Restaurant, Information or Area. |
|
Category |
string |
Further classification of above. |
|
Subcategory |
string |
Specialised classification for activities. |
|
Position |
Geographic location, including GPS coordinates and country / region labels. |
|
|
Content |
Images, videos, descriptions, 360 panoramas |
|
|
Documentation |
Documentation (array) |
|
|
Specials |
Specials (array) |
|
|
AffiliateName |
string |
identifies the primary booking / availability engine used |
|
AffiliateCode |
string |
identifier for above system |
|
AffiliateInterface |
string |
secondary / group identifier for certain engines |
Accommodation (extends Pin) |
||
|
Features |
||
|
Rooms |
Room (array) |
|
|
Units |
Unit (array) |
|
|
Activities |
SimpleItem (array) |
|
|
SpaOptions |
SimpleItem (array) |
|
|
Restaurants |
SimpleItem (array) |
|
Activity (extends Pin) |
||
|
Features |
||
|
Options |
Option (array) |
|
ConferenceVenue (extends Pin) |
||
|
Features |
Features_ConferenceVenue |
|
|
Venues |
ConferenceVenueRoom (array) |
|
|
Packages |
ConferencePackage (array) |
|
Restaurant (extends Pin) |
||
|
Features |
|
|
Person (extends Pin) |
||
|
Features |
|
|
|
PersonImage |
|
|
Destination (extends Pin) |
||
|
DestinationImage |
|
|
Important Note: Wetu-provided destination images are not available through the Content API due to licensing restrictions. Custom images loaded through Hybrid Content are distributed through the API as normal.
Country (extends Destination) |
||
|
TravelInformation |
Travel guidance, such as currency, visa, health and safety. |
|
Position (extends Pin) |
||
|
Latitude |
double |
geographic location of property, suitable for showing on a map |
|
Longitude |
double |
|
|
DrivingLatitude |
double |
alternate location useable for routing (to avoid being routed to rear entrances / nearby roads) |
|
DrivingLongitude |
double |
|
|
Country |
string |
|
|
Region |
string |
province / state / administrative region |
|
Area |
string |
town / city |
|
Location |
string |
suburb |
|
Destination |
string |
Wetu tourism region |
Features_Restaurant |
||
|
Seats |
int |
total guest capacity |
|
SpokenLanguages |
string (array) |
|
|
Cuisine |
string (array) |
|
|
Ambiance |
string (array) |
|
|
Facilities |
string (array) |
|
|
OperatingHours |
|
|
Features_Person |
||
|
Languages |
string (array) |
spoken languages |
|
Skills |
string (array) |
|
|
Regions |
string (array) |
geographic areas of specialty |
|
SpecialInterests |
string (array) |
|
Content (extends Pin) |
||
|
GeneralDescription |
string |
standard description, may contain HTML |
|
ExtendedDescription |
string |
longer description, may contain HTML |
|
TeaserDescription |
string |
short teaser description, may contain HTML |
|
ContactInformation |
email addresses, phone numbers, website, booking and skype addresses |
|
|
Images |
Image (array) |
|
|
YoutubeVideos |
Video (array) |
|
|
Panoramas |
Panorama (array) |
|
|
Logo |
|
|
Image |
||
|
Url |
string |
full url to image |
|
UrlFragment |
string |
partial image url, intended for use with Image Scaler |
|
Label |
string |
short label for image |
|
Description |
string |
longer description |
|
Credit |
string |
photographer / provider credit |
|
Width |
int |
|
|
Height |
int |
|
|
Size |
int |
bytes |
Video |
||
|
Url |
string |
full url to video page |
|
EmbedUrl |
string |
embed appropriate url, for iframe |
|
Label |
string |
title |
|
Description |
string |
longer description |
Panoramamany panoramas require Flash for display; avoid using them on mobile devices |
||
|
Url |
string |
embed appropriate url, for iframe |
|
Label |
string |
title |
|
Description |
string |
longer description |
SimpleItem |
||
|
Id |
string |
Unique identifier for this content item, useful for room types |
|
Name |
string |
|
|
Description |
string |
|
|
Images |
Image (array) |
|
Room (extends SimpleItem) |
||
|
PerPersonSharingRates |
ItemRate (array) |
pricing (per person) |
|
SingleRates |
ItemRate (array) |
pricing (single) |
|
RoomRates |
ItemRate (array) |
pricing (per room) |
|
Amenities |
string (array) |
|
|
AffiliateCode |
string |
external booking system identifier |
Unit (extends SimpleItem) |
||
|
UnitRates |
ItemRate (array) |
pricing (per unit) |
|
Amenities |
string (array) |
|
|
AffiliateCode |
string |
external booking system identifier |
Option (extends SimpleItem) |
||
|
OptionRates |
ItemRate (array) |
pricing |
ConferenceVenueRoom (extends SimpleItem) |
||
|
CapacityReception |
int |
attendee capacity if venue is configured as reception hall |
|
CapacityTheatre |
int |
attendee capacity if venue is configured as theatre |
|
CapacityClassroom |
int |
attendee capacity if venue is configured as classroom |
|
CapacityBanquet |
int |
attendee capacity if venue is configured as banquet hall |
|
CapacityBanquetDanceFloor |
int |
attendee capacity if venue is configured as banquet hall with dance floor |
|
CapacityBoardroom |
int |
attendee capacity if venue is configured as boardroom |
|
CapacityUShaped |
int |
attendee capacity if venue is configured with U-shaped seating |
|
EntranceHeight |
double |
metres |
|
EntranceWidth |
double |
metres |
|
DimensionsLength |
double |
metres |
|
DimensionsWidth |
double |
metres |
|
VenueHireRates |
ItemRate (array) |
pricing |
ConferencePackage (extends SimpleItem) |
||
|
Rates |
ItemRate (array) |
|
ItemRateindicates a pricing / rate |
||
|
Start |
string |
ISO8601 Date/Time |
|
End |
string |
ISO8601 Date/Time |
|
Type |
string |
|
|
Currency |
string |
ISO4217 (e.g. USD / GBP) |
|
Rate |
double |
|
|
Conditions |
string |
|
|
Included |
string |
|
Documentation (extends Pin) |
||
|
Section |
string |
grouping label for documentation |
|
Label |
string |
title |
|
Url |
string |
url to document |
Specials (extends Pin) |
||
|
Name |
string |
|
|
Type |
string |
special classification |
|
Description |
string |
full text |
|
Start |
string |
ISO8601 Date/Time |
|
End |
string |
ISO8601 Date/Time |
|
Conditions |
string |
|
Please contact Wetu to obtain an API Key.
enterprise@wetu.com