PutField - Revision history

Stuarteve: /* Example 3 - Deleting a number */

2013-12-09T10:30:43Z

‎Example 3 - Deleting a number

Stuarteve: PutField() moved to PutField

2013-12-09T10:29:36Z

PutField() moved to PutField

Stuarteve: /* Example 3 - Deleting a number */

2013-12-03T15:46:27Z

‎Example 3 - Deleting a number

Stuarteve: /* Example 3 - Deleting a number */

2013-12-03T15:44:37Z

‎Example 3 - Deleting a number

Stuarteve: /* Example 3 - Deleting a number */

2013-12-03T15:44:15Z

‎Example 3 - Deleting a number

Stuarteve: Created page with "This method is used to add, edit or delete the contents of a field on an ARK instance. Please note this method respects any security conditions set in the subform configuration..."

2013-12-03T15:43:28Z

Created page with "This method is used to add, edit or delete the contents of a field on an ARK instance. Please note this method respects any security conditions set in the subform configuration..."

New page

This method is used to add, edit or delete the contents of a field on an ARK instance.

Please note this method respects any security conditions set in the subform configuration - therefore if fields are, for instance, being restricted on userids or security groups they will not be made available for return or manipulation by the API.

'''PLEASE BE CAREFUL using this call - as you are directly interacting with the database and you could easily accidentally delete or edit data. The API does NOT provide any 'are you sure' fallbacks and therefore mistakes may be hard to rectify'''

===Path===

http://your.ark.instance/api.php?req=putField

===Arguments===

As the arguments needed for each field vary depending on the validation functions that are applied to the field, this arguments needed by putField() will vary. A list of the variable names needed (for add or edit) per field can be obtained by using describeFields(). However, some arguments will be pretty-much standard across all fields

*'''item_key''' - this is in the form 'cxt_cd' and refers to the module of the item to be changed.

*'''itemval''' - this is the itemvalue of the item that is to be changed

*'''field''' - this is the name of the field to be changed

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

*'''handle''' - username

*'''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

===Examples===

====Example 1 - Adding a new number====

http://your.ark.instance/api.php?req=putField&item_key=hut_cd&itemval=LK12_3&field=conf_field_diameter&diameter=8.9&diameter_qtype=add&handle=johndoe&passwd=johndoepassword

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

<pre>
Array
(
[messages] => Array
(
[0] => Update Successful
)

[errors] =>
)
</pre>

====Example 2 - Editing some text====

http://your.ark.instance/api.php?req=putField&item_key=hut_cd&itemval=LK12_1&field=conf_field_description&notes=Houseagogo&notes_id=1&notes_qtype=edt&handle=johndoe&passwd=johndoepassword

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

<pre>
Array
(
[messages] => Array
(
[0] => Update Successful
)

[errors] =>
)
</pre>

====Example 3 - Deleting a number====

http://your.ark.instance/api.php?req=putField&field=conf_field_diameter&hut_cd=LK12_3&update_db=delfrag&dclass=number&delete_qtype=del&frag_id=73

@@ Line 70: / Line 70: @@
 ====Example 3 - Deleting a number====
-http://your.ark.instance/api.php?req=putField&field=conf_field_diameter&hut_cd=LK12_3&update_db=delfrag&dclass=number&delete_qtype=del&frag_id=73
+http://your.ark.instance/api.php?req=putField&update_db=delfrag&dclass=number&delete_qtype=del&frag_id=73
 Example return (returned JSONified - displayed as an array here for ease of viewing):

← Older revision	Revision as of 10:29, 9 December 2013
(No difference)

@@ Line 71: / Line 71: @@
 http://your.ark.instance/api.php?req=putField&field=conf_field_diameter&hut_cd=LK12_3&update_db=delfrag&dclass=number&delete_qtype=del&frag_id=73
+<pre>
 Array
+(
@@ Line 81: / Line 81: @@
      [errors] =>
+)

← Older revision		Revision as of 15:44, 3 December 2013
Line 71:		Line 71:

	http://your.ark.instance/api.php?req=putField&field=conf_field_diameter&hut_cd=LK12_3&update_db=delfrag&dclass=number&delete_qtype=del&frag_id=73		http://your.ark.instance/api.php?req=putField&field=conf_field_diameter&hut_cd=LK12_3&update_db=delfrag&dclass=number&delete_qtype=del&frag_id=73
		+
		+	Array
		+	(
		+	[messages] => Array
		+	(
		+	[0] => Update Successful
		+	)
		+
		+	[errors] =>
		+	)