Returns a Json object holding the newly created Event ID and Event Key as well as an array of Proctors that were not allowed to be added to the Event.

Request Information

Route

/api/create

Parameters

Name
Type
Description
title
POST
The title of the new event.
apiKey
POST
The API Key to identify a creator for the new event (API key can be registered here)
startDate
POST
The Start Date of the new event.
endDate
POST
Optional: The End Date of the new event.
open
POST
Optional: Will the event be a open Check In event (no proctor is required). Defaults to False.
checkOut
POST
Optional: Determines if the event will enable attendees to check out. Defaults to False.
proctors
POST
Optional: Array of Proctor NetIDs to be added to the event.

Example Request Data

	[
		'title' => 'First Api Event',
		'apiKey' => 'abcdefghigjlmnopqrstuvwxyz1234',
		'startDate' => ['date' => "yyyy-mm-dd hh:mm:ss"],
		'endDate' => ['date' => "yyyy-mm-dd hh:mm:ss"],
		'open' => false,
		'checkOut' => false,
		'proctors' => [
			'proctor1',
			'proctor2',
		]
	]

Response Information

With missing title

Json Object: {"error":"title is a required parameter"}

With missing startDate

Json Object: {"error":"startDate is a required parameter"}

With incorrect api-key:

Json Object: {"error":"Invalid API Key"}

With missing apiKey

Json Object: {"error":"apiKey is a required parameter"}

Response Body Format

Json Object: 
	{
		"id": 12,
		"key": "ABCD"
	}

or

	{
		"id": 12,
		"key": "ABCD",
		"invalidProctors": [
			"badName1",
			"badName2"
		]
	}