Library


 

Library api should be found at /api/library. The following methods should exist.

 

GET Methods

 

/api/library.(xml|json) (formerly /api/user/rich/media/experience)

Params: user, media.

If user is not specified, the logged in user is assumed.

 

Outputs a user's experience library for a given media-type.

 

xml: <item year="1996" completions="1" moment="2007-09-28 10:03:33" last="2007-09-28 10:03:33" state="complete" level="35">

<context id="11" type="anime" image="/media/11/1/jmlji515egtsi17042yrxm7cni16my5f1">

<alias>Rurouni Kenshin</alias>

</context>

<tags>historic, 明治時代, swordplay</tags>

</item>

 

 

/api/library/segments.xml (formerly /api/experience/segments)

Params: user, context_type, context_name.

If user is not specified the logged in user is assumed.

 

Outputs a list of segments for a given context, which the user has experienced.

xml: <segment id="19" completions="1" last="2009-08-11 20:56:47" type="episode">01</segment>

 

 

/api/library/updates.xml (formerly /api/experience/updates)

Params: user [, context_type, limit, page].

If user is not specified the logged in user is assumed. Optional context-type for more specific calls. Supports paging with limit and page parameters.

 

Outputs a list of context with most recent status changes.

xml: <segment id="19" completions="1" last="2009-08-11 20:56:47" type="episode">01</segment>

 

 

/api/library/count.xml (formerly /api/user/experience/count)

Params: user

If user is not specified the logged user is assumed.

 

Outputs a list of context-types with library count for each type.

xml: <context type="adrama" count="11"/>

 

 

/api/library/states.xml (formerly /api/user/experience/states)

Params: user, media

 

Outputs a list of context-states with library count for each state, for a given media.

xml: <context type="unknown" count="7"/>

 

 

/api/library/suggested.xml

Params: threshold, input_type, output_type.

 

Outputs a list of contexts with metric suggestion data.

 

 

POST Methods

 

/api/library/update.json

Params: valid context (type=name), state [, timestamp]

State being one of ('unknown', 'complete', 'current', 'wishlisted', 'started', 'paused', 'resumed', 'dropped', 'hold', 'planned', 'marathon', 'backlog', 'subscribed').

 

/api/library/import.json (formerly /api/experience/import)

Params: context_type, map, data

 

/api/library/remove.json (formerly /api/remove/experience)

Params: valid context (type=name)

 

/api/library/segment/update.json (formerly /api/experience/status/update)

Params: valid context (type=name), segment

 

/api/library/update_rating.json

Params: valid context (type=name), rating

Rating formats:

 

 

Other

 

 

GET: /api/library/recommendations.xml

Params: user [, media-type, page, limit]

Selected or logged in user. media-type for recommendations within a specific media. limit defaults to 20, min 5, max 50.

 

userassociations

userrecommendationsstatus

userrelativity

userrelativitytiers

userreverserecommendations

 

associate

associationremove

recommend

recommendto

reflection

removerecommend

removerelativity

reverserecommend

tag