InventoryService - Revision history

Justincc: /* DELETEINVENTORYITEMS */

2014-12-04T19:52:54Z

‎DELETEINVENTORYITEMS

Justincc at 01:52, 20 November 2012

2012-11-20T01:52:42Z

Justincc at 01:49, 20 November 2012

2012-11-20T01:49:00Z

Justincc: /* GETITEM */

2012-11-01T03:14:36Z

‎GETITEM

Justincc at 03:13, 1 November 2012

2012-11-01T03:13:03Z

Justincc: /* GETROOTFOLDER */

2012-11-01T00:57:51Z

‎GETROOTFOLDER

Justincc: /* Item */

2012-11-01T00:39:26Z

‎Item

Justincc: /* API */

2012-09-20T00:06:20Z

‎API

Justincc: /* GETFOLDERFORTYPE */

2012-09-19T21:31:49Z

‎GETFOLDERFORTYPE

Justincc: /* Calls */

2012-09-18T20:35:07Z

‎Calls

@@ Line 713: / Line 713: @@
 </source>
-=== DELETEINVENTORYITEMS ===
+=== DELETEITEMS ===
 These deletes inventory items for a given user.  POST field is a urlencoded string like so

@@ Line 5: / Line 5: @@
 The current default ROBUST OpenSimulator inventory service is known as the XInventoryService.
-'''TODO: Document remaining operations'''.
+'''TODO: Document remaining operations: CREATEUSERINVENTORY (unused), GETUSERINVENTORY (unused), GETINVENTORYSKELETON, GETROOTFOLDER, UPDATEFOLDER, MOVEFOLDER, DELETEFOLDERS, PURGEFOLDER, UPDATEITEM, MOVEITEMS, GETACTIVEGESTURES, GETASSETPERMISSIONS'''.
 =API=

@@ Line 366: / Line 366: @@
      curl_setopt($ch, CURLOPT_POST, TRUE);
      curl_setopt($ch, CURLOPT_POSTFIELDS, "PRINCIPAL=efc1b931-20e3-4298-8824-0f891fe3dc59&FOLDER=e3c2a5e8-20c4-4e70-a994-61dae3265b58&METHOD=GETFOLDERCONTENT");
      curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);

@@ Line 418: / Line 418: @@
    </item>
 </ServerResponse>
 </source>

← Older revision		Revision as of 03:13, 1 November 2012
Line 376:		Line 376:

	?>		?>
		+	</source>
		+
		+	=== GETITEM ===
		+
		+	This returns data about a particular inventory item. POST field is a urlencoded string like so
		+
		+	ID=2b410a2f-e639-4d09-a4d4-e6ca71bc68bd&METHOD=GETITEM
		+
		+	where
		+
		+	* '''METHOD''' is GETITEM
		+	* '''ID''' is the item UUID
		+
		+	If successful, example return is
		+
		+	<source lang="xml">
		+	<?xml version="1.0"?>
		+	<ServerResponse>
		+	<item type="List">
		+	<AssetID>8ecbd3a0-dd45-44e7-91f8-114a67f0d5c3</AssetID>
		+	<AssetType>6</AssetType>
		+	<BasePermissions>581633</BasePermissions>
		+	<CreationDate>1351634945</CreationDate>
		+	<CreatorId>e4f3924a-5a7c-4e1a-bee7-aa96580f2515</CreatorId>
		+	<CreatorData/>
		+	<CurrentPermissions>581633</CurrentPermissions>
		+	<Description/>
		+	<EveryOnePermissions>0</EveryOnePermissions>
		+	<Flags>0</Flags>
		+	<Folder>41e05ba4-fbdc-48f8-854b-29d8409884e6</Folder>
		+	<GroupID>00000000-0000-0000-0000-000000000000</GroupID>
		+	<GroupOwned>False</GroupOwned>
		+	<GroupPermissions>0</GroupPermissions>
		+	<ID>2b410a2f-e639-4d09-a4d4-e6ca71bc68bd</ID>
		+	<InvType>6</InvType>
		+	<Name>Primitive</Name>
		+	<NextPermissions>581632</NextPermissions>
		+	<Owner>e4f3924a-5a7c-4e1a-bee7-aa96580f2515</Owner>
		+	<SalePrice>0</SalePrice>
		+	<SaleType>0</SaleType>
		+	</item>
		+	</ServerResponse>
	</source>		</source>

@@ Line 102: / Line 102: @@
 === GETROOTFOLDER ===
-This returns data about a user's root folder (i.e. their "My Inventory" folder").  POST field is a urlencoded string like so
+This returns data about a user's root folder (i.e. their "My Inventory" folder).  POST field is a urlencoded string like so
   PRINCIPAL=efc1b932-20e3-4298-8824-0f891fe3dc59&METHOD=GETROOTFOLDER

@@ Line 70: / Line 70: @@
 * '''SalePrice''' is the sale price of this item.
 * '''SaleType''' is the sale type of this item.  See the SaleType enum in [https://github.com/openmetaversefoundation/libopenmetaverse/blob/master/OpenMetaverseTypes/Enums.cs libopenmetaverse] for more details.
 In some cases where multiple items can be returned the item element will have an underscore and index value appended (e.g. item_0 instead of folder).  This is for historical reasons.

@@ Line 379: / Line 379: @@
 </source>
-=== ADDINVENTORYITEM ===
+=== ADDFOLDER ===
 This adds an inventoryitem to a given inventory folder.  POST field is a urlencoded string like so

@@ Line 185: / Line 185: @@
 </source>
-If the request fails (e.g. because the PRINCIPAL does not exist) you will receive an empty response
+If the request fails (e.g. because the PRINCIPAL does not exist or a system folder of the given type does not exist) you will receive an empty response with an HTTP OK status code.
 <source lang="xml">

← Older revision		Revision as of 20:35, 18 September 2012
Line 486:		Line 486:

	?>		?>
		+	</source>
		+
		+	=== DELETEINVENTORYITEMS ===
		+
		+	These deletes inventory items for a given user. POST field is a urlencoded string like so
		+
		+	METHOD=DELETEITEMS&PRINCIPAL=efc1b932-20e3-4298-8824-0f891fe3dc59&ITEMS[]=1d09e24c-2b2a-8072-602a-950c9a3a8d18&ITEMS[]=3a057d48-adc7-de32-060f-0aac62fc6da9
		+
		+	where
		+
		+	* '''METHOD''' is the API method, in this case DELETEITEMS
		+	* '''PRINCIPAL''' is the user UUID.
		+	* '''ITEMS[]''' are the UUIDs of the items to delete. There can be one or many of these.
		+
		+	Response is currently always
		+
		+	<source lang="xml">
		+	<?xml version="1.0"?>
		+	<ServerResponse>
		+	<RESULT>True</RESULT>
		+	</ServerResponse>
		+	</source>
		+
		+	even if the given principal or item IDs are not found or are not well-formed UUIDs.
		+
		+	<source lang="xml">
		+	<?xml version="1.0"?>
		+	<ServerResponse>
		+	<RESULT>False</RESULT>
		+	</ServerResponse>
		+	</source>
		+
		+	will only be returned if the PRINCPIAL parameter or any ITEMS[] parameters were not present.
		+
		+	==== Sample scripts ====
		+
		+	<source lang="php">
		+	<?php
		+
		+	function PostInventoryOp($serviceUri, $postFields)
		+	{
		+	echo "postFields:$postFields\n";
		+
		+	$ch = curl_init($serviceUri);
		+
		+	curl_setopt($ch, CURLOPT_POST, TRUE);
		+	curl_setopt($ch, CURLOPT_POSTFIELDS, $postFields);
		+	curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
		+
		+	$result = curl_exec($ch);
		+	$info = curl_getinfo($ch);
		+	curl_close($ch);
		+
		+	echo "Return code:" . $info['http_code'] . "\n";
		+	echo "Return data: (below)\n" . GetPrettyXML($result) . "\n";
		+
		+	return new SimpleXmlElement($result);
		+	}
		+
		+	function DeleteInventoryItems($serviceUri, $principalId, $itemIds)
		+	{
		+	$params = "METHOD=DELETEITEMS&PRINCIPAL=$principalId";
		+
		+	foreach ($itemIds as $itemId)
		+	{
		+	$params .= "&ITEMS[]=$itemId";
		+	}
		+
		+	return PostInventoryOp($serviceUri, $params);
		+	}
		+	?>
		+
	</source>		</source>