GetFilter - Revision history

Stuarteve: /* Arguments */

2013-11-15T15:52:00Z

‎Arguments

Stuarteve at 16:32, 14 November 2013

2013-11-14T16:32:27Z

Stuarteve: /* Path */

2013-11-14T16:32:02Z

‎Path

Stuarteve at 15:33, 12 November 2013

2013-11-12T15:33:36Z

Stuarteve at 15:30, 12 November 2013

2013-11-12T15:30:57Z

Stuarteve: Created page with "$ftype = reqQst($_REQUEST, 'ftype'); $src = reqQst($_REQUEST, 'src'); $retftrset = reqQst($_REQUEST, 'retftrset');"

2013-11-12T15:22:33Z

Created page with "$ftype = reqQst($_REQUEST, 'ftype'); $src = reqQst($_REQUEST, 'src'); $retftrset = reqQst($_REQUEST, 'retftrset');"

New page

$ftype = reqQst($_REQUEST, 'ftype');
$src = reqQst($_REQUEST, 'src');
$retftrset = reqQst($_REQUEST, 'retftrset');

← Older revision		Revision as of 15:52, 15 November 2013
Line 19:		Line 19:

	*'''passwd''' - password		*'''passwd''' - password
		+
		+	The method returns a JSON array unless otherwise specified:
		+
		+	*'''format''' - 'json' by default, but sending 'html' prints a human-readable array to screen

	===Example===		===Example===

@@ Line 24: / Line 24: @@
 ====Example 1 - getting a saved filter====
-http://your.ark.instance/api.php?request=getFilter&retftrset=3&handle=johndoe&passwd=johndoepassword
+http://your.ark.instance/api.php?req=getFilter&retftrset=3&handle=johndoe&passwd=johndoepassword
 Example return (returned JSONified - displayed as an array here for ease of viewing):
@@ Line 73: / Line 73: @@
 ====Example 2 - running a free text search====
-http://your.ark.instance/api.php?request=getFilter&ftype=ftx&src=northerly&handle=johndoe&passwd=johndoepassword
+http://your.ark.instance/api.php?req=getFilter&ftype=ftx&src=northerly&handle=johndoe&passwd=johndoepassword
 Example return (returned JSONified - displayed as an array here for ease of viewing):

@@ Line 3: / Line 3: @@
 ===Path===
-http://your.ark.instance/api.php?request=getFilter
+http://your.ark.instance/api.php?req=getFilter
 ===Arguments===

← Older revision		Revision as of 15:33, 12 November 2013
Line 25:		Line 25:

	http://your.ark.instance/api.php?request=getFilter&retftrset=3&handle=johndoe&passwd=johndoepassword		http://your.ark.instance/api.php?request=getFilter&retftrset=3&handle=johndoe&passwd=johndoepassword
		+
		+	Example return (returned JSONified - displayed as an array here for ease of viewing):
		+
		+	<pre>Array
		+	(
		+	[hut_cdLK12_28] => Array
		+	(
		+	[itemkey] => hut_cd
		+	[itemval] => LK12_28
		+	[score] => 151
		+	[snippets] => Array
		+	(
		+	[0] => Array
		+	(
		+	[type] => Notes
		+	[snip] => A shaman's house? The counterpart to house 3?
		+	[class] => txt
		+	)
		+
		+	)
		+
		+	)
		+
		+	[hut_cdLK12_3] => Array
		+	(
		+	[itemkey] => hut_cd
		+	[itemval] => LK12_3
		+	[score] => 151
		+	[snippets] => Array
		+	(
		+	[0] => Array
		+	(
		+	[type] => Notes
		+	[snip] => The 'Shaman's House'. One of the most northerly and the only house with a view of Rough Tor directly through it's doorway.
		+
		+	It is associated with a field-shrine/mini-tor to the south and has a small 'hidden' enclosure to the back of the house. SW says that it is hidden from all of the houses - although the viewshed analysis suggests otherwise...
		+	[class] => txt
		+	)
		+
		+	)
		+
		+	)
		+
		+	)
		+	</pre>
		+
		+	====Example 2 - running a free text search====
		+
		+	http://your.ark.instance/api.php?request=getFilter&ftype=ftx&src=northerly&handle=johndoe&passwd=johndoepassword
		+
		+	Example return (returned JSONified - displayed as an array here for ease of viewing):
		+
		+	<pre>Array
		+	(
		+	[hut_cdLK12_3] => Array
		+	(
		+	[itemkey] => hut_cd
		+	[itemval] => LK12_3
		+	[score] => 151
		+	[snippets] => Array
		+	(
		+	[0] => Array
		+	(
		+	[type] => Notes
		+	[snip] => The 'Shaman's House'. One of the most northerly and the only house with a view of Rough Tor directly through it's doorway.
		+
		+	It is associated with a field-shrine/mini-tor to the south and has a small 'hidden' enclosure to the back of the house. SW says that it is hidden from all of the houses - although the viewshed analysis suggests otherwise...
		+	[class] => txt
		+	)
		+
		+	)
		+
		+	)
		+
		+	)
		+	</pre>

@@ Line 1: / Line 1: @@
-$ftype = reqQst($_REQUEST, 'ftype');
+This method is used to return the results of a filter in a standard ARK results array. It can return the results of a saved filter or can be used to run a simple freetext search.
-$src = reqQst($_REQUEST, 'src');
-$retftrset = reqQst($_REQUEST, 'retftrset');
+===Path===