<pre><b>Knowmore.org Corporate Statistics API BETA ERROR: API Documentation/Help</b>


The Knowmore.org Firefox Extension (rolls off the tongue, right?) has made its internal API available
for public use. This page was generated automatically due to a error in your call.
The Knowmore.org Firefox Extension API is considered to be BETA and is made available
without any sort of warranty, implied or otherwise.

Temporarily, additional modules can be requested at smirkingsisyphus at gmail dot com with
the subject 'Knowmore.org API Module Request'


<b>[API Parameters]</b>
	<b>request</b>	 The core of any API call. If it is excluded from the request, an eventually 
		 helpful error message is generated.
	<b>format</b>	 Optional parameter for the format of the response or output, unknown or 
		 unspecified format values are defaulted to JSON 
<b>[request=profile]</b>
	<b>Description</b>
	The 'profile' request will return an entire company profile for each company
	that matches the query. The data can be filtered through various parameters
	all of which are detailed below (sort of).<br />

	<b>Parameters</b>
	company     	A company name, partial matches available [string]
	from     	A date in the form of YYYYMMDD or YYYY-MM-DD, like 20080506.
			Will match any company profile that has been updated on or after
			the selected date [formatted integer]
	url     	A URL, partial matches available, in the format http://www.example.com [formatted string]
	flag     	A data flag used to filter profiles, currently for semi-internal use [char]
	human     	Human rights rating, 1-3 [integer]
	worker     	Workers' rights rating, 1-3 [integer]
	enviro     	Environmental rating, 1-3 [integer]
	politics     	Political impact rating, 1-3 [integer]
	ethics     	Business ethics rating, 1-3.[integer]
	limit     	Number of profiles to return [integer]

	<b>Examples</b>
	<span style='color:blue'>api.php?request=profile</span>
	Returns all available profiles from the Knowmore.org Firefox Extension pool.

	<span style='color: blue'>api.php?request=profile&flag=e&from=20080506</span>
	This query returns all profiles marked with the 'e' data flag updated on or after May 6th, 2008


<b>[request=companyUrl]</b>
	<b>Description</b>
	The 'companyUrl' request returns a list of associated URLs for a certain company

	<b>Parameters</b>
	company     	A company name, partial matches available [string]
	from     	A date in the form of YYYYMMDD or YYYY-MM-DD, like 20080506.
			Will match any company profile that has been updated on or after
			the selected date [formatted integer]
	flag     	A data flag used to filter profiles, currently for semi-internal use [char]
	human     	Human rights rating, 1-3 [integer]
	worker     	Workers' rights rating, 1-3 [integer]
	enviro     	Environmental rating, 1-3 [integer]
	politics     	Political impact rating, 1-3 [integer]
	ethics     	Business ethics rating, 1-3.[integer]

	<b>Examples</b>
	<span style='color:blue'>api.php?request=companyUrl</span>
	Returns a list of company names and associated URLs from the Knowmore.org Firefox Extension pool.

	<span style='color: blue'>api.php?request=companyUrl&company=Wal-Mart</span>
	Returns a list of Wal-Mart's associated URLs

	<span style='color: blue'>api.php?request=companyUrl&human=1</span>
	Returns a list of companies and their associated URLs that have a Human Rights rating of 1 (poor)

<b>[request=ratings]</b>
	<b>Description</b>
	The 'ratings' request returns the Knowmore.org ratings for a requested company

	<b>Parameters</b>
	company     	A company name, partial matches available [string]
	from     	A date in the form of YYYYMMDD or YYYY-MM-DD, like 20080506.
			Will match any company profile that has been updated on or after
			the selected date [formatted integer]
	url     	A URL, partial matches available, in the format http://www.example.com [formatted string]
	kmurl     	The Knowmore.org url for a company, in the format of
			http://www.knowmore.org/wiki/index.php?title=Example [formatted string]
	issue     	A boolean value used to turn issue summaries on or off (1 or 0 respectively) [integer]

	<b>Examples</b>
	<span style='color:blue'>api.php?request=ratings</span>
	Returns a list of company names and Knowmore.org ratings from the Knowmore.org Firefox Extension pool.

	<span style='color: blue'>api.php?request=ratings&company=halliburton</span>
	Returns the Knowmore.org ratings from Halliburton

	<span style='color: blue'>api.php?request=ratings&url=http://www.mmm.com</span>
	Returns the ratings for the company associated with the http://www.mmm.com URL

<b>[format=xml]</b>
	<b>Description</b>
	Returns output in a generic, simple XML format schema.

<b>[format=phtml]</b>
	<b>Description</b>
	Returns output in a HTML/CSS formatted 'Corporate Statistics' profile
	Currently, compatiable with the request=profile and request=ratings modules
	request=ratings is the preferred method. The issue summary parameter of
	request=ratings can be used to turn issue summaries on and off in the profile.

<b>[format=json]</b>
	<b>Description</b>
	Returns output in a JSON format.

</pre>