/guide/search

From EveryTrail API Developer Documentation

Jump to: navigation, search

Contents

URL

/api/guides/search

Semantics

Search for guides on EveryTrail.com

Parameters

Parameter nameParameter formatRequiredDescription
qstringnoThe term to search. The entire string must be present in the title or description for a guide to be returned.
limitintnoThe maximum number of results to return (default is 20)
startintnoThe index of the first guide to return from the result set. (default is 0)
media_filter_modeintnoSee Media Filter Enumeration
activitieslist of ints (comma separated)noa list of activities to search.
latdoublenoThe latitude coordinate to search near
londoublenoThe longitude coordinate to search near
proximitydoublenoThe proximity (in miles) of the trip from the (lat,lon) location.
addressstringnoAn address to search near (when proximity is specified)
min_lengthdoublenoThe minimum length of a trip in meters
max_lengthdoublenoThe maximum length of a trip in meters
durationsbitmasknoA bitwise OR of the durations (see below), default is all
difficultiesbitmasknoA bitwise OR of the difficulties (see below), default is all
options_whitelistbitmasknoA bitwise OR of the other options to include (see below), default is none
options_blacklistbitmasknoA bitwise OR of the other options to not include (see below), default is none
guide_partner_id (guides)intnoID of guide partner. Only guides created by this partner will be returned

Durations

  • 0x0: unknown
  • 0x1: less than 1 hour
  • 0x2: 1-3 hours
  • 0x4: half day
  • 0x8: full day
  • 0x10: multiple days

Difficulties

  • 0x0: unknown
  • 0x1: easy
  • 0x2: moderate
  • 0x4: strenuous

Other Options

Guides contain other option, such as dog friendly, family friendly, bikes allowed, etc.

  • The whitelist signals all options which MUST be present in the returned results (ie, kid friendly)
  • The blacklist signals all options with MUST NOT be present in the returned results (ie horses allowed on trail)


Success Response

<etGuideSearchResponse status="success">
 
  <guides totalCount="" returnedCount="">
    ${guideXML}
  </guides>
</etGuideSearchResponse>

${guideXML} - see Guide XML Format

Error Response

<etGuideSearchResponse status="error">
  ${error response}
</etGuideSearchResponse>

${error response}: See format in Error Reponse Format

Personal tools