Proofile API
Write Access
This API requires an OAuth authenticated client with the respective access rights. The API specifies Create, Update and Delete statements. All commands begin with http://api.proofile.org/oauth/ and do not require the user referencing parameters specified in the API introduction. The write API must be accessed using the HTTP POST method. All of these API calls target the user who granted access.
Profile Fields
Require write_profile access right.
Create
@param string field (required): the field type name, see here for a complete list of valid field names.
@param string value (optional): the value of this field, see the value encoding section.
@param string value_text (optional): special value type for `note` fields.
@param int export_u (optional): valid between 0 and 3, see here, defaulting to 3.
@param int export_m (optional): valid between 0 and 1, see here, defaulting to 1.
@return array(id, message): if 'id' is positive, it is the profile_field id; if it is 0 insertion has failed. An error message is attached if id is 0.
inserts a profile field to the user's profile.
default return type: JSON
available return type: CSV, JSON, XML, PHP, DUMP
Update
@param int id (required): the ID of this profile field
@param string value (optional): the value of this field, see the value encoding section.
@param string value_text (optional): special value type for `note` fields.
@param int export_u (optional): valid between 0 and 3, see here
@param int export_m (optional): valid between 0 and 1, see here
@return array(status, message): status is 1 if updated successfully, 0 otherwise. An error message is attached if status is 0.
updates the profile field with the given id, if it matches with the user.
default return type: JSON
available return type: CSV, JSON, XML, PHP, DUMP
Delete
@param int id (required): the ID of this profile field
@return array(status, message): status is 1 if updated successfully, 0 otherwise. An error message is attached if status is 0.
deletes the profile field with the given id, if it matches with the user.
default return type: JSON
available return type: CSV, JSON, XML, PHP, DUMP
Connections
Require write_connection access right.
Create
@param string type (required): Either "account", "feed", or "foaf".
@param string url (required): A valid URL.
@param string name (optional): visually displayed name of the connection.
@param int export_u (optional): valid between 0 and 3, see here, defaulting to 3.
@param int export_m (optional): valid between 0 and 1, see here, defaulting to 1.
@return array(id, type, message): if 'id' is positive, it is the profile_field id; if it is 0 insertion has failed. An error message is attached if id is 0. The type denotes what type Proofile has determined the url to be (account, feed, or foaf).
insert a connection to the user's connections.
default return type: JSON
available return type: CSV, JSON, XML, PHP, DUMP
Update
@param int id (required): the ID of this connection
@param string type (required): Either "account", "feed", or "foaf".
@param string url (optional): A valid URL.
@param string name (optional): visually displayed name of the connection.
@param int export_u (optional): valid between 0 and 3, see here
@param int export_m (optional): valid between 0 and 1, see here
@return array(status, message): status is 1 if updated successfully, 0 otherwise. An error message is attached if status is 0.
updates the connection with the given id, if it matches with the user.
default return type: JSON
available return type: CSV, JSON, XML, PHP, DUMP
Delete
@param int id (required): the ID of this connection
@param string type (required): Either "account", "feed", or "foaf".
@return array(status, message): status is 1 if updated successfully, 0 otherwise. An error message is attached if status is 0.
deletes the connection with the given id, if it matches with the user.
default return type: JSON
available return type: CSV, JSON, XML, PHP, DUMP
