API Method: profiles update

PUT /:user_id/profiles/:folder_id/from/:document_id

Updates a profiles folder in the specified user account. Returns a representation of the updated profiles folder with a 200 OK HTTP status code.

A recalculation of the entire profiles folder will be performed if any of the computational parameters change - i.e. parameters, such as document_id, remove_stopwords or threshold, that affect the calculation of statistics or which of the terms are retained. If no computational parameters have changed then the recalculate method must be called explicitly if a recalculation is required.

URL:

http://subsift.ilrt.bris.ac.uk/user_id/profiles/folder_id/from/document_id.format
or
http://subsift.ilrt.bris.ac.uk/user_id/profiles/folder_id.format

Formats (about return formats):

csv, json, rdf, terms, xml, yaml

HTTP Methods (about HTTP methods):

PUT

Clients that can not issue PUT requests can use POST with the added parameter _method=PUT

Requires Authentication (about authentication):

true

Parameters:

Usage Examples:

cURL (about cURL):

curl -X PUT -H "Token:mytoken" -d "full=1" http://subsift.ilrt.bris.ac.uk/kdd09/profiles/pc.xml

Response (about return values):

XML example:

<?xml version="1.0" encoding="UTF-8"?>
<result>
  <folder>
    <id>pc</id>
    <document_id>pc</document_id>
    <created>1266793611</created>
    <description>KDD09 Programme Committee</description>
    <ignore_case>1</ignore_case>
    <limit>100000</limit>
    <mode>private</mode>
    <modified>1268566365</modified>
    <ngrams>1,2</ngrams>
    <remove_html>1</remove_html>
    <remove_stopwords>1</remove_stopwords>
    <stopwords>a,about,above,across, ... ,yourselves</stopwords>
    <term>
      <name>faq</name>
      <dt>220</dt>
      <n>432</n>
    </term>
    <term>
      <name>author</name>
      <dt>220</dt>
      <n>238</n>
    </term>
    <term>
      <name>home</name>
      <dt>220</dt>
      <n>225</n>
    </term>
    .
    .
    .
    <term>
      <name>timescale</name>
      <dt>1</dt>
      <n>1</n>
    </term>
    <term>
      <name>schism</name>
      <dt>1</dt>
      <n>2</n>
    </term>
    <threshold>0</threshold>
  </folder>
</result>