Data-API

 

Methods

Version 2.0

We are, as always, extremely interested in your feedback. If you find something unclear or something that could be improved, either in the API itself, the documentation, or in something else surrounding the API, please contact us.
note: Because we want to be able to extend the returned fields, the order in which the fields occur in the XML (or JSON) cannot be relied upon, and use of methods like "firstchild" to traverse the XML might result in unexpected results when we change the order! Parsers like XPath will not have any problem here.

media

albums.addMedia

Add media to album.

albums.create

Create an album for logged in user.

albums.get

Retrieve a list of albums by albumid.

albums.getBuiltin

Retrieve one or more default (always existing) album(s) for logged in user.

albums.removeMedia

Remove media from album.

hubs.updateMedia

Update the media associated with a hub.

media.addSpotted

Add a spotted user to the media.

media.addTag

Add a list of coma separated tags to a media.

media.createRespect

Create respect for an mediaid.

media.get

Retrieve a list of media by mediaid.

media.getByAlbum

Retrieve all media from an album.

media.getByTag

Retrieve public media by tag.

media.getComments

Retrieve the comments for a mediaid.

media.getMediaEditToken

Retrieve a token that can be used to edit a media. Using this token, a new media upload action can be started, with other parameters. For convenience, the method returns the original url and current rotation degrees. The token is valid only for generating one new media.

media.getPublic

Retrieve public media. Sorttype defines the sort.

media.getRespects

Retrieve the respects for a mediaid.

media.getSpotted

Retrieve the spotted users on a media.

media.getUploadToken

Retrieve an upload token and ip-address to initiate the upload of media.

media.update

Update a media.

media.updateGeolocation

Update or create geolocation of a media.

hubs, media

albums.getByHub

Retrieve all visible albums of a hub.

media, users

albums.getByUser

Retrieve all visible albums of a user.

media.getByLoggedin

Retrieve all media by logged in user.

auth

auth.accesstoken

Retrieve an access token. The oauth_token parameter should contain an authorized request token. The access token will be valid for the methods the request token was requested for.

auth.requesttoken

Retrieve a request token. The oauth_token parameter should be absent.

auth.revoke

Revoke all accesstokens for user.

auth.revokeAll

Revoke all accesstokens for Consumer.

auth.revokeSelf

Revoke current accesstoken.

other

batch.process

Execute multiple (up to 10) API requests in 1 API-call.

listeners.create

Create a listener for the !ApiConsumer. See listeners for more information.

listeners.delete

Delete a listener for the ApiConsumer. See listeners for more information.

listeners.get

Retrieve listeners.

listeners.getAll

Retrieve all listeners.

listeners.getByType

Retrieve listeners by type.

blogs

blogs.create

Create a blog.

blogs.createRespect

Create respect for a blogid.

blogs.get

Retrieve a list of blogs by blogid.

blogs.getByTag

Retrieve public blogs by tag.

blogs.getComments

Retrieve the comments for a blogid.

blogs.getForFriends

Retrieve the most recent blogs for the friends of the loggedin user.

blogs.getPublic

Retrieve public blogs. Sorttype defines the sort.

blogs.getRespects

Retrieve the respects for a blogid.

blogs.update

Update a blog.

blogs, hubs

blogs.getByHub

Retrieve the most recent blogs of a hub.

blogs, users

blogs.getByUser

Retrieve the most recent blogs of a user.

buzz

buzz.getFamous

Retrieve buzz for famous hyvers.

chat

chat.getLoginToken

Get an server-ipadress and logintoken for the chat-system.

location

cities.get

Retrieve cities.

countries.get

Retrieve countries.

privatespots.create

Create a privatespot.

privatespots.get

Retrieve a list of privatespots by privatespotid.

regions.get

Retrieve regions.

events

events.addPresence

Add user presence to event.

events.get

Retrieve a list of events by eventid.

events.getByUserPresent

Retrieve all public events where the given user is present.

events.getPresence

Retrieve all userid's that are present for given event.

events, hubs

events.getByHub

Retrieve events of a hub.

events, users

events.getByLoggedin

Retrieve all events created by logged in user.

events, friends

events.getPresenceForFriends

Retrieve all userid's for the friends that are present for given event.

layout

fancylayout.parse

Converts a string to HTML format the same way that that is being done on the site, including things like smilies. See ha_fancylayout for more information.

users.getSmileyCategories

Retrieve the existing smiley categories.

users.getSmileys

Retrieve the smileys for the user the supplied access token is for.

friends

friends.get

Retrieve the friends of user the supplied access token is for.

friends.getConnection

Retrieve the connections between the user the access token is for and another user.

friends.getDistance

Retrieve the distance between the user the access token is for, and other users.

friends.getIncomingInvitations

Retrieve all incoming invitations for the logged in user.

friends.getOutgoingInvitations

Retrieve all outgoing invitations for the logged in user.

gadgets

gadgets.create

Create a gadget.

gadgets.createByXML

Create a gadget by XML url (OpenSocial gadgets).

gadgets.createRespect

Create respect for an gadgetid.

gadgets.get

Retrieve a list of gadgets by gadgetid.

gadgets.getComments

Retrieve the comments for a gadgetid.

gadgets.getRespects

Retrieve the respects for a gadgetid.

gadgets, hubs

gadgets.getByHub

Retrieve all gadgets of a hub.

gadgets, users

gadgets.getByUser

Retrieve all visible gadgets of a user.

hubs

hubcategories.get

Retrieve a list of hubcategories by hubcategoryid.

hubcategories.getByHubType

Retrieve all hubcategories by hubtype.

hubcategories.getChildren

Retrieve a list of children hubcategories of a parent hubcategoryid.

hubs.get

Retrieve a list of hubs by hubid.

hubs.getByHubCategory

Retrieve all hubs within given hubcategoryid.

hubs.getByShortname

Retrieve a list of hubs by shortname.

hubs.getByUser

Retrieve all hubs of a user.

hubs.getHubTypes

Retrieve all the hubtypes.

hubs.getScraps

Retrieve the scraps for a hub.

hubs, search

hubs.search

Search for hubs based on basic queries (keywords like city, name).

pings

pings.get

Retrieve a list of pings by pingid.

pings.getByTargetUser

Retrieve the pings of the target user.

pings.getByUser

Retrieve the pings of a user.

location, users

privatespots.getByLoggedin

Retrieve all privatespots of logged in user.

search

search.find

Search items in partical categories by searchterms.

users.search

Search for users based on basic queries (keywords like city, name). It uses a flat index with firstname, lastname, nickname and cityname, and uses boolean and. This means that looking for "Veenendaal" will return all users with "Veenendaal" in their firstname, lastname, nickname or cityname. Searching for "Reinoud Haarlem", will return all users with both those words in the concatnated string of firstname, lastname, nickname, and cityname.

forums

threads.get

Retrieve a list of threads by threadid.

threads.getComments

Retrieve the comments for a threadid.

forums, hubs

threads.getByHub

Retrieve all threads of a hub.

tips

tips.create

Create a tip.

tips.createRespect

Create respect for an tipid.

tips.get

Retrieve a list of tips by tipid.

tips.getByUser

Retrieve the most recent tips of a user.

tips.getCategories

Retrieve all tip categories.

tips.getComments

Retrieve the comments for a tipid.

tips.getRespects

Retrieve the respects for a tipid.

hubs, tips

tips.getByHub

Retrieve the most recent tips of a hub.

friends, tips

tips.getForFriends

Retrieve the most recent tips for the friends of the loggedin user.

users

users.createRespect

Create respect for a userid.

users.get

Retrieve basic information for one or more users.

users.getByHubLastlogin

Retrieve users for any hub, limited to 150 users sorted by last login.

users.getByUsername

Retrieve basic information for one or more users.

users.getLoggedin

Retrieve the basic information for user the supplied access token is for.

users.getRespects

Retrieve the respects for a userid.

users.getScraps

Retrieve the scraps for a user.

users.getTestimonials

Retrieve the testimonials for a userid.

friends, users

users.getByFriendLastlogin

Retrieve friends for any visible user, limited to 150 users sorted by last login.

users.getFriendsByLoggedinSorted

Retrieve friends by loggedin user with different sort-options.

friends, search

users.searchInFriends

Search for friends based on basic queries (keywords like city, name).

wwws

wwws.create

Create a www.

wwws.createRespect

Create respect for an wwwid.

wwws.get

Retrieve a list of wwws by wwwid.

wwws.getComments

Retrieve the comments for a wwwid.

wwws.getRespects

Retrieve the respects for a wwwid.

wwws.searchPublic

Search for public www's.

hubs, wwws

wwws.getByHub

Retrieve the most recent public www(Who What Where)s of a hub.

users, wwws

wwws.getByUser

Retrieve the most recent www(Who What Where)s of a user.

friends, wwws

wwws.getForFriends

Retrieve the most recent www(Who What Where)s for the friends (1 www max per friend) of the loggedin user.