Response Object Reference

This page includes reference information on the objects returned by various nextstop API calls. Please see the nextstop Search API, Place API, or Guide API for more information on when these objects are returned.

Place Summary Object

• name: The name of the place
• permalink: A permanent web address to the nextstop place page.
• apiEndpoint: The API URL through which you can retrieve more information about this place. See the nextstop Place API Reference for more details.
• address: The street address of the place (a single string)
• phone: The main phone number for the place
• website: The official website for the place. Other related websites can be retrieved through the nextstop Place API.
• category [where-to-eat|where-to-stay|what-to-do|where-to-shop]: The high-level categorization of this place.
• locationName: The name of the location (usually city or neighborhood) where this place is located.
• locationUrl: A URL to the nextstop location page where this place is located.
• lat: Latitdue of the place
• lng: Longitude of the place
• geoAccuracy [no-location|area|point]: The accuracy of the latitude and longitude provided. Point accuracy indicates that the lat/lng represents a specifically located point (either a geocode or manually placed by a user). Area accuracy indicates that the lat/lng represents a general area (zip code, neighborhood, city, etc.).
• recommendationsInfo: Contains the count of total recommendations for this place, and a single Recommendation Object for the place. In most cases, the included recommendation will be the highest ranked recommendation for the place (returned as bestRecommendation). When a Place Summary Object is returned from the Guide API, it will instead include the recommendation that is part of that guide (as guideRecommendation).

Guide Object

• name: The name of the guide
• permalink: A permanent web address to the nextstop guide page.
• apiEndpoint: The API URL through which you can retrieve more information about this guide. See the nextstop Guide API Reference for more details.
• guideCoverImageUrl: A single rendered image for the "cover" of the guide.
• lastUpdated: The time at which this guide was last updated.
• locationName: The name of the location (usually city or neighborhood) where this guide is located. This will be the biggest containing location of all the recommendations on the guide.
• locationUrl: A URL to the nextstop location page where this guiod is located.
• guideContent: When called from the Search API, contains the count of total recommendations on the guide. When called from the Guide API, also contains a list of Place Summary Objects in places.

Recommendation Object

• name: The title of the individual recommendation - usually the same as the place name, but may include a more specific recommendation (e.g., Ride the Swan Boats in the Boston Public Gardens).
• permalink: A permanent web address to the nextstop recommendation.
• shortText: The first 160 characters of the recommendation text.
• fullText: Only included when returned as part of a call to the Place or Guide API. Includes the full recommendation text.
• cardImageUrl: A single rendered image for the recommendation in the nextstop "card" style.
• originalImageUrl: The URL to the original image associated with this recommendation.
• largeCachedImageUrl: A 300x300 square cropped & cached version of the original image.
• smallCachedImageURL: A 150x150 square cropped & cached version of the original image.
• originalImageSource: The URL of the containing page of the originalImageUrl that should be linked to as part of the imageAttribution.
• dateCreated: The date the recommendation was created
• authorInfo: Information about the author of the recommendation. See the Author Object reference below.
• onGuide: If the recommendation is part of a guide, includes information about the guide in the form of a Related Guide Object.

Author Object

• authorName: The display name a nextstop user
• authorUrl: The URL to the nextstop user's profile page
• authorPhotoUrl: A 32x32 pixel photo for the user.
• role [owner|editor|can-add]: The "role" of this author in the context in which this object is returned.

Related Guide Object

• name: The name of the guide
• permalink: A permanent web address to the nextstop guide.
• apiEndpoint: The API URL through which you can retrieve more information about this guide. See the nextstop Guide API Reference for more details.

Place Object

A place object may contain all of the fields below, depending on what information is available in the nextstop system about a place, and what options are specified in the call to the Place API. Your application should be prepared to handle empty values for any of the data fields below that begin with may.

Basic Info

Always returned by calls to the Place API

• name: The name of the place
• permalink: A permanent web address to the nextstop place page.
• apiEndpoint: The API URL through which you can retrieve more information about this place. See the nextstop Place API Reference for more details.
• address: The street address of the place (a single string)
• alternateEnglishName: May contain an English version of name if name is in a non-english language.
• alternateEnglishAddress: May contain an English version of address if address is in a non-english language.
• phone: May contain the main phone number for the place.
• hoursInfo: May contain a text string that describes the hours of operation of this business.
• lat: Latitdue of the place
• lng: Longitude of the place
• price [unknown|free|inexpensive|mid-range|high-end]: Contains a price code representing how expensive this place is in relative terms.
• zoomLevel: An integer representing the zoom level that should be used in Google Maps when displaying a map for this place. Valid values are the valid Google Maps zoom levels.
• geoAccuracy [no-location|area|point]: The accuracy of the latitude and longitude provided. Point accuracy indicates that the lat/lng represents a specifically located point (either a geocode or manually placed by a user). Area accuracy indicates that the lat/lng represents a general area (zip code, neighborhood, city, etc.).
• mapType [roadmap|satellite|hybrid]: Contains the preferred Google Maps mode to display this place. This is particularly important for rural recommendations where a street map is not helpful but a satellite view can be.
• lastUpdated: The date on which information about this place was last updated.
• keywords: A comma delimited list of keywords or "tags" that describe this place.
• category [where-to-eat|where-to-stay|what-to-do|where-to-shop]: The high-level categorization of this place.
• locationName: The name of the location (usually city or neighborhood) where this place is located.
• locationUrl: A URL to the nextstop location page where this place is located.
• relatedWebsites: Contains information about websites that may provide more information about this place, including the official and Google Maps place page if available. See the definition of Related Website Object for more information
• recommendationsInfo: Contains the count of total recommendations for this place.

Recommendations Info

Returned when response_data is all_info or recommendations

• recommendationsInfo: Contains the count of total recommendations for this place, and all recommendations for the place as recommendations.

Nearby Places

Returned when response_data is all_info or nearby_places

• nearbyRecommendations: Contains a list of recommended places nearby this place. The number of nearby places is included as count and a list of Place Summary Objects as places.

Similar Places

Returned when response_data is all_info or similar_places

• relatedRecommendations: Contains a list of recommended places recommended by nextstop members who also recommended this place. The number of similar places is included as count and a list of Place Summary Objects as places.

Related Website Object

• title: The title of the webpage
• url: The actual URL to the related page
• shortUrl: A shortened URL, suitable for user display
• type [official-site|google-maps|search-result|other]: The type of this link.