Checks a user into the given event, or out if they're already checked in and the event is configured for check ins. Returns a Json object confirming or denying if a person was successfully checked in/out of the given event, and the time.
Request Information
Route
/api/check-in
Parameters
Example Request Data
[ 'eventId' => 1234, 'eventKey' => 'ABCD', 'apiKey' => 'abcdefghigjlmnopqrstuvwxyz1234', 'user' => 'fake-netid@iastate.edu' ]
Response Information
With missing eventId
Json Object: {"status": "error", "errors": ["eventId is a required parameter"]}
With missing eventKey
Json Object: {"status": "error", "errors": ["eventKey is a required parameter"]}
With missing apiKey
Json Object: {"status": "error", "errors": ["apiKey is a required parameter"]}
With missing user:
Json Object: {"status": "error", "errors": ["user is a required parameter"]}
With incorrect apiKey:
Json Object: {"status": "error", "errors": ["Invalid API Key"]}
With eventId and eventKey that do not correlate:
Json Object: {"status": "error", "errors": ["There is no event with the given eventId and eventKey"]}
With user data that is a non-ISU email:
Json Object: {"status": "error", "errors": ["API does not support non-ISU emails"]}
With user data that doesn't match an ISU person:
Json Object: {"status": "error", "errors": ["Unable to find the given user"]}
Response Body Format
Json Object:{ "status": "success", "data": { "type": "in", "time": "1993-07-31 11:00:00" } }
Return Item Options
"type""type": "in"
or
"type": "out"