Events
List Events
get
/api/events
Parameters
count
integer, in query
Number of items per page.
defaults to 20 / min: 1, max: 100
defaults to 20 / min: 1, max: 100
pagination
boolean, in query
Return pagination data.
page
integer, in query
Page number of results.
defaults to 1
defaults to 1
Responses
HTTP code 200
An array of Event objects.
HTTP code 4xx, 5xx
A Fault describing the reason for the error.
List Events by Date
get
/api/events/date/{date}
Parameters
date
required Y-m-d, in path
Date to filter events by.
examples:
examples:
2020
, 2020-01
, 2020-01-24
count
integer, in query
Number of items per page.
defaults to 20 / min: 1, max: 100
defaults to 20 / min: 1, max: 100
pagination
boolean, in query
Return pagination data.
page
integer, in query
Page number of results.
defaults to 1
defaults to 1
Responses
HTTP code 200
An array of Event objects filtered the
date
requested.
HTTP code 4xx, 5xx
A Fault describing the reason for the error.
List Events by Region
get
/api/events/region/{region}
Parameters
region
required string, in uri
Region to filter events by.
options:
options:
east
, west
, southeast
, southcentral
, national
, international
count
integer, in query
Number of items per page.
defaults to 20 / min: 1, max: 100
defaults to 20 / min: 1, max: 100
pagination
boolean, in query
Return pagination data.
page
integer, in query
Page number of results.
defaults to 1
defaults to 1
Responses
HTTP code 200
An array of Event objects filtered the
region
requested.
HTTP code 4xx, 5xx
A Fault describing the reason for the error.
List Events by State
get
/api/events/state/{state}
Parameters
state
required string, in uri
State abbriviation to filter events by.
count
integer, in query
Number of items per page.
defaults to 20 / min: 1, max: 100
defaults to 20 / min: 1, max: 100
pagination
boolean, in query
Return pagination data.
page
integer, in query
Page number of results.
defaults to 1
defaults to 1
Responses
HTTP code 200
An array of Event objects filtered the
date
requested.
HTTP code 4xx, 5xx
A Fault describing the reason for the error.