I/O Docs: Interactive API Documentation

OAuth 2.0 Flow: Select OAuth 2.0 Flow

Existing Client Credentials: Manual Input

API Key:

App/Key: Select Application Key Manually provide key information

Shared Secret:

Client ID:

Client Secret: Authorize

Client ID: Get Access Token

Client ID:

Client Secret:

---

Username:

Password: Get Access Token

Client ID:

Client Secret: Get Access Token

Authorization Code: Get Access Token

Access Token:

Username:

Password:

Username:

Binary Security Token:

Username:

Password:

• Assets

  • List Methods
  • Expand Methods

  • GET Search Assets /search/

    Search our database of events and activities using the parameters below.

    Parameter	Value	Type	Description
    near		string	A string naming a place that can be geocoded. If the near string is not geocodable, returns a failed geocoded error. Example: near=San%20Diego,CA,US
    lat_lon		string	A location specified as a latitude and longitude separated by a comma. Example: lat_lon=43.2,-118
    bbox		string	A bounding box specified by the lat/lng of the northwest and southeast corners separated by a semi-colon. Example: bbox=40.73,-74.1;40.717,-73.-99
    geo_points		string	A list of lat/long pairs separated by a url encoded semi-colon. This limits the result list to assets that fall within the polygon of points. Example: geo_points=40,-70%3B30,-80%3B20,-90
    radius		number	The search radius as specified in miles. Example: radius=50
    city		string	Matches assets by city name. Example: city=san+diego
    state		string	Matches assets by state or province code. Example: state=CA
    zip		string	Matches assets by zip or postal code. Example: zip=92101
    country		string	Matches assets by country name. Example: country=United%20States
    query		string	Search by keywords. The free-form query to search (equivalent to what a user types in the search box on search.active.com). Example: query=marathon
    kids		string	Returns only results for kids events. Setting to 'true' returns kids events with ACTIVEkids.com URLs.
    current_page		number	The current page of results. Defaults to 1. Example: current_page=1
    per_page		number	The number of results to return. Defaults to 10. Example: per_page=50
    sort	distance date_asc date_desc	string	The sort order of the results. The possible values are date_asc, date_desc, and distance. If sort is not specified, results are sort by relevance to the query param. Distance can only be used when either the near or lat_lon parameters are specified and sorts the results according to distance from the specified location smallest to largest. Example: sort=date_asc
    facets		string	A comma delimited string containing the facet counts to return. It will bring all values for a particular field that show up in your result set. In the example below, you will get a break down of all the category names present in your search for tinker bell half marathon. Example: query=tinker%20bell%20half%20marathon&facets=categoryName
    facet_values		string	Returns facet counts for the specified field values. The value of the param is the field name followed by a comma delimited list of values. The field name and values are separated by a pipe It will bring back the facet count for a specific field and its value. In the example below, you will get the total count of assets that have a category name of event for your search of tinker bell half marathon. Example: query=tinker%20bell%20half%20marathon&facet_values=categoryName:event
    category		string	Matches assets by category name. List of categories can be found here: http://api.amp.active.com/v2/assets/categories
    topic		string	Matches assets by topic name. List of topics can be found here: http://api.amp.active.com/v2/assets/topics
    start_date		string	Limits results to assets with a start date in the given range. See http://developer.active.com/docs/v2_activity_api_search#ranges for accepted formats
    end_date		string	Limits results to assets with an end date in the given range. See http://developer.active.com/docs/v2_activity_api_search#ranges for accepted formats
    cb		string	JSONP callback parameter. This defines the delegated method to execute when the call is returned.
    assetGuid		string	Filters results to a specific asset.
    exclude_children	true false	string	Removes children assets from the results list. Valid values are true or false. If the parameter is not present, all assets will be returned in the results list.
    exists		string	Filters results to assets that have a value for the specified field(s). The value of the param is a comma-delimited of fields. Example: exists=asset.authorName
    not_exists		string	Filters results to assets that do not have a value for the specified field(s). The value of the param is a comma-delimited of fields. Example: not_exists=asset.authorName

• Assets

  • List Methods
  • Expand Methods

  • GET Search Campgrounds /camping/campgrounds/

    The Campground Search API processes HTTP GET requests and returns results in XML format. It is designed to return campground data matching a set of filters, such as state, name, features (fishing, hunting, golf) and ammenities (RV friendly, electricity, hunting, fishing). This API searches metadata from 97% of the national and state parks in the United States and Canada.

    Parameter	Value	Type	Description
    pstate		string	State or Province - The two character abbreviation for US state http://www.usps.com/ncsc/lookups/usps_abbreviations.html, Canadian province or territory http://canadaonline.about.com/library/bl/blpabb.htm.
    pname		string	Park Name - The name of the park. When this parameter is specified, the API performs a string-match query for parks containing the character string specified.
    siteType	2001 10001 2003 2002 9002 9001 3001 2004	number	Site Type - Type of site you wish to search for. The following types are supported: RV Sites (2001), Cabins or Lodgings (10001), Tent (2003), Trailer (2002), Group Site (9002), Day Use (9001), Horse Site (3001), Boat Site (2004).
    amenity	4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 2013	number	Campground Feature - There are all sorts of things to do at campgrounds. Specifying amenity=4004, for example, returns campgrounds with fishing. Only one amenity can be specified per query. The following is a list of valid amenity codes: Biking (4001), Boating (4002), Equipment Rental (4003), Fishing (4004), Golf (4005), Hiking (4006), Horseback Riding (4007), Hunting (4008), Recreational Activities (4009), Scenic Trails (4010), Sports (4011), Beach/Water Activities (4012), Winter Activities (4013).
    eqplen		number	Equipment Length - If the camper wants to find campgrounds where his 50 foot RV will fit, issue a query where eqplen=50:
    Maxpeople		string	Number of campers - Looking for campgrounds with sites that will fit up to 8 people?
    hookup	3002 3003 3004 3005	string	Electric Hookup - 15 Amps or More (3002), 20 Amps or More (3003), 30 Amps or More (3004), 50 Amps or More (3005).
    sewer	3007	string	Sewer Hookup - Specify &sewer=3007 to search for campgrounds with sewer hookups.
    water	3006	string	Water Hookup - Specify &water=3006 to search for campgrounds with water hookups.
    pull	3008	string	Pull Through Driveway - Specify &pull=3008 to search for campgrounds with pull through driveways.
    pets	3010	string	Pets Allowed - Specify &pets=3010 to search for campgrounds where pets are allowed.
    waterfront	3011	string	Waterfront Sites - Specify &waterfront=3011 to search for campgrounds with waterfront campsites.
    landmarkLat		string	Parameter allows for campground searches around a fixed geo-point. Used in conjuction with landmarkLong. Also, the landmarkName=true parameter/value must be supplied when doing this query. Results are sorted by distance from the geo-point, with the closest campground being the first result.
    landmarkLong		string	Parameter allows for campground searches around a fixed geo-point. Used in conjuction with landmarkLat. Also, the landmarkName=true parameter/value must be supplied when doing this query. Results are sorted by distance from the geo-point, with the closest campground being the first result.
    landmarkName		string	Parameter allows for campground searches around a fixed geo-point. Must be used with landmarkLat and landmarkLong.

  • GET Campground Details /camping/campground/details

    The Campground Details API provides a rich set of metadata about a given campground. This includes a detailed description, often authored by park rangers, and a comprehensive list of ammenities.

    Parameter	Value	Type	Description
    contractCode		string	STATE, FEDERAL or PRIVATE - contractCode is a syonym for contractID, which is what is returned by the Campground Search API. It specifies the jurisdiction for the campground. This parameter must be used in conjuction with parkId.
    parkId		number	Facility ID - parkId is a synonym for facilityID, which is returned by the Campground Search API. It is a unique identifier for the campground.

  • GET Search Campsites /camping/campsites/

    The Campsite Search API is designed to return information about campsites within a given campground that match a set of filters like ammenities (RV friendly, electricity, hunting, fishing) and maximum occupants.

    Parameter	Value	Type	Description
    contractCode		string	STATE, FEDERAL or PRIVATE - contractCode is a syonym for contractID, which is what is returned by the Campground Search API. It specifies the jurisdiction for the campground. This parameter must be used in conjuction with parkId.
    parkId		number	Facility ID - parkId is a synonym for facilityID, which is returned by the Campground Search API. It is a unique identifier for the campground.
    siteType	2001 10001 2003 2002 9002 9001 3001 2004	number	Site Type - Type of site you wish to search for. The following types are supported: RV Sites (2001), Cabins or Lodgings (10001), Tent (2003), Trailer (2002), Group Site (9002), Day Use (9001), Horse Site (3001), Boat Site (2004).
    eqplen		number	Equipment Length - If the camper wants to find campgrounds where his 50 foot RV will fit, issue a query where eqplen=50:
    Maxpeople		string	Number of campers - Looking for campgrounds with sites that will fit up to 8 people?
    hookup	3002 3003 3004 3005	string	Electric Hookup - 15 Amps or More (3002), 20 Amps or More (3003), 30 Amps or More (3004), 50 Amps or More (3005).
    sewer	3007	string	Sewer Hookup - Specify &sewer=3007 to search for campgrounds with sewer hookups.
    water	3006	string	Water Hookup - Specify &water=3006 to search for campgrounds with water hookups.
    pull	3008	string	Pull Through Driveway - Specify &pull=3008 to search for campgrounds with pull through driveways.
    pets	3010	string	Pets Allowed - Specify &pets=3010 to search for campgrounds where pets are allowed.
    waterfront	3011	string	Waterfront Sites - Specify &waterfront=3011 to search for campgrounds with waterfront campsites.