Context Navigation

Note: The Method pages have been moved to a new documentation environment. Please see http://www.hyves-developers.nl. You can still browse these pages but the formatting is a bit messed up.

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 2.0

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

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

albums.getByHub

Retrieves all visible albums of a hub.

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.

batch.process

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

blogs.create

Creates a blog.

blogs.createRespect

Creates respect for a blogid.

blogs.get

Retrieves a list of blogs by blogid.

blogs.getByHub

Retrieves the most recent blogs of a hub.

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.

blogs.update

Updates a blog.

buzz.getFamous

Retrieves buzz for famous hyvers.

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

Retrieves events of a hub.

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.

events.getPresenceForFriends

Retrieves all userid's for the friends 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.getConnection

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

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

Creates a gadget by XML url (OpenSocial gadgets).

gadgets.createRespect

Creates respect for an gadgetid.

gadgets.get

Retrieves a list of gadgets by gadgetid.

gadgets.getByHub

Retrieves all gadgets of a hub.

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.

hubcategories.get

Retrieves a list of hubcategories by hubcategoryid.

hubcategories.getByHubType

Retrieves all hubcategories by hubtype.

hubcategories.getChildren

Retrieves a list of children hubcategories of a parent hubcategoryid.

hubs.get

Retrieves a list of hubs by hubid.

hubs.getByHubCategory

Retrieves all hubs within given hubcategoryid.

hubs.getByShortname

Retrieves a list of hubs by shortname.

hubs.getByUser

Retrieves all hubs of an user.

hubs.getHubTypes

Retrieves all the hubtypes.

hubs.getScraps

Retrieves the scraps for a hub.

hubs.search

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

hubs.updateMedia

Updates the media associated with a hub.

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

Adds a spotted user to the media.

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

Retrieves 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

Retrieves the respects for a mediaid.

media.getSpotted

Retrieve the spotted users on a media.

media.getUploadToken

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

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.

search.find

Search items in partical categories by searchterms.

threads.get

Retrieves a list of threads by threadid.

threads.getByHub

Retrieves all threads of a hub.

threads.getComments

Retrieves the comments for a threadid.

tips.create

Creates a tip.

tips.createRespect

Creates respect for an tipid.

tips.get

Retrieves a list of tips by tipid.

tips.getByHub

Retrieves the most recent tips of a hub.

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

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

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.

Download in other formats:

Plain Text

Context Navigation

Specs

methods

Note: The Method pages have been moved to a new documentation environment. Please see http://www.hyves-developers.nl. You can still browse these pages but the formatting is a bit messed up.

Methods in version 2.0

Download in other formats: