RecSysWiki - User contributions [en]

Common Recommender REST API

2011-07-12T21:13:14Z

Jack Kolb:

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 API is based upon three basic entities:
* Users (Referenced by a Unique "uid")
* Items (Referenced by a Unique "iid")
* Events (Referenced by a Unique "eid")

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, 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 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.

==Working with Users==

====Add New User to Server====
;<tt>POST /users</tt>
:Adds a new user to the server. If a user ID is specified 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.

====Add New or Update Existing User====
;<tt>PUT /users/[uid]</tt>
:If the specified ID is unused, a new user is created and assigned this ID.
:If an existing user possesses the ID, the request must provide the user's most recent revision ID in order to update their data.
:The request will return a new revision ID for use by a future update request.

====Retrieve User Metadata====
;<tt>GET /users/[uid]</tt>
:Retrieves user data from the server. This includes user attributes, but does not include the user's history of events.

====Remove User from Server====
;<tt>DELETE /users/[uid]</tt>
:Deletes the specified user from the server. Precise behavior will vary between implementations.

====Access User Statistics====
;<tt>GET /users/[uid]/statistics</tt>
:Retrieves common statistics regarding the specified user. Implementations are free to specify their own fields.

====Retrieve User Rating Predictions====
=====Basic HTTP Calls=====
;<tt>GET /users/[uid]/predictions</tt>
:Retrieves user rating predictions for all possible items.

=====Query Parameters=====
;<var>item</var>
:The ID of an item for which a rating prediction is to be retrieved. Multiple IDs can be specified simultaneously. If no IDs are specified, the server will return predictions for all possible items.
:ex: <tt>GET /users/predictions?item=42&item=70</tt> Retrieves user rating predictions for items 42 and 70.

;<var>ratingOverride</var>
:Enables the server to return a user rating rather than a prediction if one has been provided for an item.
:ex: <tt>GET /users/predictions?ratingOverride=true</tt> Allows the server to retrieve user ratings in place of predictions when they are available.

====Retrieve User Item Recommendations====
=====Basic HTTP Calls=====
;<tt>GET /users/[uid]/recommendations</tt>
:Retrieves the complete recommendation set for the specified user. If possible, items are returned in ranked order.

=====Query Parameters=====
;<var>count</var>
:The maximum number of recommendations to be returned. If this maximum cannot be reached, the server returns as many recommendations as possible.
:ex: <tt>GET /users/[uid]/recommendations?count=10</tt> Retrieves a maximum of 10 recommended items.

====Access User History====
The supported event types will vary between implementation. Each of these event types may also support a unique set of query parameters.
=====Basic HTTP Calls=====
;<tt>GET /users/[uid]/events</tt>
:Retrieves all events associated with the specified user.

;<tt>GET /users/[uid]/events/purchases</tt>
:Retrieve all events of a specific type (In this case, purchases) associated with the specified user.

;<tt>GET /users/[uid]/currentRatings</tt>
:Retrieves a simple vector containing the most recent rating of all items 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.

=====Query Parameters=====
;<var>item</var>
:Required for all Event Types
:The ID of an item with which all returned events are associated. If no ID is specified, the server will consider all possible items.
:ex: <tt>GET /users/[uid]/events/purchases?item=42&item=70</tt> Retrieves all user purchase events associated with items 42 and 70.

;<var>history</var>
:Required for all Event Types
:The time period during which all returned events occurred.
:ex: <tt>GET /users/[uid]/events?history=1m</tt> Retrieves all events associated with the user that have occurred within the past month.

;<var>null</var>
:Required Specifically for the Rating Event Type
:Instructs the server to exclude any null ratings from the returned collection of events. By default, null-valued ratings are included.
:ex: <tt>GET /users/[uid]/events/ratings?item=42&item=70&null=false</tt> Returns all user rating events associated with items 42 and 70, excluding any null ratings.

====Add New Event to User History====
;<tt>POST /users/[uid]/events/ratings</tt>
:Add a new event of the specified type (In this case, a rating) to the server. If an ID is specified in the request body, the event is given the specified ID.
:Otherwise, the server generates an ID for the event and returns it in the response.

==Working with Items==
====Add New Item to Server====
;<tt>POST /items</tt>
:Adds a new item to the server. If an item ID is specified and currently unused, the item is assigned this ID. If an existing item possesses the ID, the request fails.
:If no ID is specified, one is is generated for the item by the server and returned in the response.
:The request will also return a new revision ID for use by a future update request.

====Add New or Update Existing Item====
;<tt>PUT /items/[iid]</tt>
:If the specified ID is unused, a new item is created and assigned the ID.
:If an existing item possesses the ID, the request must provide the item's most recent revision ID in order to update its data.
:The request will return a new revision ID for use by a future update request.

====Retrieve Item Metadata====
;<tt>GET /items/[iid]</tt>
:Retrieves item data from the server. This includes item attributes, but does not include the item's history of events.

====Remove Item from Server====
;<tt>DELETE /items/[iid]</tt>
:Deletes the item with the specified ID from the server. Precise behavior will vary between implementations.

====Access Item Statistics====
;<tt>GET /items/[iid]/statistics</tt>
:Retrieves common statistics regarding the specified item. Implementations are free to define their own fields.

====Access Item History====
Supported event types and query parameters will vary between implementations.
=====Basic HTTP Calls=====
;<tt>GET /items/[iid]/events</tt>
:Retrieves all events associated with the specified item.

;<tt>GET /items/[iid]/events/ratings</tt>
:Retrieve all events of a specific type (In this case, ratings) associated with the specified item.

=====Query Parameters=====
;<var>user</var>
:Required for all Event Types
:The ID of a user with which all returned events are associated. If no user ID is specified, the server will consider all possible users.
:ex: <tt>GET /items/[iid]/events/ratings?user=18&user=41</tt> Retrieves all item rating events associated with users 18 and 41.

;<var>history</var>
:Required for all Event Types
:The time period during which all returned events occurred
:ex: <tt>GET /items/[iid]/events?history=1m</tt> Retrieves all events associated with the item that have occurred within the past month.

;<var>null</var>
:Required for the Rating Event Type
:Instructs the server to exclude null ratings. By default, null-valued ratings are included.
:ex: <tt>GET /items/[iid]/events/ratings?history=1m&null=false</tt> Returns all item ratings that have occurred within the past month, excluding any null ratings.

==Working with Events==
====Retrieve a Specific Event====
;<tt>GET /events/[eid]</tt>
:Retrieves the specified event.

====Remove a Specific Event====
;<tt>DELETE /events/[eid]</tt>
:Deletes the specified event from the server. Precise behavior will vary between implementations.

==Miscellaneous==
====Retrieve System Statistics====
;<tt>GET /statistics</tt>
:Retrieves general system-wide statistics.

Common Recommender REST API

2011-07-12T21:12:04Z

Jack Kolb:

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 API is based upon three basic entities:
* Users (Referenced by a Unique "uid")
* Items (Referenced by a Unique "iid")
* Events (Referenced by a Unique "eid")

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, 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 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.

==Working with Users==

====Add New User to Server====
;<tt>POST /users</tt>
:Adds a new user to the server. If a user ID is specified 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.

====Add New or Update Existing User====
;<tt>PUT /users/[uid]</tt>
:If the specified ID is unused, a new user is created and assigned this ID.
:If an existing user possesses the ID, the request must provide the user's most recent revision ID in order to update their data.
:The request will return a new revision ID for use by a future update request.

====Retrieve User Metadata====
;<tt>GET /users/[uid]
:Retrieves user data from the server. This includes user attributes, but does not include the user's history of events.

====Remove User from Server====
;<tt>DELETE /users/[uid]</tt>
:Deletes the specified user from the server. Precise behavior will vary between implementations.

====Access User Statistics====
;<tt>GET /users/[uid]/statistics</tt>
:Retrieves common statistics regarding the specified user. Implementations are free to specify their own fields.

====Retrieve User Rating Predictions====
=====Basic HTTP Calls=====
;<tt>GET /users/[uid]/predictions</tt>
:Retrieves user rating predictions for all possible items.

=====Query Parameters=====
;<var>item</var>
:The ID of an item for which a rating prediction is to be retrieved. Multiple IDs can be specified simultaneously. If no IDs are specified, the server will return predictions for all possible items.
:ex: <tt>GET /users/predictions?item=42&item=70</tt> Retrieves user rating predictions for items 42 and 70.

;<var>ratingOverride</var>
:Enables the server to return a user rating rather than a prediction if one has been provided for an item.
:ex: <tt>GET /users/predictions?ratingOverride=true</tt> Allows the server to retrieve user ratings in place of predictions when they are available.

====Retrieve User Item Recommendations====
=====Basic HTTP Calls=====
;<tt>GET /users/[uid]/recommendations</tt>
:Retrieves the complete recommendation set for the specified user. If possible, items are returned in ranked order.

=====Query Parameters=====
;<var>count</var>
:The maximum number of recommendations to be returned. If this maximum cannot be reached, the server returns as many recommendations as possible.
:ex: <tt>GET /users/[uid]/recommendations?count=10</tt> Retrieves a maximum of 10 recommended items.

====Access User History====
The supported event types will vary between implementation. Each of these event types may also support a unique set of query parameters.
=====Basic HTTP Calls=====
;<tt>GET /users/[uid]/events</tt>
:Retrieves all events associated with the specified user.

;<tt>GET /users/[uid]/events/purchases</tt>
:Retrieve all events of a specific type (In this case, purchases) associated with the specified user.

;<tt>GET /users/[uid]/currentRatings</tt>
:Retrieves a simple vector containing the most recent rating of all items 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.

=====Query Parameters=====
;<var>item</var>
:Required for all Event Types
:The ID of an item with which all returned events are associated. If no ID is specified, the server will consider all possible items.
:ex: <tt>GET /users/[uid]/events/purchases?item=42&item=70</tt> Retrieves all user purchase events associated with items 42 and 70.

;<var>history</var>
:Required for all Event Types
:The time period during which all returned events occurred.
:ex: <tt>GET /users/[uid]/events?history=1m</tt> Retrieves all events associated with the user that have occurred within the past month.

;<var>null</var>
:Required Specifically for the Rating Event Type
:Instructs the server to exclude any null ratings from the returned collection of events. By default, null-valued ratings are included.
:ex: <tt>GET /users/[uid]/events/ratings?item=42&item=70&null=false</tt> Returns all user rating events associated with items 42 and 70, excluding any null ratings.

====Add New Event to User History====
;<tt>POST /users/[uid]/events/ratings</tt>
:Add a new event of the specified type (In this case, a rating) to the server. If an ID is specified in the request body, the event is given the specified ID.
:Otherwise, the server generates an ID for the event and returns it in the response.

==Working with Items==
====Add New Item to Server====
;<tt>POST /items</tt>
:Adds a new item to the server. If an item ID is specified and currently unused, the item is assigned this ID. If an existing item possesses the ID, the request fails.
:If no ID is specified, one is is generated for the item by the server and returned in the response.
:The request will also return a new revision ID for use by a future update request.

====Add New or Update Existing Item====
;<tt>PUT /items/[iid]</tt>
:If the specified ID is unused, a new item is created and assigned the ID.
:If an existing item possesses the ID, the request must provide the item's most recent revision ID in order to update its data.
:The request will return a new revision ID for use by a future update request.

====Retrieve Item Metadata====
;<tt>GET /items/[iid]
:Retrieves item data from the server. This includes item attributes, but does not include the item's history of events.

====Remove Item from Server====
;<tt>DELETE /items/[iid]</tt>
:Deletes the item with the specified ID from the server. Precise behavior will vary between implementations.

====Access Item Statistics====
;<tt>GET /items/[iid]/statistics</tt>
:Retrieves common statistics regarding the specified item. Implementations are free to define their own fields.

====Access Item History====
Supported event types and query parameters will vary between implementations.
=====Basic HTTP Calls=====
;<tt>GET /items/[iid]/events</tt>
:Retrieves all events associated with the specified item.

;<tt>GET /items/[iid]/events/ratings</tt>
:Retrieve all events of a specific type (In this case, ratings) associated with the specified item.

=====Query Parameters=====
;<var>user</var>
:Required for all Event Types
:The ID of a user with which all returned events are associated. If no user ID is specified, the server will consider all possible users.
:ex: <tt>GET /items/[iid]/events/ratings?user=18&user=41</tt> Retrieves all item rating events associated with users 18 and 41.

;<var>history</var>
:Required for all Event Types
:The time period during which all returned events occurred
:ex: <tt>GET /items/[iid]/events?history=1m</tt> Retrieves all events associated with the item that have occurred within the past month.

;<var>null</var>
:Required for the Rating Event Type
:Instructs the server to exclude null ratings. By default, null-valued ratings are included.
:ex: <tt>GET /items/[iid]/events/ratings?history=1m&null=false</tt> Returns all item ratings that have occurred within the past month, excluding any null ratings.

==Working with Events==
====Retrieve a Specific Event====
;<tt>GET /events/[eid]</tt>
:Retrieves the specified event.

====Remove a Specific Event====
;<tt>DELETE /events/[eid]</tt>
:Deletes the specified event from the server. Precise behavior will vary between implementations.

==Miscellaneous==
====Retrieve System Statistics====
;<tt>GET /statistics</tt>
:Retrieves general system-wide statistics.

Common Recommender REST API

2011-07-12T21:03:54Z

Jack Kolb: Revision of LensKit API Draft

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 API is based upon three basic entities:
* Users (Referenced by a Unique "uid")
* Items (Referenced by a Unique "iid")
* Events (Referenced by a Unique "eid")

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, 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 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.

==Working with Users==

====Add New User to Server====
;<tt>POST /users</tt>
:Adds a new user to the server. If a user ID is specified 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.

====Add New or Update Existing User====
;<tt>PUT /users/[uid]</tt>
:If the specified ID is unused, a new user is created and assigned this ID.
:If an existing user possesses the ID, the request must provide the user's most recent revision ID in order to update their data.
:The request will return a new revision ID for use by a future update request.

====Remove User from Server====
;<tt>DELETE /users/[uid]</tt>
:Deletes the specified user from the server. Precise behavior will vary between implementations.

====Access User Statistics====
;<tt>GET /users/[uid]/statistics</tt>
:Retrieves common statistics regarding the specified user. Implementations are free to specify their own fields.

====Retrieve User Rating Predictions====
=====Basic HTTP Calls=====
;<tt>GET /users/[uid]/predictions</tt>
:Retrieves user rating predictions for all possible items.

=====Query Parameters=====
;<var>item</var>
:The ID of an item for which a rating prediction is to be retrieved. Multiple IDs can be specified simultaneously. If no IDs are specified, the server will return predictions for all possible items.
:ex: <tt>GET /users/predictions?item=42&item=70</tt> Retrieves user rating predictions for items 42 and 70.

;<var>ratingOverride</var>
:Enables the server to return a user rating rather than a prediction if one has been provided for an item.
:ex: <tt>GET /users/predictions?ratingOverride=true</tt> Allows the server to retrieve user ratings in place of predictions when they are available.

====Retrieve User Item Recommendations====
=====Basic HTTP Calls=====
;<tt>GET /users/[uid]/recommendations</tt>
:Retrieves the complete recommendation set for the specified user. If possible, items are returned in ranked order.

=====Query Parameters=====
;<var>count</var>
:The maximum number of recommendations to be returned. If this maximum cannot be reached, the server returns as many recommendations as possible.
:ex: <tt>GET /users/[uid]/recommendations?count=10</tt> Retrieves a maximum of 10 recommended items.

====Access User History====
The supported event types will vary between implementation. Each of these event types may also support a unique set of query parameters.
=====Basic HTTP Calls=====
;<tt>GET /users/[uid]/events</tt>
:Retrieves all events associated with the specified user.

;<tt>GET /users/[uid]/events/purchases</tt>
:Retrieve all events of a specific type (In this case, purchases) associated with the specified user.

;<tt>GET /users/[uid]/currentRatings</tt>
:Retrieves a simple vector containing the most recent rating of all items 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.

=====Query Parameters=====
;<var>item</var>
:Required for all Event Types
:The ID of an item with which all returned events are associated. If no ID is specified, the server will consider all possible items.
:ex: <tt>GET /users/[uid]/events/purchases?item=42&item=70</tt> Retrieves all user purchase events associated with items 42 and 70.

;<var>history</var>
:Required for all Event Types
:The time period during which all returned events occurred.
:ex: <tt>GET /users/[uid]/events?history=1m</tt> Retrieves all events associated with the user that have occurred within the past month.

;<var>null</var>
:Required Specifically for the Rating Event Type
:Instructs the server to exclude any null ratings from the returned collection of events. By default, null-valued ratings are included.
:ex: <tt>GET /users/[uid]/events/ratings?item=42&item=70&null=false</tt> Returns all user rating events associated with items 42 and 70, excluding any null ratings.

====Add New Event to User History====
;<tt>POST /users/[uid]/events/ratings</tt>
:Add a new event of the specified type (In this case, a rating) to the server. If an ID is specified in the request body, the event is given the specified ID.
:Otherwise, the server generates an ID for the event and returns it in the response.

==Working with Items==
====Add New Item to Server====
;<tt>POST /items</tt>
:Adds a new item to the server. If an item ID is specified and currently unused, the item is assigned this ID. If an existing item possesses the ID, the request fails.
:If no ID is specified, one is is generated for the item by the server and returned in the response.
:The request will also return a new revision ID for use by a future update request.

====Add New or Update Existing Item====
;<tt>PUT /items/[iid]</tt>
:If the specified ID is unused, a new item is created and assigned the ID.
:If an existing item possesses the ID, the request must provide the item's most recent revision ID in order to update its data.
:The request will return a new revision ID for use by a future update request.

====Remove Item from Server====
;<tt>DELETE /items/[iid]</tt>
:Deletes the item with the specified ID from the server. Precise behavior will vary between implementations.

====Access Item Statistics====
;<tt>GET /items/[iid]/statistics</tt>
:Retrieves common statistics regarding the specified item. Implementations are free to define their own fields.

====Access Item History====
Supported event types and query parameters will vary between implementations.
=====Basic HTTP Calls=====
;<tt>GET /items/[iid]/events</tt>
:Retrieves all events associated with the specified item.

;<tt>GET /items/[iid]/events/ratings</tt>
:Retrieve all events of a specific type (In this case, ratings) associated with the specified item.

=====Query Parameters=====
;<var>user</var>
:Required for all Event Types
:The ID of a user with which all returned events are associated. If no user ID is specified, the server will consider all possible users.
:ex: <tt>GET /items/[iid]/events/ratings?user=18&user=41</tt> Retrieves all item rating events associated with users 18 and 41.

;<var>history</var>
:Required for all Event Types
:The time period during which all returned events occurred
:ex: <tt>GET /items/[iid]/events?history=1m</tt> Retrieves all events associated with the item that have occurred within the past month.

;<var>null</var>
:Required for the Rating Event Type
:Instructs the server to exclude null ratings. By default, null-valued ratings are included.
:ex: <tt>GET /items/[iid]/events/ratings?history=1m&null=false</tt> Returns all item ratings that have occurred within the past month, excluding any null ratings.

==Working with Events==
====Retrieve a Specific Event====
;<tt>GET /events/[eid]</tt>
:Retrieves the specified event.

====Remove a Specific Event====
;<tt>DELETE /events/[eid]</tt>
:Deletes the specified event from the server. Precise behavior will vary between implementations.

==Miscellaneous==
====Retrieve System Statistics====
;<tt>GET /statistics</tt>
:Retrieves general system-wide statistics.

Common Recommender REST API

2011-07-06T20:38:58Z

Jack Kolb: First draft of REST API from LensKit

The [[MyMediaLite]] and [[LensKit]] projects are seeking to use a common 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:
* Users (Referenced by a Unique "uid")
* Items (Referenced by a Unique "iid")
* Events (Referenced by a Unique "eid")

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.

==Working with Users==

====Add New User to Server====
;<tt>POST /users</tt>
:Adds a new user to the server. An ID is generated by the server and returned in the response.

;<tt>PUT /users/[uid]</tt>
:Adds a new user, with a client-defined ID, to the server.

====Remove User from Server====
;<tt>DELETE /users/[uid]</tt>
:Deletes the specified user from the server. Precise behavior will vary between implementations.
====Access User Statistics====
;<tt>GET /users/[uid]/statistics</tt>
:Retrieves common statistics regarding the specified user. Implementations are free to specify their own fields.

====Retrieve User Rating Predictions====
=====Basic HTTP Calls=====
;<tt>GET /users/[uid]/predictions</tt>
:Retrieves user rating predictions for all possible items.

=====Query Parameters=====
;<var>item</var>
:The ID of an item for which a rating prediction is to be retrieved. Multiple IDs can be specified simultaneously.
:ex: <tt>GET /users/predictions?item=42&item=70</tt> Retrieves user rating predictions for items 42 and 70.

;<var>ratingOverride</var>
:Enables the server to return a user rating rather than a prediction if one has been provided for an item.
:ex: <tt>GET /users/predictions?ratingOverride=true</tt> Allows the server to retrieve user ratings in place of predictions when they are available.

====Retrieve User Item Recommendations====
=====Basic HTTP Calls=====
;<tt>GET /users/[uid]/recommendations</tt>
:Retrieves the complete recommendation set for the specified user. If possible, items are returned in ranked order.

=====Query Parameters=====
;<var>count</var>
:The maximum number of recommendations to be returned. If this maximum cannot be reached, the server returns as many recommendations as possible.
:ex: <tt>GET /users/[uid]/recommendations?count=10</tt> Retrieves a maximum of 10 recommended items.

====Access User History====
Supported event types and query parameters will vary between implementations.
=====Basic HTTP Calls=====
;<tt>GET /users/[uid]/events</tt>
:Retrieves all events associated with the specified user.

;<tt>GET /users/[uid]/events/ratings</tt>
:Retrieve all events of a specific type (In this case, ratings) associated with the specified user.

;<tt>GET /users/[uid]/ratings</tt>
:Retrieves a vector containing the most recent rating of all items rated by the user.

=====Query Parameters=====
;<var>item</var>
:The ID of an item with which all returned events are associated.
:ex: <tt>GET /users/[uid]/events/ratings?item=42&item=70</tt> Retrieves all user rating events associated with items 42 and 70.

;<var>history</var>
:The time period during which all returned events occurred.
:ex: <tt>GET/users/[uid]/events?history=1m</tt> Retrieves all events associated with the user that have occurred within the past month.

====Add New Event to User History====
;<tt>POST /users/[uid]/events/ratings</tt>
:Add a new event of the specified type (In this case, a rating) to the server. The event's ID is returned in the response.

==Working with Items==
====Add New Item to Server====
;<tt>POST /items</tt>
:Adds a new item to the server. An ID is generated by the server and returned in the response.

;<tt>PUT /items/[iid]</tt>
:Adds a new item, with a client-defined ID, to the server.

====Remove Item from Server====
;<tt>DELETE /items/[iid]</tt>
:Deletes the item with the specified ID from the server. Precise behavior will vary between implementations.

====Access Item Statistics====
;<tt>GET /items/[iid]/statistics</tt>
:Retrieves common statistics regarding the specified item. Implementations are free to define their own fields.

====Access Item History====
Supported event types and query parameters will vary between implementations.
=====Basic HTTP Calls=====
;<tt>GET /items/[iid]/events</tt>
:Retrieves all events associated with the specified item.

;<tt>GET /items/[iid]/events/ratings</tt>
:Retrieve all events of a specific type (In this case, ratings) associated with the specified item.

=====Query Parameters=====
;<var>user</var>
:The ID of a user with which all returned events are associated.
:ex: <tt>GET /items/[iid]/events/ratings?user=18&user=41</tt> Retrieves all item rating events associated with users 18 and 41.

;<var>history</var>
:The time period during which all returned events occurred
:ex: <tt>GET/items/[iid]/events?history=1m</tt> Retrieves all events associated with the item that have occurred within the past month.

==Working with Events==
====Retrieve a Specific Event====
;<tt>GET /events/[eid]</tt>
:Retrieves the specified event.

====Remove a Specific Event====
;<tt>DELETE /events/[eid]</tt>
:Deletes the specified event from the server. Precise behavior will vary between implementations.

==Miscellaneous==
====Retrieve System Statistics====
;<tt>GET /statistics</tt>
:Retrieves general system-wide statistics.