Features: ReturnVectors and ReturnCategories

The Return Items for a user feature assumes that if you want to get only those items that have been classified under a certain category you know the numerical code used by sux0r to identify the vector and category. These features allow you to find those codes.

Return vectors for a user
The full design for this feature is available, however the current implementation does not cover the authentication requirements.

The API call is an HTTP GET on [sux0rURL]/api/vectors/ (where [sux0rURL] is the URL for your sux0r installation, for this project that is http://icbl.macs.hw.ac.uk/sux0rAPI/icbl/ ). The only parameter is user= to specify a username.

examples
HTTP GET on http://icbl.macs.hw.ac.uk/sux0rAPI/icbl/api/vectors/?user=philb will return a list the vectors used by philb (me). The data returned is pretty self-explanatory, in this case you get:

<?xml version="1.0"?>
<response xmlns:api="http://icbl.macs.hw.ac.uk/sux0rAPI/api/xmlns">
  <api:userNickname>philb</api:userNickname>
  <api:vectors>
    <api:vector>
      <api:vectorID>6</api:vectorID>
      <api:vectorName>WorkInterest</api:vectorName>
    </api:vector>

    <api:vector>
      <api:vectorID>33</api:vectorID>
      <api:vectorName>CETIS-Domain</api:vectorName>
    </api:vector>
  </api:vectors>
</response>

Return vectors for a user’s category

The full design for this feature is available, however the current implementation does not cover the authentication requirements.

The API call is an HTTP GET on [sux0rURL]/api/categories/ (where [sux0rURL] is the URL for your sux0r installation, for this project that is http://icbl.macs.hw.ac.uk/sux0rAPI/icbl/ ). There are two required parameters
user to specify a username
vec_id to specify the id of a vector used by that user.

examples
HTTP GET on http://icbl.macs.hw.ac.uk/sux0rAPI/icbl/api/categories/?user=philb&vec_id=6 will return a list the categories used by philb (me) for the vector with id number 6 (which is “work interest”). The data returned is pretty self-explanatory, in this case you get:

<?xml version="1.0"?>
<response xmlns:api="http://icbl.macs.hw.ac.uk/sux0rAPI/api/xmlns">
  <api:userNickname>philb</api:userNickname>
  <api:categories>
    <api:vector>
      <api:vectorID>6</api:vectorID>
      <api:vectorName>WorkInterest</api:vectorName>
    </api:vector>

    <api:category>
      <api:categoryID>12</api:categoryID>
      <api:categoryName>interesting</api:categoryName>
    </api:category>
    <api:category>
      <api:categoryID>13</api:categoryID>
      <api:categoryName>not interesting</api:categoryName>

    </api:category>
  </api:categories>
</response>

Error trapping
Unfortunately we couldn’t implement the error codes properly on our server, you get an HTTP status code of 200-OK whether or not it is. However if you specify an invalid user name or vector id you do get sensible error messages returned, which include links to set you on the right track.

Advertisements

1 Comment

Filed under technical

One response to “Features: ReturnVectors and ReturnCategories

  1. Pingback: BayesFF: Final post « Bayesian Feed Filter