API Documentation (V2): Event • Iowa State University • Attendance Tracking

Events

The Events API allows the retrieval of information pertaining to events.

DESCRIPTION

Returns a list of events associated with the owner of the API Key being used.

PARAMETERS

Header Parameters

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

GET Parameters

Name	Description	Required	Values	Default
start-date	This will filter the events to only those beginning after this date	Optional	Date	NULL
end-date	This will filter the events to only those beginning before this date	Optional	Date	NULL

RESPONSE

Type: application/json

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

Status Code	Detail(s)
200	Successful response
400	Invalid Query Parameter
401	Invalid API key
405	Invalid request HTTP method
429	Too Many Requests

Example Success Response

{
    "links": {
        "self": "https://atrack.its.iastate.edu/api/v2/events"
    },
    "data": [
        {
            "id": "123",
            "type": "event",
            "attributes": {
                "name": "Fake Event #1",
                "createDate": {
                    "date": "2015-08-21 00:00:00.000000",
                    "timezone_type": 3,
                    "timezone": "America/Chicago"
                },
                "startDate": {
                    "date": "2015-10-14 13:30:00.000000",
                    "timezone_type": 3,
                    "timezone": "America/Chicago"
                },
                "endDate": {
                    "date": "2015-10-14 18:00:00.000000",
                    "timezone_type": 3,
                    "timezone": "America/Chicago"
                },
                "key": "ABCD",
                "openCheckIn": true,
                "checkOutEvent": true,
                "counts": {
                    "checkIns": 10,
                    "checkInsUnique": 8,
                    "failures": 2
                }
            }
        },
        {
            "id": "456",
            "type": "event",
            "attributes": {
                "name": "Fake Event #2",
                "createDate": {
                    "date": "2015-09-03 00:00:00.000000",
                    "timezone_type": 3,
                    "timezone": "America/Chicago"
                },
                "startDate": {
                    "date": "2015-10-14 13:30:00.000000",
                    "timezone_type": 3,
                    "timezone": "America/Chicago"
                },
                "endDate": null,
                "key": "EFGH",
                "openCheckIn": false,
                "checkOutEvent": false,
                "counts": {
                    "checkIns": 14,
                    "checkInsUnique": 14,
                    "failures": 0
                }
            }
        }
    ]
}

DESCRIPTION

Creates an event using the provided information.

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
name	The name of the event	Required	String	NULL
startDate	The start date of the event	Required	Date	NULL
endDate	The end date of the event	Optional	Date	NULL
openCheckIn	Whether or not the event requires a proctor	Optional	Boolean	false
checkOutEvent	Whether or not the event allows users to check-out	Optional	Boolean	false
co-owners	Relationship object containing entries for each co-owner, identified by NetID	Optional	Mixed	NULL
proctors	Relationship object containing entries for each proctor, identified by NetID	Optional	Mixed	NULL

Example Post Body

{
    "data": {
        "type": "event",
        "attributes": {
            "name": "New Fake Event",
            "startDate": "2019-03-01 13:30",
            "endDate": "2019-03-02",
            "openCheckIn": true,
            "checkOutEvent": true
        },
        "relationships": {
            "co-owners": {
                "data": [
                    {
                        "id": "coOwner1",
                        "type": "user"
                    },
                    {
                        "id": "invalidCoOwner",
                        "type": "user"
                    }
                ]
            },
            "proctors": {
                "data": [
                    {
                        "id": "proctor1",
                        "type": "user"
                    },
                    {
                        "id": "invalidProctor",
                        "type": "user"
                    },
                    {
                        "id": "proctor2",
                        "type": "user"
                    },
                    {
                        "id": "proctor3",
                        "type": "invalid-type"
                    }
                ]
            }
        }
    }
}

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
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/events"
    },
    "data": {
        "id": "789",
        "type": "event",
        "attributes": {
            "name": "New Fake Event",
            "createDate": {
                "date": "2019-02-15 12:34:56.000000",
                "timezone_type": 3,
                "timezone": "America/Chicago"
            },
            "startDate": {
                "date": "2019-03-01 13:30:00.000000",
                "timezone_type": 3,
                "timezone": "America/Chicago"
            },
            "endDate": {
                "date": "2019-03-02 00:00:00.000000",
                "timezone_type": 3,
                "timezone": "America/Chicago"
            },
            "key": "WXYZ",
            "openCheckIn": true,
            "checkOutEvent": true
        },
        "relationships": {
            "owner": {
                "data": {
                    "id": "creatorNetId",
                    "type": "user"
                }
            },
            "co-owners": {
                "data": [
                    {
                        "id": "coOwner1",
                        "type": "user"
                    }
                ]
            },
            "proctors": {
                "data": [
                    {
                        "id": "proctor1",
                        "type": "user"
                    },
                    {
                        "id": "proctor2",
                        "type": "user"
                    }
                ]
            }
        },
        "links": {
            "self": "https://atrack.its.iastate.edu/api/v2/events/789"
        }
    }
}

DESCRIPTION

Returns information for an event 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 event.	Required	Integer	NULL

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	Event not found
405	Invalid request HTTP method
429	Too Many Requests

Example Success Response

{
    "links": {
        "self": "https://atrack.its.iastate.edu/api/v2/events/123"
    },
    "data": {
        "id": "123",
        "type": "event",
        "attributes": {
            "name": "Fake Event #1",
            "createDate": {
                "date": "2015-08-21 00:00:00.000000",
                "timezone_type": 3,
                "timezone": "America/Chicago"
            },
            "startDate": {
                "date": "2015-10-14 13:30:00.000000",
                "timezone_type": 3,
                "timezone": "America/Chicago"
            },
            "endDate": {
                "date": "2015-10-14 18:00:00.000000",
                "timezone_type": 3,
                "timezone": "America/Chicago"
            },
            "key": "ABCD",
            "openCheckIn": true,
            "checkOutEvent": true,
            "counts": {
                "checkIns": 10,
                "checkInsUnique": 8,
                "failures": 2
            }
        },
        "relationships": {
            "owner": {
                "data": {
                    "id": "creatorNetId",
                    "type": "user"
                }
            },
            "co-owners": {
                "data": [
                    {
                        "id": "coOwner1",
                        "type": "user"
                    }
                ]
            },
            "proctors": {
                "data": [
                    {
                        "id": "proctor1",
                        "type": "user"
                    },
                    {
                        "id": "proctor2",
                        "type": "user"
                    }
                ]
            }
        }
    }
}

DESCRIPTION

Returns attendance information for an event 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 event.	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	Event not found
405	Invalid request HTTP method
429	Too Many Requests

Example Success Response

{
    "links": {
        "self": "https://atrack.its.iastate.edu/api/v2/events/123/attendance"
    },
    "data": [
        {
            "id": "12345",
            "type": "check-in",
            "attributes": {
                "firstName": "Jane",
                "lastName": "Doe",
                "email": "jane-doe-fake@iastate.edu",
                "proctor": null,
                "checkInDate": {
                    "date": "2015-10-14 14:02:19.000000",
                    "timezone_type": 3,
                    "timezone": "America/Chicago"
                },
                "checkOutDate": null,
                "method": "Manual Entry"
            }
        },
        {
            "id": "12362",
            "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"
            }
        }
    ]
}