Return values

aboutme

An about me field that is shown with the users profile information.

fancy_layout

body --- more information

age

age of the user, in years

album

Contains data on an album.

extra

• This field is subject to visibility settings. This means that, depending on the users choice, the field be empty if you don't have an access token, or the loggedin user is not closely enough related.

albumid

The id of an album. An album can contain media.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

birthday

Contains the fields year, month, day and age. Note that not all of these fields need to be set; either the user has not filled in this information, or it is not visible to you. If the birthyear is visible, both age and year are set, if the birthday is visible, both day and month are set

extra

• This field is subject to visibility settings. This means that, depending on the users choice, the field be empty if you don't have an access token, or the loggedin user is not closely enough related.

blog

Contains data on a blog.

blogid

The id of a blog.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

body

The body of an object.

fancy_layout

body --- more information

callback

The URL the listener will do the callback to.

city

Contains the data on a city.

cityid

The id to the city.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.
• This field is subject to visibility settings. This means that, depending on the users choice, the field be empty if you don't have an access token, or the loggedin user is not closely enough related.

cityname

Contains the cityname (when a user is displayed; within a <city> tag, just <name> is used).

fancy_layout

naturalname --- more information

citytabid

The id of the nearest city that has a city tab. If this is equal to the cityid, the city is a city-tab. Only citytabs have urls.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

comment

Contains data on a comment.

commentid

The id of a comment.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

commentscount

The comments count for an object.

country

Contains the data on a country.

countryid

The id to the country.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

countryname

Contains the countryname (when a user is displayed; within a <country> tag, just <name> is used).

fancy_layout

naturalname --- more information

created

The date an object was created.

extra

• Timestamp <a href='http://en.wikipedia.org/wiki/Unix_time'>(POSIX time, Unix time)</a> is the number of seconds since 1-1-1970 0:00:00 UTC, corrected for leap seconds.

currentpage

See the <a href='http://www.hyves-developers.nl/documentation/data-api/info-block/'>info block</a>.

day

day in the range (1-31)

degree

The level of the network from the loggedin user to the other user, 0 means its the same person, 1 means they are friends, etc. Distance is only calculated up to the third degree, the field is empty if there is no distance found by third degree.

deletecount

The number of delete's.

description

The description of an object.

fancy_layout

body --- more information

displaybody

The displaybody of an object, usable for displaying.

fancy_layout

body --- more information

displayname

The displayname (with smilies) of the user as shown on Hyves.

distance

Contains the data on distance between the user in the accesstoken and some other user.

document

Contains information on the document (pdf) url of the media. Only available on videos.

fancy_layout

naturalname --- more information

emotion

The emotion part of a www.

fancy_layout

oneliner --- more information

event

Contains data on an event.

eventid

The id to the event.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

expiredate

The moment until which the accesstoken is valid.

extra

• Timestamp <a href='http://en.wikipedia.org/wiki/Unix_time'>(POSIX time, Unix time)</a> is the number of seconds since 1-1-1970 0:00:00 UTC, corrected for leap seconds.

fancylayouttag

Fancylayout tag, can be used in body fields in Hyves or as presentation in HTML (with using ha_fancylayout). Note: Media of the type video do not have a fancylayouttag, use the fancylayouttag of the video-icons instead.

firstname

The firstname for this user. Is used very rarely on the hyves website.

fancy_layout

naturalname --- more information

fl_string

Gefancylayoutte string.

friendgroup

Contains data on a friendgroup.

friendgroupid

The id to the friendgroup.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

friendinvitation

Contains data on a friendinvitation.

friendscount

Number of friends for this user.

gadget

Contains data on an widget.

extra

• This field is subject to visibility settings. This means that, depending on the users choice, the field be empty if you don't have an access token, or the loggedin user is not closely enough related.

gadgetid

The id of the widget.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

gender

The gender for the user.

extra

• This field is subject to visibility settings. This means that, depending on the users choice, the field be empty if you don't have an access token, or the loggedin user is not closely enough related.

geolocation

Geolocation data (latitude and longitude) of the item.

hangout

Contains data on a hangout.

hangoutid

The id of a hangout.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

hangoutvisible

Whether or not the hangout is visible to the user supplied with the accesstoken (or the anonymous user)

height

Height in pixels.

html

The html of the widget.

extra

• Note that this field is not html escaped, even if ha_fancylayout is set to true.

hub

Contains data on a hub.

hubaddress

Contains the data for address of the hub.

hubcategories

Contains the hubcategories of the hub.

hubcategory

Contains the data for categories of the hub.

hubcategoryid

The id of the hubcategory.

hubid

The id to the hub.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

hubopeninghours

Contains the data for the opening hours of the hub.

hubscount

Number of hubs for this item.

hubtype

The type of the hub.

hubvisible

Whether or not the hub is visible to the user supplied with the accesstoken (or the anonymous user)

icon_extralarge

Contains the data for an extra large icon that fits in a 200x200 rectangle.

icon_large

Contains the data for a large icon that fits in a 120x120 rectangle.

icon_medium

Contains the data for a medium icon that fits in a 75x75 rectangle, this is the size normally used on the site.

icon_small

Contains the data for a small icon that fits in a 50x50 rectangle.

image

Contains the data for the size we normally use on the site.

image_fullscreen

Contains the data for the largest image we have.

image_original

Contains the data for the original image.

info

See the <a href='http://www.hyves-developers.nl/documentation/data-api/info-block/'>info block</a>.

languagelocale

The language locale of the user.

lastname

The lastname for this user. Is used very rarely on the hyves website.

extra

• This field is subject to visibility settings. This means that, depending on the users choice, the field be empty if you don't have an access token, or the loggedin user is not closely enough related.

fancy_layout

naturalname --- more information

lastupdate

The moment when the last update was done, usable for ordering.

extra

• Timestamp <a href='http://en.wikipedia.org/wiki/Unix_time'>(POSIX time, Unix time)</a> is the number of seconds since 1-1-1970 0:00:00 UTC, corrected for leap seconds.

latitude

Latitude of the item, part of geolocation. Example latitude: 52.36222

listener

Contains data on a listener.

listenerid

The id of the listener.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

listenertype

The type of the listener

longitude

Longitude of the item, part of geolocation. Example longitude: 4.88421

maycopy

Whether this object may be copied by some other user.

media

Contains the data on a media.

mediacount

The number of media in an album.

mediaid

The id to the media.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

mediatype

The type of a media.

methods

Comma-separated list of ha_methods, indicating what the accesstoken is valid for. If this is empty, the accesstoken is valid for all methods that the Consumer has access to.

mobileurl

The link to the overview page for the item on the mobile webiste.

extra

We do not guarantee that the link is in any certain format, and it may change at any moment. The only guarantee is that it is a valid http url and will show the correct page when put in a browser.

month

month in the range (1-12)

name

The name of the object.

fancy_layout

naturalname --- more information

nickname

The nickname as filled in by the user.

fancy_layout

nickname --- more information

oauth_token

The oauth_token. This can be either a requesttoken (as a result from auth.requesttoken), or an accesstoken (as a result from auth.accesstoken).

extra

• For more information on oAuth, see <a href='http://www.hyves-developers.nl/documentation/data-api/hyves-api-oauth/'>http://www.hyves-developers.nl/documentation/data-api/hyves-api-oauth/</a>.

oauth_token_secret

The oauth_token_secret. Use this secret to sign all future requests that contain the accompanying oauth_token.

extra

• For more information on oAuth, see <a href='http://www.hyves-developers.nl/documentation/data-api/hyves-api-oauth/'>http://www.hyves-developers.nl/documentation/data-api/hyves-api-oauth/</a>.

onmymind

The field that is shown with the users picture at http://www.hyves.nl/friends/.

fancy_layout

body --- more information

ping

Contains data on a ping.

pingid

The id of a ping.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

pollid

The id of a poll.

printability

The printability of the media.

privatespot

Contains data on a privatespot.

privatespotid

The id of a privatespot.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

profilepicture

Contains the data on the media that is the profilepicture for the user.

profilevisible

Whether or not the profile is visible to the user supplied with the accesstoken (or the anonymous user)

rating

The rating of an item, values 1 to 5.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

region

Contains the data on a region.

regionid

The id of the region.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

relationtype

Relation type of the user.

respect

Contains data on a respect.

respectid

The id of a respect.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

respectscount

The respects count for an object.

respecttype

The type of the respect

resultsperpage

See the <a href='http://www.hyves-developers.nl/documentation/data-api/info-block/'>info block</a>.

running_milliseconds

See the <a href='http://www.hyves-developers.nl/documentation/data-api/info-block/'>info block</a>.

scrap

Contains data on a scrap.

scrapid

The id of a scrap.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

scrapscount

The scraps count for an user.

scrapsvisible

Whether or not the scraps on an user profile are visible to the user supplied with the accesstoken (or the anonymous user)

secure_connection

API-call is done over a secure connection.

shorturl

A shortened link for a regular url.

extra

The usual form is http://hyv.es/<a-z0-9>

shorturlid

The id of a shorturl.

specurl

Url where the gadget spec for the gadget can be found

square_extralarge

Contains the data for an extra large square icon that fits in a 120x120 rectangle.

square_large

Contains the data for a large square icon that fits in a 75x75 rectangle.

src

Url to the image, video or document.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/media-urls'>the FAQ on Media URLs</a>.

subject

The subject of an object (for email).

fancy_layout

title --- more information

tags

The tags for an object.

target_blogid

The id of a blog, used as target.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

target_gadgetid

The id of the widget, used as target.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

target_groupid

The id of a group, used as target.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

target_hangoutid

The id of a hangout, used as target.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

target_mediaid

The id to the media, used as target.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

target_privatespotid

The id of a privatespot, used as target.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

target_tipid

The id of a tip, used as target.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

target_userid

The id that uniquely identifies this user, used as target.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

testimonial

Contains data on a testimonial.

testimonialid

The id of a testimonial.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

testimonialscount

The testimonials count for an user.

timestamp_difference

See the <a href='http://www.hyves-developers.nl/documentation/data-api/info-block/'>info block</a>.

tip

Contains data on a tip.

tipcategory

Contains data on a tipcategory.

tipcategoryid

The id of a tipcategory.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

tipid

The id of a tip.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

title

The title of an object.

fancy_layout

title --- more information

totalpages

See the <a href='http://www.hyves-developers.nl/documentation/data-api/info-block/'>info block</a>.

totalresults

See the <a href='http://www.hyves-developers.nl/documentation/data-api/info-block/'>info block</a>.

url

The link to the overview page for the item.

extra

We do not guarantee that the link is in any certain format, and it may change at any moment. The only guarantee is that it is a valid http url and will show the correct page when put in a browser.

user

Contains data on an user.

usercount

Number of users for this item.

userid

The id to the user.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

userscount

Number of users for this item.

usertypes

Possible usertypes are: goldmember,h-team,designer,commercial designer,pionier,artiest,politicus,sport,acteurs,presentatoren,reality,auteurs,nep,betatester,barter partner,deceased,ex-crew.

video

Contains information on the video (flv) url of the media. Only available on videos.

fancy_layout

naturalname --- more information

viewscount

Number of views.

visibility

The visibility of the object.

where

The where part of a www.

fancy_layout

naturalname --- more information

whitespace

Contains the data of one of the fields on the personal profile page.

whitespacekey

The key of the whitespace, either predefined or user created.

fancy_layout

title --- more information

whitespaces

List of all whitespaces for a user.

whitespacevalue

The value of the whitespace.

fancy_layout

body --- more information

width

Width in pixels.

www

Contains data on a WWW.

extra

• This field is subject to visibility settings. This means that, depending on the users choice, the field be empty if you don't have an access token, or the loggedin user is not closely enough related.

wwwid

The id of the www.

extra

• Please take into account the remarks in <a href='http://www.hyves-developers.nl/faq/data-api/ids/'>the FAQ on IDs</a>.
• This field may be empty to indicate that no foreign relation exists.
• Note: This value is an Identification field as referred to in the Terms of Use.

year

Year in 4 decimals

Fancy Layout

If you set the ha_fancylayout to true, some returnvalues get a fancylayout'ed. On this page it shows which variables get fancylayout'ed with which parameter. For more information, see ha_fancylayout and fancylayout.parse.