DESCRIPTION

Creates a check-in for an event.

PARAMETERS

Header Parameters

Name	Description	Required	Values	Default
X-API-KEY	The API Key to use for this request	Required	String	NULL

POST Parameters

Name	Description	Required	Values	Default
eventId	The ID of the event for the check-in	Required	String	NULL
eventKey	The Key of the event for the check-in	Required	String	NULL
user	The value used to determine the user. Can be a Net-ID, SwipeCard, or ProxCard value.	Required	String	NULL

Example Post Body

{ "data": { "type": "check-in", "attributes": { "eventId": "789", "eventKey": "WXYZ", "user": "fake-net-id" } } }

RESPONSE

Type: application/json

A JSON object that complies with the JSON API standard (www.jsonapi.org).

Status Code	Detail(s)
201	Resource created
400	Invalid Post Data Attribute Required Invalid Attribute
401	Invalid API key
403	Invalid Resource ID
404	Event not found
405	Invalid request HTTP method
409	Invalid Resource Type
429	Too Many Requests

Example Success Response

{ "links": { "self": "https://atrack.its.iastate.edu/api/v2/check-ins" }, "data": { "id": "13579", "type": "check-in", "attributes": { "firstName": "John", "lastName": "Smith", "email": "john-smith-fake@iastate.edu", "proctor": "proctor-net-id", "checkInDate": { "date": "2015-10-14 16:48:29.000000", "timezone_type": 3, "timezone": "America/Chicago" }, "checkOutDate": { "date": "2015-10-14 17:36:01.000000", "timezone_type": 3, "timezone": "America/Chicago" }, "method": "Prox. Card" }, "links": { "self": "https://atrack.its.iastate.edu/api/v2/check-ins/13579" } } }

DESCRIPTION

Returns information for a check-in with the given ID

PARAMETERS

Header Parameters

Name	Description	Required	Values	Default
X-API-KEY	The API Key to use for this request	Required	String	NULL

URI Parameters

Name	Description	Required	Values	Default
id	The ID of the check-in.	Required	Integer	NULL

GET Parameters

Name	Description	Required	Values	Default
additional[]	An array of additional data attributes to include in the response.	Optional	Array ["major", "classification", "college"]	[]

RESPONSE

Type: application/json

A JSON object that complies with the JSON API standard (www.jsonapi.org).

Status Code	Detail(s)
200	Successful response
401	Invalid API key
403	Access Denied
404	Check-in not found
405	Invalid request HTTP method
429	Too Many Requests

Example Success Response

{ "links": { "self": "https://atrack.its.iastate.edu/api/v2/check-ins/13579" }, "data": { "id": "13579", "type": "check-in", "attributes": { "firstName": "John", "lastName": "Smith", "email": "john-smith-fake@iastate.edu", "proctor": "proctor-net-id", "checkInDate": { "date": "2015-10-14 16:48:29.000000", "timezone_type": 3, "timezone": "America/Chicago" }, "checkOutDate": { "date": "2015-10-14 17:36:01.000000", "timezone_type": 3, "timezone": "America/Chicago" }, "method": "Prox. Card" } } }