Returns a Json object containing all events associated with a provided API Key.

Request Information

Route

/api/get-events

Parameters

Name
Type
Description
apiKey
POST
The API Key used to identify the requester (API key can be registered here).
firstDate
POST
Optional: Returns events beginning on or after this date.
lastDate
POST
Optional: Returns events beginning on or before this date.

Example Request Data

	[
		'apiKey' => 'abcdefghigjlmnopqrstuvwxyz1234',
		'firstDate' => ['date' => "yyyy-mm-dd hh:mm:ss"],
		'lastDate' => ['date' => "yyyy-mm-dd hh:mm:ss"]
	]

Response Information

With missing apiKey

Json Object: {"status": "error", "errors": ["apiKey is a required parameter"]}

firstDate is not in the specific format:

Json Object: {"status": "error", "errors": ["firstDate is not formatted correctly"]}

lastDate is not in the specific format:

Json Object: {"status": "error", "errors": ["lastDate is not formatted correctly"]}

With incorrect apiKey:

Json Object: {"status": "error", "errors": ["Invalid API Key"]}

Response Body Format

Json Object: 
{
	"status": "success",
	"data": {
		"events": [
			{
				"id": 12,
				"name": "ABCD",
				"createDate": {
					"date": "2015-12-15 14:00:00.000000",
					"timezone_type": 3,
					"timezone": "America/Chicago"
				},
				"startDate": {
					"date": "2016-05-01 00:00:00.000000",
					"timezone_type": 3,
					"timezone": "America/Chicago"
				},
				"endDate": {
					"date": "2016-10-21 00:00:00.000000",
					"timezone_type": 3,
					"timezone": "America/Chicago"
				},
				"key": "WXYZ",
				"openCheckIn": false,
				"checkOutEvent": false
			},
			{
				"id": 34,
				"name": "EFGH",
				"createDate": {
					"date": "2016-01-05 08:02:16.000000",
					"timezone_type": 3,
					"timezone": "America/Chicago"
				},
				"startDate": {
					"date": "2016-03-15 12:30:00.000000",
					"timezone_type": 3,
					"timezone": "America/Chicago"
				},
				"endDate": null,
				"key": "STUV",
				"openCheckIn": true,
				"checkOutEvent": true
			}
		]
	}
}