This page is a reference of all feed methods for the Frommer’s Unlimited API.
Feeds:
GET /frommers/audience_interest.feed
Audience Interest Detail Feed.
Example
- XML
- http://demosite.frommers.biz/frommers/audience_interest.feed?audienceInterestId=140847
- JSON
- http://demosite.frommers.biz/frommers/audience_interest.feed?audienceInterestId=140847&feedType=json
Parameters
This feed requires that at least one parameter is provided.
- audienceInterestId
- Audience Interest Id
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- whatsonwhenId
- Legacy Whatsonwhen Category ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
GET /frommers/audience_interest_search.feed
Feed to display a subtree of audienceInterests.
Example
- XML
- http://demosite.frommers.biz/frommers/audience_interest_search.feed?audienceInterestId=530006&showChildren=true
- JSON
- http://demosite.frommers.biz/frommers/audience_interest_search.feed?audienceInterestId=530006&showChildren=true&feedType=json
Parameters
This feed requires that at least one parameter is provided.
- showCount
- Count the number of Events and Poi in each for a specific query (support all parameters of the main_search)
- Allowed regex pattern:
true|false
- Allowed regex pattern:
- showChildren
- Displays the children of the current parent
- Allowed regex pattern:
true|false
- Allowed regex pattern:
- depth
- Restrict the depth of children to display
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- page
- The page of results to retrieve
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- nPerPage
- Use this to restrict the number of results per page
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- query
- Restrict by free text query
- type
- Restrict results by type, either IOI or GUIDE
- subType
- Restrict results by subType. For type=IOI use either EVENT or POI and for type=GUIDE either FROMMERS_GUIDE OR WHATSONWHEN_GUIDE
- audienceInterestId
- Restrict by Audience Interest ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- locationId
- Restrict by Location ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- locQuery
- Restrict by Location name
- mappedLocationType
- Restrict by a mapped location type, eg IATA
- Part of group(s): mapping
- mappedLocationId
- Restrict by a mapped location id, eg LHR
- Part of group(s): mapping
Parameter Groups
When using a parameters that is a member of a group, it is required to include all other group
members in the request.
- mapping
- mappedLocationId mappedLocationType
GET /frommers/calendar_event_search.feed
Feed to display the events count per day.
Example
- XML
- http://demosite.frommers.biz/frommers/calendar_event_search.feed?daysAhead=10
- JSON
- http://demosite.frommers.biz/frommers/calendar_event_search.feed?daysAhead=10&feedType=json
Parameters
All the parameters for this feed are optional.
- startDate
- Restrict by Start Date in YYYYMMDD format
- Allowed regex pattern:
(19|20)\d\d(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])
- Allowed regex pattern:
- endDate
- Restrict by End Date in YYYYMMDD format
- Allowed regex pattern:
(19|20)\d\d(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])
- Allowed regex pattern:
- daysAhead
- Creates an endDate based on the number of days ahead of the startDate. If startDate is empty then todays date is used
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- rankId
- Restrict results to IOIs with a given rank (will take preference over minRankId and maxRankId)
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- minRankId
- Restrict results to IOIs with a minimum rank
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- maxRankId
- Restrict results to IOIs with a maximum rank
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- longitude
- Restict results by longitude
- Allowed regex pattern:
[-+]?[0-9]*\.?[0-9]+ - Part of group(s): geocode
- Allowed regex pattern:
- latitude
- Restrict results by latitude
- Allowed regex pattern:
[-+]?[0-9]*\.?[0-9]+ - Part of group(s): geocode
- Allowed regex pattern:
- miles
- Restrict results by mile radius
- Allowed regex pattern:
[-+]?[0-9]*\.?[0-9]+ - Part of group(s): geocode
- Allowed regex pattern:
- page
- The page of results to retrieve
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- nPerPage
- Use this to restrict the number of results per page
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- query
- Restrict by free text query
- type
- Restrict results by type, either IOI or GUIDE
- subType
- Restrict results by subType. For type=IOI use either EVENT or POI and for type=GUIDE either FROMMERS_GUIDE OR WHATSONWHEN_GUIDE
- audienceInterestId
- Restrict by Audience Interest ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- locationId
- Restrict by Location ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- locQuery
- Restrict by Location name
- mappedLocationType
- Restrict by a mapped location type, eg IATA
- Part of group(s): mapping
- mappedLocationId
- Restrict by a mapped location id, eg LHR
- Part of group(s): mapping
Parameter Groups
When using a parameters that is a member of a group, it is required to include all other group
members in the request.
- geocode
- latitude longitude miles
- mapping
- mappedLocationId mappedLocationType
GET /frommers/destination_menu.feed
Feed for building desination based content menus.
Example
- XML
- http://demosite.frommers.biz/frommers/destination_menu.feed?locationId=150668
- JSON
- http://demosite.frommers.biz/frommers/destination_menu.feed?locationId=150668&feedType=json
Parameters
This feed requires that at least one parameter is provided.
- locationId
- Location ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- whatsonwhenId
- Legacy Whatsonwhen Location ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- frommersDestinationId
- Legacy Frommers Destination ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- itemOfInterestId
- Item Of Interest ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- guideStructureId
- GuideStructure ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- guideId
- Guide ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- autoHide
- Auto hide menu items from feed output
- Allowed regex pattern:
true|false
- Allowed regex pattern:
GET /frommers/event_search.feed
Feed to search Event IOIs.
Example
- XML
- http://demosite.frommers.biz/frommers/event_search.feed
- JSON
- http://demosite.frommers.biz/frommers/event_search.feed?feedType=json
Parameters
All the parameters for this feed are optional.
- startDate
- Restrict by Start Date in YYYYMMDD format
- Allowed regex pattern:
(19|20)\d\d(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])
- Allowed regex pattern:
- endDate
- Restrict by End Date in YYYYMMDD format
- Allowed regex pattern:
(19|20)\d\d(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])
- Allowed regex pattern:
- daysAhead
- Creates an endDate based on the number of days ahead of the startDate. If startDate is empty then todays date is used
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- rankId
- Restrict results to IOIs with a given rank (will take preference over minRankId and maxRankId)
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- minRankId
- Restrict results to IOIs with a minimum rank
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- maxRankId
- Restrict results to IOIs with a maximum rank
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- longitude
- Restict results by longitude
- Allowed regex pattern:
[-+]?[0-9]*\.?[0-9]+ - Part of group(s): geocode
- Allowed regex pattern:
- latitude
- Restrict results by latitude
- Allowed regex pattern:
[-+]?[0-9]*\.?[0-9]+ - Part of group(s): geocode
- Allowed regex pattern:
- miles
- Restrict results by mile radius
- Allowed regex pattern:
[-+]?[0-9]*\.?[0-9]+ - Part of group(s): geocode
- Allowed regex pattern:
- page
- The page of results to retrieve
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- nPerPage
- Use this to restrict the number of results per page
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- query
- Restrict by free text query
- type
- Restrict results by type, either IOI or GUIDE
- subType
- Restrict results by subType. For type=IOI use either EVENT or POI and for type=GUIDE either FROMMERS_GUIDE OR WHATSONWHEN_GUIDE
- audienceInterestId
- Restrict by Audience Interest ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- locationId
- Restrict by Location ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- locQuery
- Restrict by Location name
- mappedLocationType
- Restrict by a mapped location type, eg IATA
- Part of group(s): mapping
- mappedLocationId
- Restrict by a mapped location id, eg LHR
- Part of group(s): mapping
Parameter Groups
When using a parameters that is a member of a group, it is required to include all other group
members in the request.
- geocode
- latitude longitude miles
- mapping
- mappedLocationId mappedLocationType
GET /frommers/guide.feed
Guide Detail Feed.
Example
- XML
- http://demosite.frommers.biz/frommers/guide.feed?guideId=295020
- JSON
- http://demosite.frommers.biz/frommers/guide.feed?guideId=295020&feedType=json
Parameters
This feed requires that at least one parameter is provided.
- guideId
- Guide ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- frommersDestinationId
- Legacy Frommers Destination ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
GET /frommers/guide_structure.feed
Guide Structure Detail Feed.
Example
- XML
- http://demosite.frommers.biz/frommers/guide_structure.feed?guideStructureId=249369
- JSON
- http://demosite.frommers.biz/frommers/guide_structure.feed?guideStructureId=249369&feedType=json
Parameters
This feed requires that at least one parameter is provided.
- guideStructureId
- Guide Structure ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- frommersId
- Legacy Frommers Category ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- guideStructureTypeId
- Guide Structure Type ID
- Allowed regex pattern:
\d+ - Part of group(s): guide-type
- Allowed regex pattern:
- locationId
- Location ID
- Allowed regex pattern:
\d+ - Part of group(s): guide-type
- Allowed regex pattern:
Parameter Groups
When using a parameters that is a member of a group, it is required to include all other group
members in the request.
- guide-type
- guideStructureTypeId locationId
GET /frommers/item_of_interest.feed
IOI Detail Feed.
Example
- XML
- http://demosite.frommers.biz/frommers/item_of_interest.feed?itemOfInterestId=189025
- JSON
- http://demosite.frommers.biz/frommers/item_of_interest.feed?itemOfInterestId=189025&feedType=json
Parameters
This feed requires that at least one parameter is provided.
- itemOfInterestId
- IOI ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- whatsonwhenId
- Legacy Whatsonwhen Event ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- frommersAccommodationId
- Legacy Frommers Accommodation ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- frommersAttractionId
- Legacy Frommers Attraction ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- frommersDiningId
- Legacy Frommers Dining ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- frommersNightlifeId
- Legacy Frommers Nightlife ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- frommersShoppingId
- Legacy Shopping ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
GET /frommers/location.feed
Location Detail Feed.
Example
- XML
- http://demosite.frommers.biz/frommers/location.feed?locationId=185443
- JSON
- http://demosite.frommers.biz/frommers/location.feed?locationId=185443&feedType=json
Parameters
This feed requires that at least one parameter is provided.
- locationId
- Location ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- whatsonwhenId
- Legacy Whatsonwhen Location ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- whatsonwhenTouristOfficeId
- Legacy Whatsonwhen Tourist Office ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- frommersDestinationId
- Legacy Frommers Destination ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- frommersAccommodationId
- Legacy Frommers Accommodation ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- frommersAttractionId
- Legacy Frommers Attraction ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- frommersDiningId
- Legacy Frommers Dining ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- frommersShoppingId
- Legacy Frommers Shoppping ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
GET /frommers/location_search.feed
Feed to search Locations.
Example
- XML
- http://demosite.frommers.biz/frommers/location_search.feed
- JSON
- http://demosite.frommers.biz/frommers/location_search.feed?feedType=json
Parameters
All the parameters for this feed are optional.
- page
- The page of results to retrieve
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- nPerPage
- Use this to restrict the number of results per page
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- query
- Restrict by free text query
- parentId
- Parent Location ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- type
- Location Type (CONTINENT, SUBCONTINENT, COUNTRY, REGION, STATE, COUNTY, CITY, NEIGHBORHOOD, GROUP_OF_ISLAND, GROUP_OF_ISLAND, ISLAND, PARK, THEME_PARK, TOURIST_OFFICE, POI,HEADLESS_ADDRESS)
- longitude
- Restict results by longitude
- Allowed regex pattern:
[-+]?[0-9]*\.?[0-9]+ - Part of group(s): geocode
- Allowed regex pattern:
- latitude
- Restict results by latitude
- Allowed regex pattern:
[-+]?[0-9]*\.?[0-9]+ - Part of group(s): geocode
- Allowed regex pattern:
- miles
- Restrict results by mile radius
- Allowed regex pattern:
[-+]?[0-9]*\.?[0-9]+ - Part of group(s): geocode
- Allowed regex pattern:
- hasGuide
- Restrict results to only those that have a corresponding guide
- Allowed regex pattern:
true|false
- Allowed regex pattern:
Parameter Groups
When using a parameters that is a member of a group, it is required to include all other group
members in the request.
- geocode
- latitude longitude miles
GET /frommers/main_search.feed
Feed that searches across Events, POIs and Guide Structure content.
Example
- XML
- http://demosite.frommers.biz/frommers/main_search.feed
- JSON
- http://demosite.frommers.biz/frommers/main_search.feed?feedType=json
Parameters
All the parameters for this feed are optional.
- page
- The page of results to retrieve
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- nPerPage
- Use this to restrict the number of results per page
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- query
- Restrict by free text query
- type
- Restrict results by type, either IOI or GUIDE
- subType
- Restrict results by subType. For type=IOI use either EVENT or POI and for type=GUIDE either FROMMERS_GUIDE OR WHATSONWHEN_GUIDE
- audienceInterestId
- Restrict by Audience Interest ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- locationId
- Restrict by Location ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- locQuery
- Restrict by Location name
- mappedLocationType
- Restrict by a mapped location type, eg IATA
- Part of group(s): mapping
- mappedLocationId
- Restrict by a mapped location id, eg LHR
- Part of group(s): mapping
Parameter Groups
When using a parameters that is a member of a group, it is required to include all other group
members in the request.
- mapping
- mappedLocationId mappedLocationType
GET /frommers/media.feed
Media Detail Feed.
Example
- XML
- http://demosite.frommers.biz/frommers/media.feed?mediaId=303692
- JSON
- http://demosite.frommers.biz/frommers/media.feed?mediaId=303692&feedType=json
Parameters
This feed requires that at least one parameter is provided.
- mediaId
- Media Id
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- whatsonwhenId
- Legacy Whatsonwhen Image ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- frommersPhotoId
- Legacy Frommers Photo ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- frommersPodcastAudioId
- Legacy Frommers Podcast Audio ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
GET /frommers/media_search.feed
Example
- XML
- http://demosite.frommers.biz/frommers/media_search.feed
- JSON
- http://demosite.frommers.biz/frommers/media_search.feed?feedType=json
Parameters
All the parameters for this feed are optional.
- page
- The page of results to retrieve
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- nPerPage
- Use this to restrict the number of results per page
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- query
- Restrict by free text query
- type
- Restrict results by image type, (eg I-F100, I-SM, I-BG etc)
- isGuide
- Restrict results to only the destination representative guide image, (eg isGuide=true)
- locationId
- Restrict by Location ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- audienceInterestId
- Restrict by Audience Interest ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- guideStructureId
- Restrict by Guide Structure ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- guideId
- Restrict by Guide ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
GET /frommers/modified_search.feed
Feed to determine which articles have been modified since a given date.
Example
- XML
- http://demosite.frommers.biz/frommers/modified_search.feed?modifiedDate=20100701
- JSON
- http://demosite.frommers.biz/frommers/modified_search.feed?modifiedDate=20100701&feedType=json
Parameters
All the parameters for this feed are optional.
- modifiedDate
- Restict results that have been modified since this date in YYYYMMMDD format.
- Allowed regex pattern:
(19|20)\d\d(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])
- Allowed regex pattern:
GET /frommers/poi_search.feed
Feed to search POIs
Example
- XML
- http://demosite.frommers.biz/frommers/poi_search.feed
- JSON
- http://demosite.frommers.biz/frommers/poi_search.feed?feedType=json
Parameters
All the parameters for this feed are optional.
- type
- Restrict results by type, either NIGHTLIFE, ATTRACTION, SHOPPING
- rankId
- Restrict results to IOIs with a given rank (will take preference over minRankId and maxRankId)
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- minRankId
- Restrict results to IOIs with a minimum rank
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- maxRankId
- Restrict results to IOIs with a maximum rank
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- longitude
- Restict results by longitude
- Allowed regex pattern:
[-+]?[0-9]*\.?[0-9]+ - Part of group(s): geocode
- Allowed regex pattern:
- latitude
- Restrict results by latitude
- Allowed regex pattern:
[-+]?[0-9]*\.?[0-9]+ - Part of group(s): geocode
- Allowed regex pattern:
- miles
- Restrict results by mile radius
- Allowed regex pattern:
[-+]?[0-9]*\.?[0-9]+ - Part of group(s): geocode
- Allowed regex pattern:
- page
- The page of results to retrieve
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- nPerPage
- Use this to restrict the number of results per page
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- query
- Restrict by free text query
- type
- Restrict results by type, either IOI or GUIDE
- subType
- Restrict results by subType. For type=IOI use either EVENT or POI and for type=GUIDE either FROMMERS_GUIDE OR WHATSONWHEN_GUIDE
- audienceInterestId
- Restrict by Audience Interest ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- locationId
- Restrict by Location ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- locQuery
- Restrict by Location name
- mappedLocationType
- Restrict by a mapped location type, eg IATA
- Part of group(s): mapping
- mappedLocationId
- Restrict by a mapped location id, eg LHR
- Part of group(s): mapping
Parameter Groups
When using a parameters that is a member of a group, it is required to include all other group
members in the request.
- geocode
- latitude longitude miles
- mapping
- mappedLocationId mappedLocationType
GET /frommers/slideshow.feed
Slideshow Detail Feed.
Example
- XML
- http://demosite.frommers.biz/frommers/slideshow.feed?mediaId=303692
- JSON
- http://demosite.frommers.biz/frommers/slideshow.feed?mediaId=303692&feedType=json
Parameters
This feed requires that at least one parameter is provided.
- slideshowId
- Slideshow Id
- Allowed regex pattern:
\d+
- Allowed regex pattern:
GET /frommers/slideshow_search.feed
Feed to search SlideShows.
Example
- XML
- http://demosite.frommers.biz/frommers/slideshow_search.feed
- JSON
- http://demosite.frommers.biz/frommers/slideshow_search.feed?feedType=json
Parameters
All the parameters for this feed are optional.
- page
- The page of results to retrieve
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- nPerPage
- Use this to restrict the number of results per page
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- query
- Restrict by free text query
- typeId
- Restrict results by slideshow type id
- typeCd
- Restrict results by slideshow type cd
- frommersPhotoGroupId
- Restrict results by frommers photo group id
- locationId
- Restrict by Location ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- audienceInterestId
- Restrict by Audience Interest ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- guideStructureId
- Restrict by Guide Structure ID
- Allowed regex pattern:
\d+
- Allowed regex pattern:
- guideId
- Restrict by Guide ID
- Allowed regex pattern:
\d+
- Allowed regex pattern: