This is the main endpoint for Events. There is a GET, POST, PUT. POST and PUT require Oauth while GET requires API key only.

Resource URI

/Events/1

Resource Properties

Parameter	Format	Description	Allows Null
eventID	int	Unique ID for event	no
trailID	int	Unique ID for associated	no
status	string	Deciphers whether the event is Active, Pending or Draft	no
eventImageID	int	Unique ID for image for the event	yes
eventTitle	string	Title of event	no
city	string	City where event is taking place	no
state	string	State where the event is taking place	no
promotedFlag	bool	Deciphers whether the particular event is promoted or not	no
description	string	Details about the event	no
website	string	Website for event	yes
eventCode	string	code for event	yes
eventType	string	Categorizes event between Recreational, Volunteer, and Educational	no
organizerID	int	Unique ID for organizer	yes
submitterID	int	Unique ID for the submitter	no
startDate	date	Date for when the event begins	no
endDate	date	Date for when the event ends	no
tag	string	Set of tags that define the event	yes
directionsParking	string	Description of where the event is	no

Error Responses

Event ID is required
Invalid City
Invalid State
Invalid Zipcode
Invalid City and State combination

HTTP GET

Gets details about the event

JSON Request:

/Trails/6825131/Events/

JSON Response:

{
"city": "Washington",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
"directionsParking": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
"endDate": "2017-04-30 15:52:33Z",
"eventCode": "1",
"eventID": 1,
"eventImgID": 122,
"eventTitle": "Bike To Work DC",
"eventType": "R",
"organizerID": 1,
"promotedFlag": true,
"startDate": "2017-04-28 15:52:33Z",
"state": "DC",
"status": "A",
"submitterID": 9300544,
"tags": [
"bike"
],
"trailID": 6825131,
"website": "dcbikers.org"
}

XML Request:

XML Response:

HTTP POST

Adds new event to the system.

JSON Request:

{
"acctID": 0,
"city": "Potomac",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
"directionsParking": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
"endDate": "2017-07-15 21:00:00Z",
"eventCode": "1",
"eventID": 0,
"eventImgID": 0,
"eventTitle": "DC Ride to Work",
"eventType": "R",
"organizerID": 3,
"promotedFlag": true,
"startDate": "2017-07-15 12:00:00Z",
"state": "MD",
"status": "P",
"submitterID": 0,
"tags": [
"hike",
"run",
"walk"
],
"trailID": 6825131,
"website": "walking.org"
}

JSON Response:

XML Request:

XML Response:

HTTP PUT

Updates existing event and will return true on success and false on failure.

JSON Request:

JSON Response:

true

XML Request:

XML Response:

REST API: Events Set

Operations on the set of events. The Set GET is the search. The GET with the ID will show the event details. The POST is the new event insert.

Resource URI

/Events/?tag=run&api_key=

Set Filters

Parameter	Format	Description	Allows Null
city	string	City where event is held	yes
state	string	State where event is held	yes
zipcode	number	Zipcode where event is held	yes
startDate	date	Date when event begins	no
endDate	date	Date when event ends	yes
keyword	string	Any keywords that may be found in event detail or title	yes
sort	string	Sort by	yes
tag	string	Tags attached to event	yes
promoted	string	Check if event is/is not promoted	yes
status	string	Check if status is Active, Draft, Pending, or Cancelled	yes
start	number	Starting point of the list	yes
rows	number	Top number of rows available	yes

HTTP GET

This is the main search method of events. Searches break down as follows: {city} - All events that are located in this {city}

/Events/?city=Washington&api_key=xxx

{state} - All events in this {state}

/Events/?state=DC&api_key=xxx

{zipcode} - (Requires distance) trail is within that distance miles of that zipcode {zipcode.

/Events/?zipcode=20001&api_key=xxx

{dma} - Search by dma

/Events/?dma=dma&api_key=xxx

{startDate} - The {startDate} of the event and any events after that start on or after that date and within the end date.

/Events/?api_key=xxxs&startDate=01-01-2017

{endDate} - The {endDate} of range from start date. Will find dates within that range

/Events/?api_key=xxxs&endDate=01-01-2017

{keyword} - This finds any keyword in the event title or organizer title.

/Events/?keyword=walking&api_key=xxx

{sort} - This will sort it by alphabetical event name or by state or the start date of the event

/Events/?sort=event_name&api_key=xxx

{tag} This will search the tags of the event for a match.

/Events/?tag=run&api_key=xxx

{promoted} - This will determine if the event is promoted or not by either Y for yes or N for no.

/Events/?promoted=Y&api_key=xxx

{status} - This will search for events with certain statuses such as Active(A) or Cancelled(C).

/Events/?status=A&api_key=xxx

{start}

JSON Request:

Request Body is empty

JSON Response:

XML Request:

XML Response:

HTTP POST

This will add a new event to the system. The result will be a new event ID.

JSON Request:

{
"acctID": 0,
"city": "Potomac",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
"directionsParking": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
"endDate": "2017-07-15 21:00:00Z",
"eventCode": "1",
"eventID": 256,
"eventImgID": 0,
"eventTitle": "5k Run For Cancer Awareness",
"eventType": "V",
"organizerID": 3,
"promotedFlag": true,
"startDate": "2017-07-15 12:00:00Z",
"state": "MD",
"status": "C",
"submitterID": 0,
"tags": [
"hike",
"run",
"walk"
],
"trailID": 6825131,
"website": "walking.org"
}

JSON Response:

XML Request:

XML Response:

HTTP PUT

This will edit the the fields in the event.

JSON Request:

{
"acctID": 0,
"city": "Potomac",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
"directionsParking": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
"endDate": "2017-07-15 21:00:00Z",
"eventCode": "1",
"eventID": 256,
"eventImgID": 0,
"eventTitle": "5k Run For Cancer Awareness",
"eventType": "V",
"organizerID": 3,
"promotedFlag": true,
"startDate": "2017-07-15 12:00:00Z",
"state": "MD",
"status": "C",
"submitterID": 0,
"tags": [
"hike",
"run",
"walk"
],
"trailID": 6825131,
"website": "walking.org"
}

REST API: Events

Resource URI

Resource Properties

Error Responses

HTTP GET

JSON Request:

JSON Response:

XML Request:

XML Response:

HTTP POST

JSON Request:

JSON Response:

XML Request:

XML Response:

HTTP PUT

JSON Request:

JSON Response:

XML Request:

XML Response:

REST API: Events Set

Resource URI

Set Filters

HTTP GET

JSON Request:

JSON Response:

XML Request:

XML Response:

HTTP POST

JSON Request:

JSON Response:

XML Request:

XML Response:

HTTP PUT

JSON Request:

JSON Response:

XML Request:

XML Response:

HTTP DELETE

JSON Request:

JSON Response:

XML Request:

XML Response: