Description

Cohere API functions

This page describes the services currently available through the Cohere API. The service base URL is:

     http://cohere.open.ac.uk/api/service.php
and it will always require a 'method' parameter.

In all service calls, an optional parameter 'format' can be provided to set how the output is displayed, the default is 'xml', but other options currently are 'gmap','json','list','rdf','rss', 'shortxml' and 'simile'. Not all formats are available with all methods, as explained below:

  • 'xml', 'json' and 'rdf' formats are available to all methods
  • 'rss' and 'shortxml' formats are only available to methods which return a NodeSet or ConnectionSet
  • 'gmap' and 'simile' formats are only available to methods which return a NodeSet.
  • 'list' format is available to methods which return a NodeSet or a TagSet.
If you specify 'json' as the output format, then you can (optionally) provide a parameter 'callback'.</p> Although all the example services calls show the parameters passed as GET requests, parameters will be accepted as either GET or POST - so the parameters can be provided in any order - not just the order in which they've been listed on this page.

Some services require a valid user login to work (essentially any add, edit or delete method) and in these cases, when you call the service, you must also provide a valid Cohere session cookie, this can be obtained by calling the login service. If you are calling the services via your web browser, you won't need to worry much about this, as your browser will automatically store and send the cookie with each service call.

Example service calls:

     http://cohere.open.ac.uk/api/service.php?method=getnode&nodeid=131211811270778613001206700042870488149
     http://cohere.open.ac.uk/api/service.php?method=getnodesbyuser&userid=1371081452501184165093
     http://cohere.open.ac.uk/api/service.php?method=getnodesbyuser&userid=1371081452501184165093&format=json
     http://cohere.open.ac.uk/api/service.php?method=getnodesbyuser&userid=1371081452501184165093&format=rdf
     http://cohere.open.ac.uk/api/service.php?method=getnodesbyuser&userid=1371081452501184165093&format=xml

Below it is noted which services require the user to be logged in

Note that if any required parameters are missing from a service call, then an error object will be returned detailing the missing parameter.

For any datetime parameter the following formats will be accepted:

  • 14 May 2008
  • 14-05-2008
  • 14 May 2008 9:00
  • 14 May 2008 9:00PM
  • 14-05-2008 9:00PM
  • 9:00
  • 14 May
  • wed
  • wed 9:00
and the following formats would not be accepted:

  • 14 05 2008
  • 14/05/2008
  • 14 05 2008 9:00
  • 14/05/2008 9:00
  • 14-05

Services
addconnection

Add a Connection. Requires login.

Parameters:
  • string fromnodeid
  • string fromroleid
  • string linktypeid
  • string tonodeid
  • string toroleid
  • string private optional, can be Y or N, defaults to users preferred setting
  • return: Connection or Error
back to service index | back to top
addfeed

Add a new feed. Requires login.

Parameters:
  • string url
  • string name
  • string regular - optional, can be 'Y' or 'N' (default N) and indicates whether Cohere should regularly call the feed to update
  • return: Feed or Error
back to service index | back to top
addgroup

Add a new group. Requires login.

Parameters:
  • string groupname
  • return: Group or Error
back to service index | back to top
addgroupmember

Add a user to a group. Requires login and user must be an admin for the group.

Parameters:
  • string groupid
  • string userid
  • return: Group or Error
back to service index | back to top
addgrouptoconnection

Add a group to a Connection. Requires login, user must be the connection owner and member of the group.

Parameters:
  • string connid
  • string groupid
  • return: Connection or Error
back to service index | back to top
addgrouptoconnections

Add a group to a set of connections. Requires login, user must be the connection owner and member of the group.

Parameters:
  • string connids
  • string groupid
  • return: Result or Error
back to service index | back to top
addgrouptonode

Add a group to a node. Requires login, user must be the node owner and member of the group.

Parameters:
  • string nodeid
  • string groupid
  • return: Node or Error
back to service index | back to top
addgrouptonodes

Add a group to a set of nodes. Requires login, user must be the node owner and member of the group.

Parameters:
  • string nodeids
  • string groupid
  • return: Result or Error
back to service index | back to top
addlinktype

Add a linktype (will return the existing one if it's already in the db).

Requires login.

Parameters:
  • string label
  • string linktypegroup
  • return: LinkType or Error
back to service index | back to top
addnode

Add a node. Requires login

Parameters:
  • string name
  • string desc
  • string private optional, can be Y or N, defaults to users preferred setting
  • string nodetypeid optional, the id of the nodetype this node is, defaults to 'Idea' node type id.
  • string imageurlid optional, the urlid of the url for the image that is being used as this node's icon
  • string imagethumbnail optional, the local server path to the thumbnail of the image used for this node
  • return: Node or Error
back to service index | back to top
addnodesbyid

Adds nodes. Requires login.

Purpose of this function is to allow the importing of another users nodes into the users workspace, and more than one at a time can be added

Parameters:
  • string nodeids
  • return: Result or Error
back to service index | back to top
addrole

Add new role - if the role already exists then this existing role object will be returned. Login required.

Parameters:
  • string rolename
  • string image, optional parameter local path to an image file (uploaded onto server).
  • image
  • return: Role or Error
back to service index | back to top
addtag

Add new tag - if the tag already exists then this existing tag object will be returned. Login required.

Parameters:
  • string tagname
  • return: Role or Error
back to service index | back to top
addtagstoconnections

Add the given tag labels to the given connection ids

Parameters:
  • $tags tags the comma separated list of tags to add
  • $connids connids the comma separated list of connetion id to add tags to
back to service index | back to top
addtagstonodes

Add the given tag labels to the given node ids

Parameters:
  • $tags tags the comma separated list of tags to add
  • $nodeids nodeids the comma separated list of node id to add tags to
back to service index | back to top
addtagstourls

Add the given tag labels to the given urls ids

Parameters:
  • $tags tags the comma separated list of tags to add
  • $urlids urlids the comma sepsrated list of url id to add tags to
back to service index | back to top
addtolog

Add to the log

Parameters:
  • string action
  • string type
  • string id
  • return: Result or Error
back to service index | back to top
addtousercache

Add item to users cache (bookmarks). Login required.

Parameters:
  • string idea the id of the idea to add
  • return: UserCache or Error
back to service index | back to top
addurl

Add a URL. Requires login

Parameters:
  • string url
  • string title
  • string desc
  • string private optional, can be Y or N, defaults to users preferred setting
  • string clip (optional);
  • string clippath (optional) - only used by Firefox plugin
  • string cliphtml (optional) - only used by Firefox plugin
  • return: URL or Error
back to service index | back to top
addurltonode

Add a URL to a Node. Requires login, user must be owner of both the node and URL

Parameters:
  • string urlid
  • string nodeid
  • string comments (optional)
  • return: Node or Error
back to service index | back to top
autocompleteurldetails

Go and try and automatically retrieve the title and descritpion for the given url.

Parameters:
  • string url
  • return: URL or Error
back to service index | back to top
clearusercache

Empties the users cache (bookmarks). Login required.

  • return: UserCache or Error
back to service index | back to top
copyconnection

Copy a Connection. Requires login

Parameters:
  • string connid
  • return: Connection or Error
back to service index | back to top
deleteconnection

Delete a connection. Requires login and user must be owner of the connection

Parameters:
  • string connid
  • return: Result or Error
back to service index | back to top
deleteconnections

Deletes a set of connections. Requires login and user must be owner of each connection.

Parameters:
  • string connids (comma separated list of connids)
  • return: Result or Error
back to service index | back to top
deletefeed

Delete a feed. Requires login and user must be owner of the feed.

Parameters:
  • string feedid
  • return: Result or Error
back to service index | back to top
deletefromusercache

Delete item from users cache (bookmarks). Login required.

Parameters:
  • string idea the id of the idea to delete
  • return: UserCache or Error
back to service index | back to top
deletegroup

Delete a group. Requires login and user must be an admin for the group.

Parameters:
  • string groupid
  • return: Result or Error
back to service index | back to top
deletelinktype

Delete a linktype. Requires login and user must be owner of the linktype

Parameters:
  • string linktypeid
  • return: Result or Error
back to service index | back to top
deletenode

Delete a node. Requires login and user must be owner of the node.

Parameters:
  • string nodeid
  • return: Result or Error
back to service index | back to top
deletenodes

Deletes a set of nodes. Requires login and user must be owner of each node.

Parameters:
  • string nodeids (comma separated list of nodeids)
  • return: Result or Error
back to service index | back to top
deleterole

Delete a role. Requires login and user must be owner of the role.

Connections using this role will have the role replaced by the default one.

Parameters:
  • string roleid
  • return: Result or Error
back to service index | back to top
deletesearch

Delete the search with the given id

Parameters:
  • string searchid
  • return: Result or Error
back to service index | back to top
deletesearchagent

Delete the search agent for the given search and agent id

Parameters:
  • string searchid the id of the search whose gent to delete
  • string agentid the id of the agent to delete
  • return: Result or Error
back to service index | back to top
deletetag

Delete a tag. Requires login and user must be owner of the tag.

Parameters:
  • string tagid
  • return: Result or Error
back to service index | back to top
deleteurl

Delete a URL. Requires login and user must be owner of the URL

Parameters:
  • string urlid
  • return: URL or Error
back to service index | back to top
editconnection

Edit a Connection. Requires login and user must be owner of the connection

Parameters:
  • string connid
  • string fromnodeid
  • string fromroleid
  • string linktypeid
  • string tonodeid
  • string toroleid
  • string private optional, can be Y or N, defaults to users preferred setting
  • return: Connection or Error
back to service index | back to top
editlinktype

Edit a linktype. Requires login and user must be owner of the linktype

Parameters:
  • string linktypeid
  • string linktypelabel
  • return: LinkType or Error
back to service index | back to top
editnode

Edit a node. Requires login and user must be owner of the node.

Parameters:
  • string private optional, can be Y or N, defaults to users preferred setting
  • string nodetypeid optional, the id of the nodetype this node is, defaults to 'Idea' node type id.
  • string imageurlid optional, the urlid of the url for the image that is being used as this node's icon
  • string imagethumbnail optional, the local server path to the thumbnail of the image used for this node
  • string nodeid nodeid
  • string name name
  • string desc desc
  • return: Node or Error
back to service index | back to top
editrole

Edit a role. Requires login and user must be owner of the role

Parameters:
  • string roleid
  • string rolename
  • string image, optional parameter local path to an image file (uploaded onto server).
  • image
  • return: Role or Error
back to service index | back to top
edittag

Edit a tag. If that tag name already exists for this user, return an error.

Requires login and user must be owner of the tag

Parameters:
  • string tagid
  • string tagname
  • return: Tag or Error
back to service index | back to top
editurl

Edit a URL. Requires login and user must be owner of the URL

Parameters:
  • string urlid
  • string url
  • string title
  • string desc
  • string private optional, can be Y or N, defaults to users preferred setting
  • string clippath (optional) - only used by Firefox plugin
  • string cliphtml (optional) - only used by Firefox plugin
  • clip
  • return: URL or Error
back to service index | back to top
feedsetregular

Change whether or not the feed is regularly updated. Requires login and user must be owner of the feed.

Parameters:
  • string feedid
  • string regular
  • return: Feed or Error
back to service index | back to top
getactiveconnectionusers

Get the users with the most connections (excludes groups)

Parameters:
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a users details to load (long includes: tags and groups).
  • return: UserSet or Error
back to service index | back to top
getactiveideausers

Get the users with the most ideas (excludes groups)

Parameters:
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a users details to load (long includes: tags and groups).
  • return: UserSet or Error
back to service index | back to top
getalllinktypes

Get all the linktypes for the current user

  • return: LinkTypeSet or Error
back to service index | back to top
getallroles

Get all roles

  • return: RoleSet or Error
back to service index | back to top
getclipsbynodeandurl

Get the clips for the given url where the url has been joined to the given node id

Parameters:
  • string url the url to get the clips for
  • string nodeid to get the url's clips for
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a urls details to load (long includes: tags, groups).
  • return: URLSet or Error
back to service index | back to top
getclipsbyurl

Get the urls with clips for given url (note that this uses the actual URL rather than the urlid)

Parameters:
  • string url
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a urls details to load (long includes: tags, groups).
  • return: URLSet or Error
back to service index | back to top
getclipsbyurlnoidea

Get the urls with clips for given url but not attached to an idea.

(note that this uses the actual URL rather than the urlid)

Parameters:
  • string url
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a urls details to load (long includes: tags, groups).
  • return: URLSet or Error
back to service index | back to top
getconnectednodes

Get nodes which are connected to other nodes

Parameters:
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'nodeid', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a nodes details to load (long includes: description, tags, groups and urls).
  • return: NodeSet or Error
back to service index | back to top
getconnection

Get a Connection

Parameters:
  • string connid
  • String style (optional - default 'long') may be 'short' or 'long'
  • return: Connection or Error
back to service index | back to top
getconnectionsbyfromlabel

Get the connections whose from idea labels are the same as the label of the node with the given node id

Parameters:
  • string nodeid
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • string filtergroup (optional, either 'all','selected','positive','negative' or 'neutral', default: 'all' - to filter the results by the link type group of the connection)
  • string filterlist (optional, comma separated strings of the connection labels to filter the results by, to have any effect filtergroup must be set to 'selected')
  • String style (optional - default 'long') may be 'short' or 'long'
  • return: ConnectionSet or Error
back to service index | back to top
getconnectionsbygroup

Get the connections for given group

Parameters:
  • string groupid
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • string filtergroup (optional, either 'all','selected','positive','negative' or 'neutral', default: 'all' - to filter the results by the link type group of the connection)
  • string filterlist (optional, comma separated strings of the connection labels to filter the results by, to have any effect filtergroup must be set to 'selected')
  • string filterusers (optional, a list of user ids to filter by)
  • String style (optional - default 'long') may be 'short' or 'long'
  • return: ConnectionSet or Error
back to service index | back to top
getconnectionsbylinktypelabel

Get the connections by link type

Parameters:
  • string linktypelabel = linktype label to search on - exact full label matching
  • string scope (either 'all' or 'my')
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long'
  • return: ConnectionSet or Error
back to service index | back to top
getconnectionsbynode

Get the connections for given label of the node with the given nodeid

Parameters:
  • string nodeid
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • string filtergroup (optional, either 'all','selected','positive','negative' or 'neutral', default: 'all' - to filter the results by the link type group of the connection)
  • string filterlist (optional, comma separated strings of the connection labels to filter the results by, to have any effect filtergroup must be set to 'selected')
  • String style (optional - default 'long') may be 'short' or 'long'
  • return: ConnectionSet or Error
back to service index | back to top
getconnectionsbypath

Get the connections for the given netowrk search paramters from the given node.

Parameters:
  • string nodeid the id of the node to search outward from.
  • string linklabels the string of link types.
  • string userid optional for searching only a specified user's data. (only used if scope is 'all') - NOT USED AT PRESENT
  • string scope (either 'all' or 'my')
  • string linkgroup (optional, either Positive, Negative, or Neutral - default: empty string);
  • integer depth (optional, 1-7, or 7 for full depth;
  • string direction (optional, 'outgoing', 'incmong', or 'both - default: 'both',
  • string labelmatch (optional, 'true', 'false' - default: false;
  • String style (optional - default 'long') may be 'short' or 'long'
  • return: ConnectionSet or Error
back to service index | back to top
getconnectionsbysearch

Get the connections for given search If in speech marks searches LIKE match on phrase, else splits on spaces and searches OR on elements

Parameters:
  • string q
  • string scope (either 'all' or 'my')
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • string filtergroup (optional, either 'all','selected','positive','negative' or 'neutral', default: 'all' - to filter the results by the link type group of the connection)
  • string filterlist (optional, comma separated strings of the connection labels to filter the results by, to have any effect filtergroup must be set to 'selected')
  • String style (optional - default 'long') may be 'short' or 'long'
  • return: ConnectionSet or Error
back to service index | back to top
getconnectionsbytagsearch

Search connections by thier tags splits on commas and searches OR on elements

Parameters:
  • string q
  • string scope (either 'all' or 'my')
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • string filtergroup (optional, either 'all','selected','positive','negative' or 'neutral', default: 'all' - to filter the results by the link type group of the connection)
  • string filterlist (optional, comma separated strings of the connection labels to filter the results by, to have any effect filtergroup must be set to 'selected')
  • String style (optional - default 'long') may be 'short' or 'long'
  • return: ConnectionSet or Error
back to service index | back to top
getconnectionsbytolabel

Get the connections whose to idea labels are the same as the label of the node with the given node id

Parameters:
  • string nodeid
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • string filtergroup (optional, either 'all','selected','positive','negative' or 'neutral', default: 'all' - to filter the results by the link type group of the connection)
  • string filterlist (optional, comma separated strings of the connection labels to filter the results by, to have any effect filtergroup must be set to 'selected')
  • String style (optional - default 'long') may be 'short' or 'long'
  • return: ConnectionSet or Error
back to service index | back to top
getconnectionsbyurl

Get the connections for given url

Parameters:
  • string url
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • string filtergroup (optional, either 'all','selected','positive','negative' or 'neutral', default: 'all' - to filter the results by the link type group of the connection)
  • string filterlist (optional, comma separated strings of the connection labels to filter the results by, to have any effect filtergroup must be set to 'selected')
  • String style (optional - default 'long') may be 'short' or 'long'
  • return: ConnectionSet or Error
back to service index | back to top
getconnectionsbyuser

Get the connections for given user

Parameters:
  • string userid
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • string filtergroup (optional, either 'all','selected','positive','negative' or 'neutral', default: 'all' - to filter the results by the link type group of the connection)
  • string filterlist (optional, comma separated strings of the connection labels to filter the results by, to have any effect filtergroup must be set to 'selected')
  • String style (optional - default 'long') may be 'short' or 'long'
  • return: ConnectionSet or Error
back to service index | back to top
getfeedsforuser

Gets all feeds for user. If userid not specified then the current user is assumed.

Parameters:
  • string userid
  • return: Feed or Error
back to service index | back to top
getgroup

Get a group

Parameters:
  • string groupid
  • return: Group or Error
back to service index | back to top
getlinktype

Get a linktype

Parameters:
  • string ltid
  • return: LinkType or Error
back to service index | back to top
getlinktypebylabel

Get a linktype by label

Parameters:
  • string label
  • return: LinkType or Error
back to service index | back to top
getmostconnectednodes

Get nodes which are most connected to other nodes

Parameters:
  • string scope (optional, either 'all' or 'my' - default 'all' )
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a nodes details to load (long includes: description, tags, groups and urls).
  • return: NodeSet or Error
back to service index | back to top
getmulticonnections

Get all connections from the given list of connection ids.

Parameters:
  • String connectionids a comma separated list of the connection ids to get.
  • integer start (optional - default: 0)
  • integer max (optional - default: -1 = all)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long'
  • return: ConnectionSet or Error
back to service index | back to top
getmyadmingroups

Get groups that current user is an admin for. Requires login.

  • return: GroupSet or Error
back to service index | back to top
getmygroups

Get all groups for current user. Requires login.

  • return: GroupSet or Error
back to service index | back to top
getnode

Get a node

Parameters:
  • string nodeid
  • string style (optional - default 'long') may be 'short' or 'long'
  • return: Node or Error
back to service index | back to top
getnodesbydate

Get the nodes for given date

Parameters:
  • integer date
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'nodeid', 'name', 'connectedness' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a nodes details to load (long includes: description, tags, groups and urls).
  • return: NodeSet or Error
back to service index | back to top
getnodesbyfirstcharacters

Searches nodes by node name based on the first chartacters

Parameters:
  • string q the query term(s)
  • string scope (optional, either 'all' or 'my' - default: 'my')
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'nodeid', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a nodes details to load (long includes: description, tags, groups and urls).
  • return: NodeSet or Error
back to service index | back to top
getnodesbygroup

Get the nodes for given group

Parameters:
  • string groupid
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'nodeid', 'name', 'connectedness' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • string filterusers (optional, a list of user ids to filter by)
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a nodes details to load (long includes: description, tags, groups and urls).
  • return: NodeSet or Error
back to service index | back to top
getnodesbyname

Get the nodes for given name

Parameters:
  • string name
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'nodeid', 'name', 'connectedness' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a nodes details to load (long includes: description, tags, groups and urls).
  • return: NodeSet or Error
back to service index | back to top
getnodesbynode

Get the nodes for given node. This returns the other nodes which share the same label as the given node (but will have been entered by another user).

Parameters:
  • string nodeid
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'nodeid', 'name', 'connectedness' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a nodes details to load (long includes: description, tags, groups and urls).
  • return: NodeSet or Error
back to service index | back to top
getnodesbysearch

Search nodes.

If in speech marks searches LIKE match on phrase, else splits on spaces and searches OR on elements

Parameters:
  • string q the query term(s)
  • string scope (optional, either 'my' or 'all' - default: 'all')
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'nodeid', 'name', 'connectedness' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a nodes details to load (long includes: description, tags, groups and urls).
  • return: NodeSet or Error
back to service index | back to top
getnodesbytag

Get the nodes for given tagid

Parameters:
  • string tagid
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'nodeid', 'name', 'connectedness' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a nodes details to load (long includes: description, tags, groups and urls).
  • return: NodeSet or Error
back to service index | back to top
getnodesbytagname

Get the nodes for given tagname

Parameters:
  • string tagname
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'nodeid', 'name', 'connectedness' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a nodes details to load (long includes: description, tags, groups and urls).
  • return: NodeSet or Error
back to service index | back to top
getnodesbytagsearch

Search nodes by their tags splits on commas and searches OR on elements

Parameters:
  • string q the query term(s)
  • string scope (optional, either 'my' or 'all' - default: 'all')
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'nodeid', 'name', 'connectedness' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a nodes details to load (long includes: description, tags, groups and urls).
  • return: NodeSet or Error
back to service index | back to top
getnodesbyurl

Get the nodes for given url (note that this uses the actual URL rather than the urlid)

Parameters:
  • string url
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'nodeid', 'name', 'connectedness' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a nodes details to load (long includes: description, tags, groups and urls).
  • return: NodeSet or Error
back to service index | back to top
getnodesbyurlid

Get the nodes for given urlid

Parameters:
  • string urlid the id of the url to get nodes for
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'nodeid', 'name', 'connectedness' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a nodes details to load (long includes: description, tags, groups and urls).
  • return: NodeSet or Error
back to service index | back to top
getnodesbyuser

Get the nodes for given user

Parameters:
  • string userid
  • integer start (optional - default: 0)
  • integer max (optional - default: 20), -1 means all
  • string orderby (optional, either 'date', 'nodeid', 'name', 'connectedness' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a nodes details to load (long includes: description, tags, groups and urls).
  • return: NodeSet or Error
back to service index | back to top
getpopularnodes

Get popular nodes

Parameters:
  • string scope (optional, either 'all' or 'my' - default 'all' )
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a nodes details to load (long includes: description, tags, groups and urls).
  • return: NodeSet or Error
back to service index | back to top
getrecentconnections

Get the recent connections

Parameters:
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long'
  • return: ConnectionSet or Error
back to service index | back to top
getrecentnodes

Get the recent nodes

Parameters:
  • string scope (optional, either 'all' or 'my' - default 'all' )
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'nodeid', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a nodes details to load (long includes: description, tags, groups and urls).
  • return: NodeSet or Error
back to service index | back to top
getrecentusers

Get the recent visitors (excludes groups)

Parameters:
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a users details to load (long includes: tags and groups).
  • return: UserSet or Error
back to service index | back to top
getrole

Get a role (by id)

Parameters:
  • string roleid
  • return: Role or Error
back to service index | back to top
getrolebyname

Get a role (by name)

Parameters:
  • string rolename
  • return: Role or Error
back to service index | back to top
getsearch

Get the search with the given id

Parameters:
  • string searchid
  • return: Search or Error
back to service index | back to top
gettag

Get a tag (by id)

Parameters:
  • string tagid
  • return: Tag or Error
back to service index | back to top
gettagbyname

Get a tag (by name)

Parameters:
  • string tagname
  • return: Tag or Error
back to service index | back to top
gettagsbyfirstcharacters

Searches tags by node name based on the first chartacters

Parameters:
  • string q the query term(s)
  • string scope (optional, either 'all' or 'my' - default: 'my')
  • return: TagSet or Error
back to service index | back to top
gettagsbynode

Get the tags for given nodeid. Login required.

  • return: TagSet or Error
back to service index | back to top
getunconnectednodes

Get nodes not connected to other nodes

Parameters:
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'nodeid', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a nodes details to load (long includes: description, tags, groups and urls).
  • return: NodeSet or Error
back to service index | back to top
geturl

Get a URL

Parameters:
  • string urlid
  • return: URL or Error
back to service index | back to top
geturlsbygroup

Get the urls for given group

Parameters:
  • string groupid
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • string filterusers (optional, a list of user ids to filter by)
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a urls details to load (long includes: tags, groups).
  • return: URLSet or Error
back to service index | back to top
geturlsbynode

Get the urls for all nodes with the same label as the node with the given node id

Parameters:
  • string nodeid
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a urls details to load (long includes: tags, groups).
  • return: URLSet or Error
back to service index | back to top
geturlsbysearch

Search urls If in speech marks searches LIKE match on phrase, else splits on spaces and searches OR on elements

Parameters:
  • string q the query term(s)
  • string scope (either 'all' or 'my')
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a urls details to load (long includes: tags, groups).
  • return: URLSet or Error
back to service index | back to top
geturlsbytagsearch

Search urls by their tags splits on commas and searches OR on elements

Parameters:
  • string q the query term(s)
  • string scope (either 'all' or 'my')
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a url's details to load (long includes: tags, groups).
  • return: NodeSet or Error
back to service index | back to top
geturlsbyurl

Get the urls for given url (note that this uses the actual URL rather than the urlid)

Parameters:
  • string url
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a urls details to load (long includes: tags, groups).
  • return: URLSet or Error
back to service index | back to top
geturlsbyuser

Get the urls for given user

Parameters:
  • string userid
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a urls details to load (long includes: tags, groups).
  • return: URLSet or Error
back to service index | back to top
getuser

Get a user

Parameters:
  • string userid
  • string format (optional - default 'long') may be 'short' or 'long'
  • return: User or Error
back to service index | back to top
getusercache

Get whats in the users cache (bookmarks). Login required.

  • return: UserCache or Error
back to service index | back to top
getusercachenodes

Searches user cache nodes (bookmarks). Login required.

Parameters:
  • string q the query term(s)
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'nodeid', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a nodes details to load (long includes: description, tags, groups and urls).
  • return: NodeSet or Error
back to service index | back to top
getuserlinktypes

Get all the linktypes for the current user

  • return: LinkTypeSet or Error
back to service index | back to top
getuserroles

Get the current user's roles. Login required.

  • return: RoleSet or Error
back to service index | back to top
getusersbygroup

Get the users for given group

Parameters:
  • string groupid
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a user's details to load (long includes: tags and groups).
  • return: UserSet or Error
back to service index | back to top
getusersbynode

Get the users for nodes with the node label of the given nodeid

Parameters:
  • string nodeid
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a user's details to load (long includes: tags and groups).
  • return: UserSet or Error
back to service index | back to top
getusersbysearch

Search users.

If in speech marks searches LIKE match on phrase, else splits on spaces and searches OR on elements

Parameters:
  • string q the query term(s)
  • string scope (must be 'all' or 'my')
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a user's details to load (long includes: tags and groups).
  • return: NodeSet or Error
back to service index | back to top
getusersbytagsearch

Search users by their tags and by the nodes they have tagged splits on commas and searches OR on elements

Parameters:
  • string q the query term(s)
  • string scope (must be 'all' or 'my')
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a user's details to load (long includes: tags, groups).
  • return: NodeSet or Error
back to service index | back to top
getusersbyurl

Get the users for given url

Parameters:
  • string url
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a user's details to load (long includes: tags and groups).
  • return: UserSet or Error
back to service index | back to top
getusersbyuser

Get the users for given user (bascially means any groups they are in)

Parameters:
  • string userid
  • integer start (optional - default: 0)
  • integer max (optional - default: 20)
  • string orderby (optional, either 'date', 'name' or 'moddate' - default: 'date')
  • string sort (optional, either 'ASC' or 'DESC' - default: 'DESC')
  • String style (optional - default 'long') may be 'short' or 'long' - how much of a user's details to load (long includes: tags and groups).
  • return: UserSet or Error
back to service index | back to top
getusersearches

Get all the saved searches for the current user

  • return: SearchSet or Error
back to service index | back to top
getusertags

Get the current user's tags. Login required.

  • return: TagSet or Error
back to service index | back to top
loadsearchagentrun

Run the agent associated with this network search

Parameters:
  • string searchid the id of the search whose agent to run
  • string runid the run id of the run to load.
  • return: ConnectionSet or Error
back to service index | back to top
loadsearchagentrunnew

Run the agent associated with this network search

Parameters:
  • string searchid the id of the search whose agent to run
  • string runid the run id of the run to load.
  • return: ConnectionSet or Error
back to service index | back to top
login

Logs a user in.

Parameters:
  • string username
  • string password
  • return: User or Error
back to service index | back to top
makegroupadmin

Make a user an admin of the group. Requires login and user must be an admin for the group.

Parameters:
  • string groupid
  • string userid
  • return: Group or Error
back to service index | back to top
refreshfeed

Refresh feed. Requires login and user must be owner of the feed.

Parameters:
  • string feedid
  • return: Feed or Error
back to service index | back to top
removeallgroupsfromconnection

Remove all groups from a Connection. Requires login, user must be the connection owner.

Parameters:
  • string connid
  • return: Result or Error
back to service index | back to top
removeallgroupsfromnode

Remove all groups from a node. Requires login, user must be the node owner.

Parameters:
  • string nodeid
  • return: Node or Error
back to service index | back to top
removeallurlsfromnode

Remove all URLs from a node. Requires login, user must be owner of the node

Parameters:
  • string nodeid
  • return: Result or Error
back to service index | back to top
removegroupadmin

Remove a user as admin of the group. Requires login and user must be an admin for the group.

Parameters:
  • string groupid
  • string userid
  • return: Group or Error
back to service index | back to top
removegroupfromconnection

Remove a group from a Connection. Requires login, user must be the connection owner and member of the group.

Parameters:
  • string connid
  • string groupid
  • return: Result or Error
back to service index | back to top
removegroupfromconnections

Remove a group from a set of Connections. Requires login, user must be the connections owner and member of the group.

Parameters:
  • string connids
  • string groupid
  • return: Result or Error
back to service index | back to top
removegroupfromnode

Remove a group from a node. Requires login, user must be the node owner and member of the group.

Parameters:
  • string nodeid
  • string groupid
  • return: Node or Error
back to service index | back to top
removegroupfromnodes

Remove a group from a set of nodes. Requires login, user must be the node owner and member of the group.

Parameters:
  • string nodeids
  • string groupid
  • return: Result or Error
back to service index | back to top
removegroupmember

Remove a user from a group. Requires login and user must be an admin for the group.

Parameters:
  • string groupid
  • string userid
  • return: Group or Error
back to service index | back to top
removeurlfromnode

Remove a URL from a Node. Requires login, user must be owner of both the node and URL

Parameters:
  • string urlid
  • string nodeid
  • return: Result or Error
back to service index | back to top
runsearchagent

Run the agent associated with this network search

Parameters:
  • string searchid the id of the search whose agent to run
  • String type type, who requested this run, the user themselves through an interface button push or an automated process like a nightly cron: values = 'user' or 'auto'; default = 'user';
  • return: Result or Error
back to service index | back to top
setgroupprivacy

Make all the users nodes and connections in a group private or public.

Requires login, user must be member of the group, and this will only update the nodes/connections that the user is the owner of.

Parameters:
  • string groupid
  • string private (must be either 'Y' or 'N')
  • return: Result or Error
back to service index | back to top
tweetuseridea

Tweet the idea with the given nodeid to the current user's twitter accounts, if setup.

Parameters:
  • $nodeid nodeid the id of the idea to tweet.
back to service index | back to top
updatenodeenddate

update a node end date. Requires login and user must be owner of the node.

Parameters:
  • string enddatetime optional text representation of start date and/or time
  • string nodeid nodeid
  • return: Node or Error
back to service index | back to top
updatenodelocation

update a node location. Requires login and user must be owner of the node.

Parameters:
  • string location optional
  • string loccountry optional
  • string nodeid nodeid
  • return: Node or Error
back to service index | back to top
updatenodestartdate

update a node start date. Requires login and user must be owner of the node.

Parameters:
  • string startdatetime optional text representation of start date and/or time
  • string nodeid nodeid
  • return: Node or Error
back to service index | back to top
validateusersession

Check that the session is active and valid for the user passed.

Parameters:
  • string userid
  • return: User or Error
back to service index | back to top

Documentation generated on Tue, 07 Dec 2010 13:28:21 +0000 by phpDocumentor 1.4.1