Tracking Protocol - Revision history

Thomas at 09:22, 6 August 2010

2010-08-06T09:22:34Z

← Older revision		Revision as of 09:22, 6 August 2010
Line 82:		Line 82:

	'''Returns:'''		'''Returns:'''

	Returns a list of available competitions on this server.		Returns a list of available competitions on this server.

	Example:		Example:

Line 107:		Line 109:

	'''Command:'''		'''Command:'''

	getcontestinfo.php		getcontestinfo.php

Line 117:		Line 120:

	'''Returns:'''		'''Returns:'''

	If no date is given, a list of the available contest days is returned like this:		If no date is given, a list of the available contest days is returned like this:

Thomas at 09:21, 6 August 2010

2010-08-06T09:21:07Z

@@ Line 68: / Line 68: @@
 * ''date'' Server date: YYYYMMDD
 * ''time'' Server time in seconds since 1/1 1970
 [[Category:Tracking]]

Thomas at 09:13, 6 August 2010

2010-08-06T09:13:36Z

← Older revision		Revision as of 09:13, 6 August 2010
Line 50:		Line 50:
	server time of the tracking server.		server time of the tracking server.

	Command:		'''Command:'''

	getprotocolinfo.php		getprotocolinfo.php

	Parameters:		'''Parameters:'''

	username=<user name>		username=<user name>
	cpassword=<encrypted password>		cpassword=<encrypted password>

	Returns:		'''Returns:'''

	{version}1.3{/version}{date}20080811{/date}{time}1218457469{/time}		{version}1.3{/version}{date}20080811{/date}{time}1218457469{/time}

	Tags:		'''Tags:'''

	* 'version' Version number string. Should be 1.3 to be in compliance with this document.		* ''version'' Version number string. Should be 1.3 to be in compliance with this document.
	* ''date'' Server date: YYYYMMDD		* ''date'' Server date: YYYYMMDD
	* time Server time in seconds since 1/1 1970		* ''time'' Server time in seconds since 1/1 1970


	[[Category:Tracking]]		[[Category:Tracking]]

Thomas at 09:13, 6 August 2010

2010-08-06T09:13:00Z

← Older revision		Revision as of 09:13, 6 August 2010
Line 63:		Line 63:
	Tags:		Tags:

	* version Version number string. Should be 1.3 to be in compliance with this document.		* 'version' Version number string. Should be 1.3 to be in compliance with this document.
	* date Server date: YYYYMMDD		* ''date'' Server date: YYYYMMDD
	* time Server time in seconds since 1/1 1970		* time Server time in seconds since 1/1 1970


	[[Category:Tracking]]		[[Category:Tracking]]

Thomas at 09:12, 6 August 2010

2010-08-06T09:12:39Z

← Older revision		Revision as of 09:12, 6 August 2010
Line 63:		Line 63:
	Tags:		Tags:

	* version Version number string. Should be 1.3 to be in compliance with this document.		* version Version number string. Should be 1.3 to be in compliance with this document.
	* date Server date: YYYYMMDD		* date Server date: YYYYMMDD
	* time Server time in seconds since 1/1 1970		* time Server time in seconds since 1/1 1970


	[[Category:Tracking]]		[[Category:Tracking]]

Thomas at 09:12, 6 August 2010

2010-08-06T09:12:21Z

@@ Line 42: / Line 42: @@
 need to encrypt the clear text password with the same hash string (username) and compare the two
 encrypted passwords.
 [[Category:Tracking]]

Thomas at 09:11, 6 August 2010

2010-08-06T09:11:14Z

← Older revision		Revision as of 09:11, 6 August 2010
Line 8:		Line 8:
	Here is a schematic illustration of a typical tracking session:		Here is a schematic illustration of a typical tracking session:

	[[file:tracking.png\|~~500px~~]]		[[file:tracking.png\|800px]]

	= Protocol =		= Protocol =

Thomas at 08:59, 6 August 2010

2010-08-06T08:59:04Z

← Older revision		Revision as of 08:59, 6 August 2010
Line 8:		Line 8:
	Here is a schematic illustration of a typical tracking session:		Here is a schematic illustration of a typical tracking session:

	[file:tracking.png\|500px]		[[file:tracking.png\|500px]]

	= Protocol =		= Protocol =

Thomas at 08:58, 6 August 2010

2010-08-06T08:58:47Z

← Older revision		Revision as of 08:58, 6 August 2010
Line 1:		Line 1:

	= Introduction =		= Introduction =
	The Silent Wings Viewer protocol is an HTTP based protocol with a set of commands that match a set		The Silent Wings Viewer protocol is an HTTP based protocol with a set of commands that match a set
Line 9:		Line 8:
	Here is a schematic illustration of a typical tracking session:		Here is a schematic illustration of a typical tracking session:

	[~~image~~:tracking.png\|500px]		[file:tracking.png\|500px]

	= Protocol =		= Protocol =

Thomas: Created page with ' = Introduction = The Silent Wings Viewer protocol is an HTTP based protocol with a set of commands that match a set of URL's with parameters that typically correspond to a set o…'

2010-08-06T08:58:06Z

Created page with ' = Introduction = The Silent Wings Viewer protocol is an HTTP based protocol with a set of commands that match a set of URL's with parameters that typically correspond to a set o…'

New page

= Introduction =
The Silent Wings Viewer protocol is an HTTP based protocol with a set of commands that match a set
of URL's with parameters that typically correspond to a set of PHP scripts.
There are generally two phases of the tracking protocol, first initialization where the client sets up the
tracking for a given competition day based on input from the user. The next phase is the actual tracking
where the client requests fix data from the tracking server at regular intervals.

Here is a schematic illustration of a typical tracking session:

[image:tracking.png|500px]

= Protocol =
The following section contains a description of the available protocol commands used by the viewer client.

The general format for each command is:

http://server/command.php?param1=foo&param2=bar

etc.

Most of the commands return a series of tags much like HTML tags, only with curly brackets instead of
angle brackets. For example:

getprotocolinfo.php?username=jane&cpassword=87f89daecd2dbe1bc62bb2f20bb81f55

returns:

{version}1.3{/version}{date}20080811{/date}{time}1218457469{/time}

== Authentication ==
Most of the commands require a user name and password as input. These are specified in the
username/password parameters:

http://tracking.silentwings.no//getactivecontests.php?username=john&cpassword=85f8addecd2dbf8bc62bb0f20bb31f51&version=1.2

The password should be given in encrypted form. The password is encrypted with user name as
«encryption salt», i.e as the MD5 digest of the following string:

<password><username>

There should be no whitespace between the clear text password and the username. To authenticate you
need to encrypt the clear text password with the same hash string (username) and compare the two
encrypted passwords.

[[Category:Tracking]]