APIMethods/1.2

TracNav

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.2

albums.addMedia

Adds media to album.

albums.create

Creates an album for logged in user.

albums.get

Retrieves a list of albums by albumid.

albums.getByGroup

Retrieves all visible albums of a group.
Note: this method is deprecated, hangouts and groups (method and id's) are deprecated, please use hubs.* methods and id's.

albums.getByHangout

Retrieves all visible albums of a hangout.
Note: this method is deprecated, hangouts and groups (method and id's) are deprecated, please use hubs.* methods and id's.

albums.getByUser

Retrieves all visible albums of a user.

albums.removeMedia

Remove media from album.

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.getByGroup

Retrieves the most recent blogs of a group.
Note: this method is deprecated, hangouts and groups (method and id's) are deprecated, please use hubs.* methods and id's.

blogs.getByHangout

Retrieves the most recent blogs of a hangout.
Note: this method is deprecated, hangouts and groups (method and id's) are deprecated, please use hubs.* methods and id's.

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.getPublic

Retrieve public blogs. Sorttype defines the sort.

blogs.getRespects

Retrieves the respects for a blogid.

chat.getLoginToken

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

cities.get

Retrieves cities.

countries.get

Retrieves countries.

events.addPresence

Adds user presence to event.

events.get

Retrieves a list of events by eventid.

events.getByGroup

Retrieves events of a group.
Note: this method is deprecated, hangouts and groups (method and id's) are deprecated, please use hubs.* methods and id's.

events.getByHangout

Retrieves events of a hangout.
Note: this method is deprecated, hangouts and groups (method and id's) are deprecated, please use hubs.* methods and id's.

events.getByLoggedin

Retrieves all events created by logged in user.

events.getByUserPresent

Retrieves all public events where the given user is present.

events.getPresence

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

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.getByGroup

Retrieves all gadgets of a group.
Note: this method is deprecated, hangouts and groups (method and id's) are deprecated, please use hubs.* methods and id's.

gadgets.getByHangout

Retrieves all gadgets of a hangout.
Note: this method is deprecated, hangouts and groups (method and id's) are deprecated, please use hubs.* methods and id's.

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.

groups.get

Retrieves a list of groups by groupid.
Note: this method is deprecated, hangouts and groups (method and id's) are deprecated, please use hubs.* methods and id's.

groups.getByShortname

Retrieves a list of groups by shortname.
Note: this method is deprecated, hangouts and groups (method and id's) are deprecated, please use hubs.* methods and id's.

groups.getByUser

Retrieves all groups of an user.
Note: this method is deprecated, hangouts and groups (method and id's) are deprecated, please use hubs.* methods and id's.

groups.getScraps

Retrieves the scraps for a group.
Note: this method is deprecated, hangouts and groups (method and id's) are deprecated, please use hubs.* methods and id's.

groups.search

Search for groups based on basic queries (keywords like city, name).
Note: this method is deprecated, hangouts and groups (method and id's) are deprecated, please use hubs.* methods and id's.

hangouts.get

Retrieves a list of hangouts by hangoutid.
Note: this method is deprecated, hangouts and groups (method and id's) are deprecated, please use hubs.* methods and id's.

hangouts.getByShortname

Retrieves a list of hangouts by shortname.
Note: this method is deprecated, hangouts and groups (method and id's) are deprecated, please use hubs.* methods and id's.

hangouts.getByUser

Retrieves all hangouts of an user.
Note: this method is deprecated, hangouts and groups (method and id's) are deprecated, please use hubs.* methods and id's.

hangouts.getScraps

Retrieves the scraps for a hangout.
Note: this method is deprecated, hangouts and groups (method and id's) are deprecated, please use hubs.* methods and id's.

hangouts.search

Search for hangouts based on basic queries (keywords like city, name).
Note: this method is deprecated, hangouts and groups (method and id's) are deprecated, please use hubs.* methods and id's.

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.addTag

Adds a list of coma separated tags to a media.

media.createRespect

Creates respect for an mediaid.

media.get

Retrieves a list of media by mediaid.

media.getByAlbum

Retrieves all media from an album.

media.getByLoggedin

Retrieves all media by logged in user.

media.getByTag

Retrieves public media by tag.

media.getComments

Retrieves the comments for a mediaid.

media.getPublic

Retrieve public media. Sorttype defines the sort.

media.getRespects

Retrieves the respects for a mediaid.

media.getUploadToken

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

media.updateGeolocation

Update or create geolocation of a media.

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.

privatespots.create

Creates a privatespot.

privatespots.get

Retrieves a list of privatespots by privatespotid.

privatespots.getByLoggedin

Retrieves all privatespots of logged in user.

regions.get

Retrieves regions.

tips.create

Creates a tip.

tips.createRespect

Creates respect for an tipid.

tips.get

Retrieves a list of tips by tipid.

tips.getByHangout

Retrieves the most recent tips of a hangout.
Note: this method is deprecated, hangouts and groups (method and id's) are deprecated, please use hubs.* methods and id's.

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.getByFriendLastlogin

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

users.getByGroupLastlogin

Retrieves users for any group, limited to 150 users sorted by last login.
Note: this method is deprecated, hangouts and groups (method and id's) are deprecated, please use hubs.* methods and id's.

users.getByHangoutLastlogin

Retrieves users for any hangout, limited to 150 users sorted by last login.
Note: this method is deprecated, hangouts and groups (method and id's) are deprecated, please use hubs.* methods and id's.

users.getByUsername

Retrieves basic information for one or more users.

users.getFriendsByLoggedinSorted

Retrieves friends by loggedin user with different sort-options.

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.getSmileyCategories

Retrieves the existing smiley categories.

users.getSmileys

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

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.getByHangout

Retrieves the most recent public www(Who What Where)s of a hangout.
Note: this method is deprecated, hangouts and groups (method and id's) are deprecated, please use hubs.* methods and id's.

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.