Web Services Examples - Revision history

Scott at 22:43, 14 January 2014

2014-01-14T22:43:40Z

Scott: /* Doing personalized recommendations */

2009-05-24T13:37:05Z

‎Doing personalized recommendations

Scott: /* Doing personalized recommendations */

2009-05-24T13:29:46Z

‎Doing personalized recommendations

Scott: /* Doing personalized recommendations */

2009-05-24T13:28:59Z

‎Doing personalized recommendations

Scott: /* Finding related items */

2009-05-24T12:16:06Z

‎Finding related items

Scott: /* Deleting an item */

2009-05-24T10:58:01Z

‎Deleting an item

Scott: /* Retrieving an item */

2009-05-24T10:53:01Z

‎Retrieving an item

Scott: /* Removing a link from an item */

2009-05-24T10:47:29Z

‎Removing a link from an item

Scott: /* Removing a tag from an item */

2009-05-24T10:45:13Z

‎Removing a tag from an item

Scott: /* Adding a property to an item */

2009-05-24T10:42:38Z

‎Adding a property to an item

@@ Line 89: / Line 89: @@
 </source>
-{{CurlPut|user4|/user4}}
+{{CurlPut|user4|/items/user4}}
 == Updating an item ==
@@ Line 105: / Line 105: @@
 </source>
-{{CurlPut|user4-update|/user4}}
+{{CurlPut|user4-update|/items/user4}}
 == Adding a tag to an item ==
@@ Line 120: / Line 120: @@
 </source>
-{{CurlPut|tag|/user4/add}}
+{{CurlPut|tag|/items/user4/add}}
 == Adding a link to an item ==
@@ Line 135: / Line 135: @@
 </source>
-{{CurlPut|link|/user4/add}}
+{{CurlPut|link|/items/user4/add}}
 == Adding a property to an item ==
@@ Line 150: / Line 150: @@
 </source>
-{{CurlPut|property|/user4/add}}
+{{CurlPut|property|/items/user4/add}}
 == Add several tags / properties / links to an item ==
@@ Line 168: / Line 168: @@
 </source>
-{{CurlPut|several|/user4/add}}
+{{CurlPut|several|/items/user4/add}}
 == Removing a tag from an item ==
@@ Line 183: / Line 183: @@
 </source>
-{{CurlPut|tag|/user4/remove}}
+{{CurlPut|tag|/items/user4/remove}}
 == Removing a link from an item ==
@@ Line 198: / Line 198: @@
 </source>
-{{CurlPut|link|/user4/remove}}
+{{CurlPut|link|/items/user4/remove}}
 == Retrieving an item ==
@@ Line 204: / Line 204: @@
 Now that we've made a number of changes to the item that we've been working with, let's see what the current state of it in the database is:
-{{CurlGet|/user4}}
+{{CurlGet|/items/user4}}
 Produces:
@@ Line 228: / Line 228: @@
 And now let's clear out the item we've been working with from the database.
-{{CurlGet|/user4|argument=-X DELETE}}
+{{CurlGet|/items/user4|argument=-X DELETE}}
 == Finding related items ==
@@ Line 234: / Line 234: @@
 Let's get the related items for ''product1'':
-{{CurlGet|/product1/related}}
+{{CurlGet|/items/product1/related}}
 Gives us all related items:
@@ Line 252: / Line 252: @@
 Hmm, well, that's not quite what we wanted, but have no fear, this is where the ''tags'' query attribute comes in handy:
-{{CurlGet|/product1/related\?tags&#61;product}}
+{{CurlGet|/items/product1/related\?tags&#61;product}}
 And now we get back just items with the ''product'' tag:
@@ Line 270: / Line 270: @@
 Note that when we want to do personalized recommendations we use the ''recommended'' pseudo-resource rather than ''related''.  Our servers do a little different of a sort of magic for producing personalized recommendations than are used to find related products or pages.
-{{CurlGet|/user3/recommended}}
+{{CurlGet|/items/user3/recommended}}
 Here are the personalized recommendations for ''user3''.
@@ Line 288: / Line 288: @@
 But here we also get a user in the result set &mdash; just as above we want to specify the tags that we're interested in:
-{{CurlGet|/user3/recommended\?tags&#61;product}}
+{{CurlGet|/items/user3/recommended\?tags&#61;product}}
 Which now gives us only product results:
@@ Line 305: / Line 305: @@
 So, now we get just products back, but ''user3'' is already connected to ''product2'' &mdash; meaning we assume that they've already purchased or rated it, so we don't actually want that in the result set.  So let's throw in the ''excludeLinked=true''.
-{{CurlGet|/user3/recommended\?tags&#61;product\&excludeLinked&#61;true}}
+{{CurlGet|/items/user3/recommended\?tags&#61;product\&excludeLinked&#61;true}}
 Now we get only things tagged ''product'' and none of the ones that the user already has a connection to:

@@ Line 305: / Line 305: @@
 So, now we get just products back, but ''user3'' is already connected to ''product2'' &mdash; meaning we assume that they've already purchased or rated it, so we don't actually want that in the result set.  So let's throw in the ''excludeLinked=true''.
-{{CurlGet|/user3/recommended\?tags&#61;product&excludeLinked&#61;true}}
+{{CurlGet|/user3/recommended\?tags&#61;product\&excludeLinked&#61;true}}
 Now we get only things tagged ''product'' and none of the ones that the user already has a connection to:

@@ Line 305: / Line 305: @@
 So, now we get just products back, but ''user3'' is already connected to ''product2'' &mdash; meaning we assume that they've already purchased or rated it, so we don't actually want that in the result set.  So let's throw in the ''excludeLinked=true''.
-{{CurlGet|/user3/recommended\?tags&#61;product&excludeLinked=true}}
+{{CurlGet|/user3/recommended\?tags&#61;product&excludeLinked&#61;true}}
 Now we get only things tagged ''product'' and none of the ones that the user already has a connection to:

← Older revision		Revision as of 13:28, 24 May 2009
Line 267:		Line 267:

	== Doing personalized recommendations ==		== Doing personalized recommendations ==
		+
		+	Note that when we want to do personalized recommendations we use the ''recommended'' pseudo-resource rather than ''related''. Our servers do a little different of a sort of magic for producing personalized recommendations than are used to find related products or pages.
		+
		+	{{CurlGet\|/user3/recommended}}
		+
		+	Here are the personalized recommendations for ''user3''.
		+
		+	<source lang="xml">
		+	<?xml version="1.0" standalone="yes"?>
		+
		+	<directededge version="0.1">
		+	<item id="user3">
		+	<recommended>user1</recommended>
		+	<recommended>product2</recommended>
		+	<recommended>product1</recommended>
		+	</item>
		+	</directededge>
		+	</source>
		+
		+	But here we also get a user in the result set — just as above we want to specify the tags that we're interested in:
		+
		+	{{CurlGet\|/user3/recommended\?tags=product}}
		+
		+	Which now gives us only product results:
		+
		+	<source lang="xml">
		+	<?xml version="1.0" standalone="yes"?>
		+
		+	<directededge version="0.1">
		+	<item id="user3">
		+	<recommended>product2</recommended>
		+	<recommended>product1</recommended>
		+	</item>
		+	</directededge>
		+	</source>
		+
		+	So, now we get just products back, but ''user3'' is already connected to ''product2'' — meaning we assume that they've already purchased or rated it, so we don't actually want that in the result set. So let's throw in the ''excludeLinked=true''.
		+
		+	{{CurlGet\|/user3/recommended\?tags=product&excludeLinked=true}}
		+
		+	Now we get only things tagged ''product'' and none of the ones that the user already has a connection to:
		+
		+	<source lang="xml">
		+	<?xml version="1.0" standalone="yes"?>
		+
		+	<directededge version="0.1">
		+	<item id="user3">
		+	<recommended>product1</recommended>
		+	</item>
		+	</directededge>
		+	</source>
		+
		+	And there we have the (admittedly short) list of personalized recommendations for ''user3''.

← Older revision		Revision as of 12:16, 24 May 2009
Line 231:		Line 231:

	== Finding related items ==		== Finding related items ==
		+
		+	Let's get the related items for ''product1'':
		+
		+	{{CurlGet\|/product1/related}}
		+
		+	Gives us all related items:
		+
		+	<source lang="xml">
		+	<?xml version="1.0" standalone="yes"?>
		+
		+	<directededge version="0.1">
		+	<item id="product1">
		+	<related>product2</related>
		+	<related>user1</related>
		+	<related>user3</related>
		+	</item>
		+	</directededge>
		+	</source>
		+
		+	Hmm, well, that's not quite what we wanted, but have no fear, this is where the ''tags'' query attribute comes in handy:
		+
		+	{{CurlGet\|/product1/related\?tags=product}}
		+
		+	And now we get back just items with the ''product'' tag:
		+
		+	<source lang="xml">
		+	<?xml version="1.0" standalone="yes"?>
		+
		+	<directededge version="0.1">
		+	<item id="product1">
		+	<related>product2</related>
		+	</item>
		+	</directededge>
		+	</source>

	== Doing personalized recommendations ==		== Doing personalized recommendations ==

@@ Line 225: / Line 225: @@
 == Deleting an item ==
 == Finding related items ==
 == Doing personalized recommendations ==

@@ Line 201: / Line 201: @@
 == Retrieving an item ==
 {{CurlGet|/user4}}
@@ Line 211: / Line 213: @@
 <directededge version="0.1">
    <item id="user4">
      <tag>user</tag>
    </item>
 </directededge>
 </source>
 == Deleting an item ==

← Older revision		Revision as of 10:47, 24 May 2009
Line 186:		Line 186:

	== Removing a link from an item ==		== Removing a link from an item ==
		+
		+	And now we can do the same with removing the link to ''product3'':
		+
		+	<source lang="xml">
		+	<?xml version="1.0" encoding="UTF-8"?>
		+	<directededge version="0.1">
		+	<item>
		+	<link>product3</link>
		+	</item>
		+	</directededge>
		+	</source>
		+
		+	{{CurlPut\|link\|/user4/remove}}

	== Retrieving an item ==		== Retrieving an item ==

← Older revision		Revision as of 10:45, 24 May 2009
Line 171:		Line 171:

	== Removing a tag from an item ==		== Removing a tag from an item ==
		+
		+	Just like we could add a tag to an item incrementally, we can remove a tag (or property, or link) by uploading the same content to the ''remove'' sub-resource.
		+
		+	<source lang="xml">
		+	<?xml version="1.0" encoding="UTF-8"?>
		+	<directededge version="0.1">
		+	<item>
		+	<tag>Berliner</tag>
		+	</item>
		+	</directededge>
		+	</source>
		+
		+	{{CurlPut\|tag\|/user4/remove}}

	== Removing a link from an item ==		== Removing a link from an item ==

← Older revision		Revision as of 10:42, 24 May 2009
Line 151:		Line 151:

	{{CurlPut\|property\|/user4/add}}		{{CurlPut\|property\|/user4/add}}
		+
		+	== Add several tags / properties / links to an item ==
		+
		+	Just like you can add single tags, properties or links to an item, you can also add (or remove) several at a time:
		+
		+	<source lang="xml">
		+	<?xml version="1.0" encoding="UTF-8"?>
		+	<directededge version="0.1">
		+	<item>
		+	<tag>German</tag>
		+	<property name="first name">Matthias</property>
		+	<property name="last name">Schmidt</property>
		+	<link>product2</link>
		+	</item>
		+	</directededge>
		+	</source>
		+
		+	{{CurlPut\|several\|/user4/add}}

	== Removing a tag from an item ==		== Removing a tag from an item ==