GetFrags - Revision history

Stuarteve: /* Optional */

2013-11-15T15:51:39Z

‎Optional

Stuarteve at 16:34, 14 November 2013

2013-11-14T16:34:42Z

Stuarteve: /* Example */

2013-11-12T11:41:47Z

‎Example

Show changes

Stuarteve: /* Arguments */

2013-11-12T11:26:51Z

‎Arguments

Stuarteve: Created page with "This method is used to get a list of data fragments of a specific dataclass and/or classtype within the ARK instance. It will return a JSON array of all the different data fragme..."

2013-11-12T11:24:48Z

Created page with "This method is used to get a list of data fragments of a specific dataclass and/or classtype within the ARK instance. It will return a JSON array of all the different data fragme..."

New page

This method is used to get a list of data fragments of a specific dataclass and/or classtype within the ARK instance. It will return a JSON array of all the different data fragments attached to a specific item

===Path===

http://your.ark.instance/api.php?request=getFrags

===Arguments===

====Mandatory====

*'''item_key''' - this is the item_key of the required module (for instance 'cxt_cd').

*'''item_value''' - this is the ARK item that you are interested in. This should be sent in the form item_key=item_value. As an example: cxt_cd=LK12_1. A list of available items can be supplied by [[describeItems]].

*'''dataclass''' -

====Optional====

*

If anonymous logins are not enabled a username and password will need to be supplied:

*'''handle''' - username

*'''passwd''' - password

===Example===

http://your.ark.instance/api.php?request=getItems&item_key=hut_cd&handle=johndoe&passwd=johndoepassword

Example return (returned JSONified - displayed as an array here for ease of viewing):

<pre>
Array
(
[hut] => Array
(
[0] => Array
(
[0] => LK12_1
[hut_cd] => LK12_1
[1] => 1
[hut_no] => 1
[2] => LK12
[ste_cd] => LK12
[3] => 1
[cre_by] => 1
[4] => 2012-05-24 00:00:00
[cre_on] => 2012-05-24 00:00:00
)

[1] => Array
(
[0] => LK12_2
[hut_cd] => LK12_2
[1] => 2
[hut_no] => 2
[2] => LK12
[ste_cd] => LK12
[3] => 1
[cre_by] => 1
[4] => 2012-05-24 00:00:00
[cre_on] => 2012-05-24 00:00:00
)

[2] => Array
(
[0] => LK12_3
[hut_cd] => LK12_3
[1] => 3
[hut_no] => 3
[2] => LK12
[ste_cd] => LK12
[3] => 0
[cre_by] => 0
[4] => 0000-00-00 00:00:00
[cre_on] => 0000-00-00 00:00:00
)

)
)
</pre>

← Older revision		Revision as of 15:51, 15 November 2013
Line 26:		Line 26:

	*'''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 3: / Line 3: @@
 ===Path===
-http://your.ark.instance/api.php?request=getFrags
+http://your.ark.instance/api.php?req=getFrags
 ===Arguments===
@@ Line 31: / Line 31: @@
 ====Example 1 - Retrieve all attributes attached to an item====
-http://your.ark.instance/api.php?request=getFrags&dataclass=attribute&item_key=hut_cd&hut_cd=LK12_1&handle=johndoe&passwd=johndoepassword
+http://your.ark.instance/api.php?req=getFrags&dataclass=attribute&item_key=hut_cd&hut_cd=LK12_1&handle=johndoe&passwd=johndoepassword
 Example return (returned JSONified - displayed as an array here for ease of viewing):
@@ Line 70: / Line 70: @@
 ====Example 2 - Retrieve all text of classtype 'notes' attached to an item====
-http://your.ark.instance/api.php?request=getFrags&dataclass=txt&classtype=notes&item_key=hut_cd&hut_cd=LK12_1&handle=johndoe&passwd=johndoepassword
+http://your.ark.instance/api.php?req=getFrags&dataclass=txt&classtype=notes&item_key=hut_cd&hut_cd=LK12_1&handle=johndoe&passwd=johndoepassword
 Example return (returned JSONified - displayed as an array here for ease of viewing):
@@ Line 98: / Line 98: @@
 ====Example 3 - Retrieve all data fragments attached to an item with Aliases====
-http://your.ark.instance/api.php?request=getFrags&dataclass=all&item_key=hut_cd&hut_cd=LK12_1&aliased=true&handle=johndoe&passwd=johndoepassword
+http://your.ark.instance/api.php?req=getFrags&dataclass=all&item_key=hut_cd&hut_cd=LK12_1&aliased=true&handle=johndoe&passwd=johndoepassword
 Example return (returned JSONified - displayed as an array here for ease of viewing):

@@ Line 13: / Line 13: @@
 *'''item_value''' - this is the ARK item that you are interested in. This should be sent in the form item_key=item_value. As an example: cxt_cd=LK12_1. A list of available items can be supplied by [[describeItems]].
-*'''dataclass''' -
+*'''dataclass''' - this can be any of the main dataclasses, e.g. [[action]],[[attribute]], [[date]], [[span]], [[xmi]], [[txt]], [[number]],[[file]]. If you want to return all of the possible data fragment types then set the argument to 'all'.
 ====Optional====
+*'''classtype''' - if you are only interested in a particular type of data then you can send the classtype as well and this will limit the results
 If anonymous logins are not enabled a username and password will need to be supplied: