/guide/search
From EveryTrail API Developer Documentation
Contents |
URL
/api/guides/search
Semantics
Search for guides on EveryTrail.com
Parameters
| Parameter name | Parameter format | Required | Description |
|---|---|---|---|
| q | string | no | The term to search. The entire string must be present in the title or description for a guide to be returned. |
| limit | int | no | The maximum number of results to return (default is 20) |
| start | int | no | The index of the first guide to return from the result set. (default is 0) |
| media_filter_mode | int | no | See Media Filter Enumeration |
| activities | list of ints (comma separated) | no | a list of activities to search. |
| lat | double | no | The latitude coordinate to search near |
| lon | double | no | The longitude coordinate to search near |
| proximity | double | no | The proximity (in miles) of the trip from the (lat,lon) location. |
| address | string | no | An address to search near (when proximity is specified) |
| min_length | double | no | The minimum length of a trip in meters |
| max_length | double | no | The maximum length of a trip in meters |
| durations | bitmask | no | A bitwise OR of the durations (see below), default is all |
| difficulties | bitmask | no | A bitwise OR of the difficulties (see below), default is all |
| options_whitelist | bitmask | no | A bitwise OR of the other options to include (see below), default is none |
| options_blacklist | bitmask | no | A bitwise OR of the other options to not include (see below), default is none |
| guide_partner_id (guides) | int | no | ID 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
