Common Recommender REST API - Revision history

IgorBrigadir: Add link to OpenAPI spec on github

2020-07-26T23:25:01Z

Add link to OpenAPI spec on github

2011-12-06T17:31:28Z

Retrieve a Specific Event

2011-12-06T17:29:08Z

2011-12-03T17:36:19Z

Add New User

2011-12-03T17:36:03Z

Add New User

2011-12-02T16:53:19Z

Basic HTTP Calls: clarify what is meant by "currentRatings"

2011-12-02T16:32:22Z

2011-12-02T16:29:25Z

Retrieve a Specific Event

2011-12-02T16:28:24Z

Retrieve a Specific Event

2011-12-02T16:17:35Z

Add New User to Server: "to Server" - removed, kind of redundant

@@ Line 163: / Line 163: @@
 ;<tt>GET /statistics</tt>
 :Retrieves general system-wide statistics.
 [[Category: API]]

@@ Line 152: / Line 152: @@
 ;<tt>GET /events/[eid]</tt>
 :Retrieves the specified event.
-: response example (JSON): <tt>{"eid":"945","uid":"516","iid":42,"timestamp":2005928682,"value":3.66}</tt>
+: response example (JSON): <tt>{"eid":"945","type":"rating","uid":"516","iid":42,"timestamp":2005928682,"value":3.66}</tt>
 :: '''timestamp''' represents the seconds since the [[Wikipedia: Unix time|Unix epoch]] (UTC). Implementations may provide additional attributes to support the user's local time.

@@ Line 9: / Line 9: @@
 User, item, and event IDs are strings, but implementations will most likely specify a valid ID format.
-An additional type of ID, a revision ID ("'''rid'''"), is used to identify any change to a user, item, or event. When one of these entities is either created or updated, the server will return a revision ID in its response. When a client wishes to make changes to a user, item, or event, it must provide the ID of the entity's most recent revision. If this ID is not valid, the client's request will fail.
+An additional type of ID, a revision ID ("'''rid'''"), is used to identify any change to a user, item, or event. When one of these entities is either returned, created or updated, the server will return a revision ID in its response. When a client wishes to make changes to a user, item, or event, it must provide the ID of the entity's most recent revision. If this ID is not valid, the client's request will fail.
 Each user and item is associated with a set of events. An event is created whenever a user takes some meaningful action involving an item, such as a rating or purchase. This event is then associated with both the user and the item. The specific event types that are supported will vary between different implementations.

@@ Line 18: / Line 18: @@
 ;<tt>POST /users</tt>
 :Adds a new user to the server. If a user ID is specified in the request body, and currently unused, the user is assigned the ID. If an existing user possesses the ID, the request fails.
-:The body may also contain events related to this user.
+:The request body may also contain events related to this user.
 :If no ID is specified, one is is generated for the user by the server and returned in the response.
 :The request will also return a new revision ID for use by a future update request.

@@ Line 18: / Line 18: @@
 ;<tt>POST /users</tt>
 :Adds a new user to the server. If a user ID is specified in the request body, and currently unused, the user is assigned the ID. If an existing user possesses the ID, the request fails.
 :If no ID is specified, one is is generated for the user by the server and returned in the response.
 :The request will also return a new revision ID for use by a future update request.

@@ Line 73: / Line 73: @@
 ;<tt>GET /users/[uid]/currentRatings</tt>
-:Retrieves a simple vector containing the most recent rating of all items currently rated by the user.
+:Retrieves a simple vector containing the most recent rating of each item currently rated by the user.
 :Note that this will return the same set of events as <tt>GET /users/[uid]/events/ratings?history=current&null=false</tt>, but in a simple vector form.

← Older revision		Revision as of 16:32, 2 December 2011
Line 1:		Line 1:
−	The [[MyMediaLite]] and [[LensKit]] projects are seeking to use a ~~common~~ [[Wikipedia:REST\|REST API]] for recommender web applications. Specific implementations are encouraged to support the following core interface, but may extend the API as necessary.	+	The [[MyMediaLite]] and [[LensKit]] projects are seeking to use a '''Common Recommender [[Wikipedia:REST\|REST API]]''' for recommender web applications.
		+	Specific implementations are encouraged to support the following core interface, but may extend the API as necessary.

	The API is based upon three basic entities:		The API is based upon three basic entities:

@@ Line 14: / Line 14: @@
 ==Working with Users==
-====Add New User to Server====
+====Add New User====
 ;<tt>POST /users</tt>
 :Adds a new user to the server. If a user ID is specified in the request body, and currently unused, the user is assigned the ID. If an existing user possesses the ID, the request fails.