Web Service Documentation

Table of Contents

1. WSDL Location
2. Web Service Querybean Functions
3. Web Service XML Functions

1. WSDL Location

The web service WSDL is located at http://www.theworldsfastestserver.com/webservice/bikedata.cfc?wsdl

2. Web Service Querybean Functions

The following functions all return a querybean object of the requested data.

2.1 GetTripIDs

Arguments:
None.

Returns:
A querybean object containing all trip IDs with the following structure:

Field	Type	Comments
ID	int(10)
trip_type_id	int(10)	References GetTripTypes ID field
name	varchar(32)	Name of trip event (eg. 'XYZ Trade Show'). Can be null.
description	text	Detailed description of event. Can be null.
start_datetime	datetime	UTC date/time that trip recording started
end_datetime	datetime	UTC date/time that trip recording ended

2.2 GetTripTypes

Arguments:
None.

Returns:
A querybean object containing all trip types with the following structure:

Field	Type	Comments
ID	int(10)
name	varchar(32)	The type of trip (Racing, Transit, Trade Show, etc.)

2.3 GetWaypointsForTrip

Attributes:
TripID

Returns:
A querybean object containing 50 GPS waypoints from the specified trip with the following structure:

Field	Type	Comments
ID	bigint(20)
trip_id	int(11)	The id of the trip that this data point belongs to (references GetTripIds).
timestamp	timestamp	Date / time that datapoint is recorded in database.
protocol	char(3)	Source NMEA sentence type.
utc_time	time	Time from GPS data.
utc_date	date	Date from GPS data.
latitude_decimal	double	(eg. 49.943343) - pos / neg determines N/S.
longitude_decimal	double	(eg. -75.323455) - pos / neg determines E/W.
latitude_degrees	smallint(6)	Whole degrees latitude (eg. 49) - always positive.
latitude_minutes	float	Minutes latitude (eg. 94.3343).
north_south	char(1)	'N' or 'S'.
longitude_degrees	smallint(6)	Whole degrees longitude (eg. 75) - always positive.
longitude_minutes	float	Minutes longitude (eg. 32.3455).
east_west	char(1)	'E' or 'W'.
position_fix	tinyint(4)	GPS fix type ('1' - standard GPS, '2' - DGPS, '3' GPS-PPS, '0' - no fix / not recorded).
satellites_used	tinyint(4)	Number of satellites used to get GPS data.
altitude	float	Altitude in Meters.
speed	float	Speed in Knots.
course	float	Compass course in degrees.

2.4 GetAccelForTrip

Attributes:
TripID

Returns:
A querybean object containing 50 accelerometer datapoints from the specified trip with the following structure:

Field	Type	Comments
ID	bigint(20)
trip_id	int(10)	The id of the trip that this data point belongs to (references GetTripIds).
server_clock	double	Epoch time from the data recording server.
utc_date	date	UTC date that data point was collected.
utc_time	time	UTC time that data point was collected.
miliseconds	smallint(6)	milisecond that data point was collected.
axis	tinyint(3)	Axis of acceleration (0 is the x-axis, 1 is the y-axis, and 2 is the z-axis).
value	float	Acceleration value (in g's, -3.1 - +3.1).
timestamp	timestamp	Timestamp data point is inserted into database.

3. Web Service XML Functions

The following functions all return an XML string of the requested data.

3.1 GetTripIDsXML

Arguments:
None.

Returns:
An XML string containing all trip IDs with the following structure:

Field	Type	Comments
ID	int(10>
trip_type_id	int(10)	References GetTripTypes ID field
name	varchar(32)	Name of trip event (eg. 'XYZ Trade Show'). Can be null.
description	text	Detailed description of event. Can be null.
start_datetime	datetime	UTC date/time that trip recording started
end_datetime	datetime	UTC date/time that trip recording ended

3.2 GetTripTypesXML

Arguments:
None.

Returns:
An XML string containing all trip types with the following structure:

Field	Type	Comments
ID	int(10)
name	varchar(32)	The type of trip (Racing, Transit, Trade Show, etc.)

3.3 GetWaypointsForTripXML

Attributes:
TripID

Returns:
An XML string containing 50 GPS waypoints from the specified trip with the following structure:

Field	Type	Comments
ID	bigint(20)
trip_id	int(11)	The id of the trip that this data point belongs to (references GetTripIds).
timestamp	timestamp	Date / time that datapoint is recorded in database.
protocol	char(3)	Source NMEA sentence type.
utc_time	time	Time from GPS data.
utc_date	date	Date from GPS data.
latitude_decimal	double	(eg. 49.943343) - pos / neg determines N/S.
longitude_decimal	double	(eg. -75.323455) - pos / neg determines E/W.
latitude_degrees	smallint(6)	Whole degrees latitude (eg. 49) - always positive.
latitude_minutes	float	Minutes latitude (eg. 94.3343).
north_south	char(1)	'N' or 'S'.
longitude_degrees	smallint(6)	Whole degrees longitude (eg. 75) - always positive.
longitude_minutes	float	Minutes longitude (eg. 32.3455).
east_west	char(1)	'E' or 'W'.
position_fix	tinyint(4)	GPS fix type ('1' - standard GPS, '2' - DGPS, '3' GPS-PPS, '0' - no fix / not recorded).
satellites_used	tinyint(4)	Number of satellites used to get GPS data.
altitude	float	Altitude in Meters.
speed	float	Speed in Knots.
course	float	Compass course in degrees.

3.4 GetAccelForTripXML

Attributes:
TripID

Returns:
An XML string containing 50 accelerometer datapoints from the specified trip with the following structure:

Field	Type	Comments
ID	bigint(20)
trip_id	int(10)	The id of the trip that this data point belongs to (references GetTripIds).
server_clock	double	Epoch time from the data recording server.
utc_date	date	UTC date that data point was collected.
utc_time	time	UTC time that data point was collected.
miliseconds	smallint(6)	milisecond that data point was collected.
axis	tinyint(3)	Axis of acceleration (0 is the x-axis, 1 is the y-axis, and 2 is the z-axis).
value	float	Acceleration value (in g's, -3.1 - +3.1).
timestamp	timestamp	Timestamp data point is inserted into database.