I/O Docs: Interactive API Documentation

• Asset Details

  • List Methods
  • Expand Methods

  • GET Get Asset /resource/assetservice/asset/{assetId}
    Get asset details in XML format

    Parameter	Value	Type	Description
    {assetId}		string	Asset ID

• Asset Reviews

  • List Methods
  • Expand Methods

  • GET Get Asset Review /reviews/asset/{assetId}
    Get asset reviews in XML format

    Parameter	Value	Type	Description
    {assetId}		string	Asset ID

• Assets

  • List Methods
  • Expand Methods

  • GET Search Assets /search/
    Search our database of events and activities using the parameters below.

    Parameter	Value	Type	Description
    v	json xml rss	string	API query response format
    k		string	Search by keywords. The free-form query to search (equivalent to what a user types in the search box on search.active.com).
    l		string	Search by location. To narrow a search to a geographic area, use the “l” parameter to specify a location. Acceptable value formats are as follows: {city,state,country} or {postal code,country} or {state,country} or {postal code} or {state} or {latitude;longitude}. All postal codes and states are for US country only. Do not include brackets { }. Example of lat/lon values: l=32.72195;-117.1612
    r		number	Search by radius in miles. If a location is passed in, a radius can be specified to search as an integer.  If this parameter is not specified, the system uses the default radius of 50 miles.
    m		string	Search by meta data. All the metadata fields for a particular asset are returned when requesting results in xml or json formats.The meta parameter allows filtering based on the metadata of each asset.  To filter on a metadata field, prefix ‘meta:’ to the field name followed by an equal sign and then the value.  The value must be double URL encoded. Do not include the brackets { }. You can filter results using the following fields: {category} and/or {channel}. The following values can be used to filter by category: {activities} or {articles} or {training plans}. The following values can be used to filter by channel: {Baseball} or {Basketball} or {Cycling} or {Outdoors} or {Fishing} or {Football} or {Golf} or {Ice%20Hockey} or {Lacrosse} or {Mountain%20Biking} or {Running} or {Soccer} or {Softball} or {Swimming} or {Tennis} or {Triathlon} or {Volleyball} or {Walking}. For example, to filter your search based on channel, you would specify: meta:channel=Mountain%20Biking. To filter on multiple meta fields, list the meta filters separated by a space: meta:channel=Mountain%20Biking meta:category=activities. When multiple meta filters are passed in, an implicit AND is applied between the filters. A boolean OR can be specified between the meta filters by using the word OR: meta:channel=Mountain%20Biking OR meta:channel=Cycling. To exclude any assets with a meta filter, use the word NOT before the filter: NOT meta:channel=Mountain%20Biking. You can filter the channel to provide more specific results. To do this, use 'splitMediaType' for the meta field. When 'channel=Running', the following values can be used for splitMediaType: {Event} or {Marathon} or {Half%20Marathon} or {5k} or {10k} or {1%20mile} or {5%20mile} or {15k} or {10%20mile} or {Ultra} or {Fun%20Run} or {Kids%20Run} or {Training%20Run} or {Camp} or {Clinic}. When 'channel=triathlon', the following values can be used for splitMediaType: {Event} or {Sprint} or {Kids%20Triathlon} or {Olympic%2FInternational} or {Long%20Course} or {Camp} or {Clinic}. When 'channel=cycling', the following values can be used for splitMediaType: {event}. You can also filter results using the following fields: {daterange} and {lastModifiedDate}. To specify a date range, use the daterange field after the meta filter.  The daterange field takes the format of m=meta:startDate..endDate.  The startDate/endDate values can either be in the format of 'mm/dd/yyyy’ or a natural language word/phrase (e.g. today, tomorrow, etc).  If daterange parameter used, a startDate and/or endDate must be specified. To get Running activities happening in the future: {meta:startDate:daterange:today..} To get Running activities happening before November 1, 2009: meta:startDate:daterange:..11/01/2009+meta:channel=Running. To get Running activities happening between March 1, 2009 and today: meta:startDate:daterange:03/01/2009..today+meta:channel=Running. The 'lastModifiedDate' metadata field is used to indicate when an activity was added or updated in our system.  It is possible to query all running activities added/updated since May 25, 2010. For example: meta:lastModifiedDate:daterange:05%2F25%2F2010.. meta:channel=Running.
    f	activities results training articles	string	Facets of assets. We have several different types of data in the Search index. To restrict a search to a particular type, use the facet parameter. If none specified, the default facet is activities
    s	relevance date_asc date_desc	string	Sort by dates or relevance. If none specified, the default sort for results is by relevance
    num		number	Number of assets to return. To request a different amount, use this parameter with an integer as a value. If none specified, the default number of results returned per page is 25
    page		number	Split results by pages, used in conjunction with the num parameter. For example, to split the results up into pages of 50 results: num=50&page=1. To get the second page of results: num=50&page=2

• 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), ammenities (RV friendly, electricity, hunting, fishing) arrival date and length of stay. 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.
    arvdate		date	Arrival Date - The date in which the camper wants to start camping in mm/dd/yyyy format.
    lengthOfStay		number	Length of Stay - When combined with arvdate, this parameter determines how long the camper would like to reserve 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).
    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) arrival date and length of stay.

    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.
    arvdate		date	Arrival Date - The date in which the camper wants to start camping in mm/dd/yyyy format.
    lengthOfStay		number	Length of Stay - When combined with arvdate, this parameter determines how long the camper would like to reserve 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.