BuckeyeTraffic.org API Documentation

Welcome to the API documentation for BuckeyeTraffic.org. BuckeyeTraffic.org provides all public data displayed on our website in easy-to-use XML formats for third party web application developers to utilize in their own sites. The following documentation describes how to properly access this data and the different structure that it comes in.

This documentation and the BuckeyeTraffic.org API is a work in progress and may not conform to the exact specifications this document lays out.

Camera Sites

The Camera Site data is accessed from http://www.buckeyetraffic.org/services/Cameras.aspx. Each Camera Site contains a textual location attribute, a latitude and longitude value and a collection of Camera Feeds. The data is returned in the following format:

	
<CameraSites>
	<CameraSite>
		<Location>I77 Southbound  at I480 In Cleveland</Location>
		<Latitude>41.4070</Latitude>
		<Longitude>-81.6467</Longitude>
		<CameraFeeds>
			<CameraFeed>
				<Direction>South</Direction>
				<Type>Fixed</Type>
				<Description>
					I77 Southbound  at I480 In Cleveland
				</Description>
				<SmallImage>
					http://cmhimg01.dot.state.oh.us/images/cleveland-i77-sb.jpg
				</SmallImage>
				<LargeImage>
					http://cmhimg01.dot.state.oh.us/images/cleveland-i77-sb.jpg
				</LargeImage>
				<ImageUpdateInterval>0</ImageUpdateInterval>
			</CameraFeed>
			<CameraFeed>
				<Direction>South</Direction>
				<Type>Fixed</Type>
				<Description>
					I77 Southbound  at I480 In Cleveland Large
				</Description>
				<SmallImage>
					http://cmhimg01.dot.state.oh.us/images/cleveland-i77-sb.jpg
				</SmallImage>
				<LargeImage>
					http://cmhimg01.dot.state.oh.us/images/cleveland-i77-sb-large.jpg
				</LargeImage>
				<ImageUpdateInterval>0</ImageUpdateInterval>
			</CameraFeed>
		</CameraFeeds>
	</CameraSite>
.
.
.
.
</CameraSites>

Field Descriptions

Attribute Type Description

Camera Site Attributes
Location string A textual description of the location of the camera site.

Latitude decimal The latitude location of the camera site.

Longitude decimal The longitude of the camera site.

Camera Feed Attributes

Direction string The direction the camera is directed. Possible values: North, South, East, West, Southeast, Northeast, Northwest, Southwest

Type string The type of camera feed this is. Possible values: Fixed, Pan/Tilt/Zoom, Other

Description string A description of where the camera feed is pointed.

SmallUrl string The url of the small camera feed image.

LargeUrl string The url of the large camera feed image.

UpdateInterval integer The time, in seconds, it takes for a camera feed image to refresh.

Attribute	Type	Description
Camera Site Attributes
Location	string	A textual description of the location of the camera site.
Latitude	decimal	The latitude location of the camera site.
Longitude	decimal	The longitude of the camera site.
Camera Feed Attributes
Direction	string	The direction the camera is directed. Possible values: North, South, East, West, Southeast, Northeast, Northwest, Southwest
Type	string	The type of camera feed this is. Possible values: Fixed, Pan/Tilt/Zoom, Other
Description	string	A description of where the camera feed is pointed.
SmallUrl	string	The url of the small camera feed image.
LargeUrl	string	The url of the large camera feed image.
UpdateInterval	integer	The time, in seconds, it takes for a camera feed image to refresh.

Road Activity

The Road Activity data is accessed from http://www.buckeyetraffic.org/services/RoadActivity.aspx. The returned Road Activity XML file will be in the following format:

<RoadActivities>
	<RoadActivity>
		<Id>ROAD_ACTIVITY_ID_000000000000001</Id>
		<Category>Accident</Category>
		<Status>Closed</Status>
		<Direction>EASTBOUND</Direction>
		<Road>I-70</Road>
		<CountyCode>FRA</CountyCode>
		<DistrictNumber>6</DistrictNumber>
		<Latitude>39.934190</Latitude>
		<Longitude>-82.854799</Longitude>
		<ActivityStartDateTime>5/21/2007 9:00:00 PM</ActivityStartDateTime>
		<ActivityEndDateTime>10/3/2007 8:00:00 AM</ActivityEndDateTime>
		<ActivityCreationDateTime>5/17/2007 9:42:00 AM</ActivityCreationDateTime>
		<ActivityLastModifiedDateTime>6/18/2007 3:12:00 PM</ActivityLastModifiedDateTime>
		<StartMile>100</StartMile>
		<StartMileDescription>I-70 / I-71 split</StartMileDescription>
		<EndMile>103.5</EndMile>
		<EndMileDescription>Alum Creek Dr. Exit</EndMileDescription>
		<Description>
			Description
		</Description>
		<DetourDescription>
			Detour description
		</DetourDescription>
		<Contact>
			<FirstName>John</FirstName>
			<LastName>Doe</LastName>
			<Email>john.doe@dot.state.oh.us</Email>
			<Phone>(614) 1111111</Phone>
			<ProjectURL>http://dot.state.oh.us</ProjectURL>
		</Contact>
	</RoadActivity>	
	.
	.
	.
</RoadActivitie>

Attribute Type Description

Id string A random 32-character string used to uniquely identify the Road Activity.

Category string This represents the category of the road activity. Possible values are: Accident, Roadwork - Planned, Roadwork - Unplanned, Flooding, Snow/Ice, Debris, Disabled Vehicle and Other.

Status string This is a textual description of the road. Possible values are: Open, Closed, Restricted.

Direction string The direction the road activity is happening in. Possible values include: EASTBOUND, NORTHBOUND, SOUTHBOUND, WESTBOUND.

Road string The state route name of the road.

CountyCode string A three digit code that represents the county of the road activity.

DistrictNumber integer An integer between 1 and 12 that represents the road activities district.

Latitude decimal The latitude of the road activity.

Longitude decimal The longitude of the road activity.

ActivityStartDateTime datetime The date and time the road activity began.

ActivityEndDateTime datetime An estimated date and time when the road activity will end.

ActivityCreationDateTime datetime The date and time the road activity entry was created.

ActivityLastModifiedDateTime datetime The date and time the road activity entry was last modified.

StartMile integer The mile on the route at which the road activity begins.

StartMileDescription string A description of the location of the start mile.

EndMile integer The mile on the route at which the road activty ends.

EndMileDescription string A description of the location of the end mile.

Description string A general description of this road activity.

DetourDescription string A description of any detours associated with this road activity.

Road Activity Contact

FirstName string The first name of the person handling public communication for this road activity.

LastName string The last name of the person handling public communication for this road activity.

Email string The email address of the person responsible for public communication regarding this project.

ProjectURL string The website URL for this specific road activity (if any).

Attribute	Type	Description
Id	string	A random 32-character string used to uniquely identify the Road Activity.
Category	string	This represents the category of the road activity. Possible values are: Accident, Roadwork - Planned, Roadwork - Unplanned, Flooding, Snow/Ice, Debris, Disabled Vehicle and Other.
Status	string	This is a textual description of the road. Possible values are: Open, Closed, Restricted.
Direction	string	The direction the road activity is happening in. Possible values include: EASTBOUND, NORTHBOUND, SOUTHBOUND, WESTBOUND.
Road	string	The state route name of the road.
CountyCode	string	A three digit code that represents the county of the road activity.
DistrictNumber	integer	An integer between 1 and 12 that represents the road activities district.
Latitude	decimal	The latitude of the road activity.
Longitude	decimal	The longitude of the road activity.
ActivityStartDateTime	datetime	The date and time the road activity began.
ActivityEndDateTime	datetime	An estimated date and time when the road activity will end.
ActivityCreationDateTime	datetime	The date and time the road activity entry was created.
ActivityLastModifiedDateTime	datetime	The date and time the road activity entry was last modified.
StartMile	integer	The mile on the route at which the road activity begins.
StartMileDescription	string	A description of the location of the start mile.
EndMile	integer	The mile on the route at which the road activty ends.
EndMileDescription	string	A description of the location of the end mile.
Description	string	A general description of this road activity.
DetourDescription	string	A description of any detours associated with this road activity.
Road Activity Contact
FirstName	string	The first name of the person handling public communication for this road activity.
LastName	string	The last name of the person handling public communication for this road activity.
Email	string	The email address of the person responsible for public communication regarding this project.
ProjectURL	string	The website URL for this specific road activity (if any).