APIMethods/1.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 at hyves-api@….
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.

Methods in version 1.0

albums.get

Retrieves a list of albums by albumid.

albums.getByUser

Retrieves all visible albums of a user.

auth.accesstoken

Retrieves 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

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

auth.revoke

Revokes all accesstokens for user.

auth.revokeAll

Revokes all accesstokens for Consumer.

auth.revokeSelf

Revokes current accesstoken.

blogs.create

Creates a blog.

blogs.createRespect

Creates respect for a blogid.

blogs.get

Retrieves a list of blogs by blogid.

blogs.getByTag

Retrieves public blogs by tag.

blogs.getByUser

Retrieves the most recent blogs of a user.

blogs.getComments

Retrieves the comments for a blogid.

blogs.getForFriends

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

blogs.getRespects

Retrieves the respects for a blogid.

cities.get

Retrieves cities.

countries.get

Retrieves countries.

fancylayout.parse

Converts a string to HTML format the same way that that is being done on the site, including things like smilies. See <a href='http://www.hyves-developers.nl/documentation/data-api/fancy-layout'>ha_fancylayout</a> for more information.

friends.get

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

friends.getDistance

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

friends.getIncomingInvitations

Retrieves all incoming invitations for the logged in user.

friends.getOutgoingInvitations

Retrieves all outgoing invitations for the logged in user.

gadgets.create

Creates a gadget.

gadgets.createRespect

Creates respect for an gadgetid.

gadgets.get

Retrieves a list of gadgets by gadgetid.

gadgets.getByUser

Retrieves all visible gadgets of a user.

gadgets.getComments

Retrieves the comments for a gadgetid.

gadgets.getRespects

Retrieves the respects for a gadgetid.

listeners.create

Create a listener for the ApiConsumer. See <a href='http://www.hyves-developers.nl/documentation/data-api/listeners-callbacks-hyves-api'>listeners</a> for more information.

listeners.delete

Delete a listener for the ApiConsumer?. See <a href='http://www.hyves-developers.nl/documentation/data-api/listeners-callbacks-hyves-api'>listeners</a> for more information.

listeners.get

Retrieves listeners.

listeners.getAll

Retrieves all listeners.

listeners.getByType

Retrieves listeners by type.

media.createRespect

Creates respect for an mediaid.

media.get

Retrieves a list of media by mediaid.

media.getAlbums

Retrieves all visible albums of a user.
Note: this method is deprecated, please use albums.getByUser.

media.getByAlbum

Retrieves all media from an album.

media.getByTag

Retrieves public media by tag.

media.getComments

Retrieves the comments for a mediaid.

media.getRespects

Retrieves the respects for a mediaid.

pings.get

Retrieves a list of pings by pingid.

pings.getByTargetUser

Retrieves the pings of the target user.

pings.getByUser

Retrieves the pings of a user.

regions.get

Retrieves regions.

tips.createRespect

Creates respect for an tipid.

tips.get

Retrieves a list of tips by tipid.

tips.getByUser

Retrieves the most recent tips of a user.

tips.getCategories

Retrieves all tip categories.

tips.getComments

Retrieves the comments for a tipid.

tips.getForFriends

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

tips.getRespects

Retrieves the respects for a tipid.

users.createRespect

Creates respect for an userid.

users.get

Retrieves basic information for one or more users.

users.getByUsername

Retrieves basic information for one or more users.

users.getLoggedin

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

users.getRespects

Retrieves the respects for an userid.

users.getScraps

Retrieves the scraps for an user.

users.getTestimonials

Retrieves the testimonials for an userid.

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.

users.searchInFriends

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

wwws.create

Creates a www.

wwws.get

Retrieves a list of wwws by wwwid.

wwws.getByUser

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

wwws.getForFriends

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