[[TracNav(APINav|nocollapse)]] [[PageOutline(2-3)]] == Return values == === aboutme === #aboutme An about me field that is shown with the users profile information. ==== fancy_layout ==== #aboutme-fancy_layout body --- [wiki:APIReturnValues#fancy_layout more information] === age === #age age of the user, in years === album === #album Contains data on an album. ==== extra ==== #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 === #albumid The id of an album. An album can contain media. ==== extra ==== #albumid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #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 ==== #birthday-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 === #blog Contains data on a blog. === blogid === #blogid The id of a blog. ==== extra ==== #blogid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #body The body of an object. ==== fancy_layout ==== #body-fancy_layout body --- [wiki:APIReturnValues#fancy_layout more information] === callback === #callback The URL the listener will do the callback to. === city === #city Contains the data on a city. === cityid === #cityid The id to the city. ==== extra ==== #cityid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #cityname Contains the cityname (when a user is displayed; within a tag, just is used). ==== fancy_layout ==== #cityname-fancy_layout naturalname --- [wiki:APIReturnValues#fancy_layout more information] === citytabid === #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 ==== #citytabid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #comment Contains data on a comment. === commentid === #commentid The id of a comment. ==== extra ==== #commentid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #commentscount The comments count for an object. === country === #country Contains the data on a country. === countryid === #countryid The id to the country. ==== extra ==== #countryid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #countryname Contains the countryname (when a user is displayed; within a tag, just is used). ==== fancy_layout ==== #countryname-fancy_layout naturalname --- [wiki:APIReturnValues#fancy_layout more information] === created === #created The date an object was created. ==== extra ==== #created-extra * Timestamp (POSIX time, Unix time) is the number of seconds since 1-1-1970 0:00:00 UTC, corrected for leap seconds. === currentpage === #currentpage See the info block. === day === #day day in the range (1-31) === degree === #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 === #deletecount The number of delete's. === description === #description The description of an object. ==== fancy_layout ==== #description-fancy_layout body --- [wiki:APIReturnValues#fancy_layout more information] === displaybody === #displaybody The displaybody of an object, usable for displaying. ==== fancy_layout ==== #displaybody-fancy_layout body --- [wiki:APIReturnValues#fancy_layout more information] === displayname === #displayname The displayname (with smilies) of the user as shown on Hyves. === distance === #distance Contains the data on distance between the user in the accesstoken and some other user. === document === #document Contains information on the document (pdf) url of the media. Only available on videos. ==== fancy_layout ==== #document-fancy_layout naturalname --- [wiki:APIReturnValues#fancy_layout more information] === emotion === #emotion The emotion part of a www. ==== fancy_layout ==== #emotion-fancy_layout oneliner --- [wiki:APIReturnValues#fancy_layout more information] === event === #event Contains data on an event. === eventid === #eventid The id to the event. ==== extra ==== #eventid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #expiredate The moment until which the accesstoken is valid. ==== extra ==== #expiredate-extra * Timestamp (POSIX time, Unix time) is the number of seconds since 1-1-1970 0:00:00 UTC, corrected for leap seconds. === fancylayouttag === #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 === #firstname The firstname for this user. Is used very rarely on the hyves website. ==== fancy_layout ==== #firstname-fancy_layout naturalname --- [wiki:APIReturnValues#fancy_layout more information] === fl_string === #fl_string Gefancylayoutte string. === friendgroup === #friendgroup Contains data on a friendgroup. === friendgroupid === #friendgroupid The id to the friendgroup. ==== extra ==== #friendgroupid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #friendinvitation Contains data on a friendinvitation. === friendscount === #friendscount Number of friends for this user. === gadget === #gadget Contains data on an widget. ==== extra ==== #gadget-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 === #gadgetid The id of the widget. ==== extra ==== #gadgetid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #gender The gender for the user. ==== extra ==== #gender-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 Geolocation data (latitude and longitude) of the item. === hangout === #hangout Contains data on a hangout. === hangoutid === #hangoutid The id of a hangout. ==== extra ==== #hangoutid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #hangoutvisible Whether or not the hangout is visible to the user supplied with the accesstoken (or the anonymous user) === height === #height Height in pixels. === html === #html The html of the widget. ==== extra ==== #html-extra * Note that this field is not html escaped, even if ha_fancylayout is set to true. === hub === #hub Contains data on a hub. === hubaddress === #hubaddress Contains the data for address of the hub. === hubcategories === #hubcategories Contains the hubcategories of the hub. === hubcategory === #hubcategory Contains the data for categories of the hub. === hubcategoryid === #hubcategoryid The id of the hubcategory. === hubid === #hubid The id to the hub. ==== extra ==== #hubid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #hubopeninghours Contains the data for the opening hours of the hub. === hubscount === #hubscount Number of hubs for this item. === hubtype === #hubtype The type of the hub. === hubvisible === #hubvisible Whether or not the hub is visible to the user supplied with the accesstoken (or the anonymous user) === icon_extralarge === #icon_extralarge Contains the data for an extra large icon that fits in a 200x200 rectangle. === icon_large === #icon_large Contains the data for a large icon that fits in a 120x120 rectangle. === icon_medium === #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 === #icon_small Contains the data for a small icon that fits in a 50x50 rectangle. === image === #image Contains the data for the size we normally use on the site. === image_fullscreen === #image_fullscreen Contains the data for the largest image we have. === image_original === #image_original Contains the data for the original image. === info === #info See the info block. === languagelocale === #languagelocale The language locale of the user. === lastname === #lastname The lastname for this user. Is used very rarely on the hyves website. ==== extra ==== #lastname-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 ==== #lastname-fancy_layout naturalname --- [wiki:APIReturnValues#fancy_layout more information] === lastupdate === #lastupdate The moment when the last update was done, usable for ordering. ==== extra ==== #lastupdate-extra * Timestamp (POSIX time, Unix time) is the number of seconds since 1-1-1970 0:00:00 UTC, corrected for leap seconds. === latitude === #latitude Latitude of the item, part of geolocation. Example latitude: 52.36222 === listener === #listener Contains data on a listener. === listenerid === #listenerid The id of the listener. ==== extra ==== #listenerid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #listenertype The type of the listener === longitude === #longitude Longitude of the item, part of geolocation. Example longitude: 4.88421 === maycopy === #maycopy Whether this object may be copied by some other user. === media === #media Contains the data on a media. === mediacount === #mediacount The number of media in an album. === mediaid === #mediaid The id to the media. ==== extra ==== #mediaid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #mediatype The type of a media. === methods === #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 === #mobileurl The link to the overview page for the item on the mobile webiste. ==== extra ==== #mobileurl-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 month in the range (1-12) === name === #name The name of the object. ==== fancy_layout ==== #name-fancy_layout naturalname --- [wiki:APIReturnValues#fancy_layout more information] === nickname === #nickname The nickname as filled in by the user. ==== fancy_layout ==== #nickname-fancy_layout nickname --- [wiki:APIReturnValues#fancy_layout more information] === oauth_token === #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 ==== #oauth_token-extra * For more information on oAuth, see http://www.hyves-developers.nl/documentation/data-api/hyves-api-oauth/. === oauth_token_secret === #oauth_token_secret The oauth_token_secret. Use this secret to sign all future requests that contain the accompanying oauth_token. ==== extra ==== #oauth_token_secret-extra * For more information on oAuth, see http://www.hyves-developers.nl/documentation/data-api/hyves-api-oauth/. === onmymind === #onmymind The field that is shown with the users picture at [http://www.hyves.nl/friends/]. ==== fancy_layout ==== #onmymind-fancy_layout body --- [wiki:APIReturnValues#fancy_layout more information] === ping === #ping Contains data on a ping. === pingid === #pingid The id of a ping. ==== extra ==== #pingid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #pollid The id of a poll. === printability === #printability The printability of the media. === privatespot === #privatespot Contains data on a privatespot. === privatespotid === #privatespotid The id of a privatespot. ==== extra ==== #privatespotid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #profilepicture Contains the data on the media that is the profilepicture for the user. === profilevisible === #profilevisible Whether or not the profile is visible to the user supplied with the accesstoken (or the anonymous user) === rating === #rating The rating of an item, values 1 to 5. ==== extra ==== #rating-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #region Contains the data on a region. === regionid === #regionid The id of the region. ==== extra ==== #regionid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #relationtype Relation type of the user. === respect === #respect Contains data on a respect. === respectid === #respectid The id of a respect. ==== extra ==== #respectid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #respectscount The respects count for an object. === respecttype === #respecttype The type of the respect === resultsperpage === #resultsperpage See the info block. === running_milliseconds === #running_milliseconds See the info block. === scrap === #scrap Contains data on a scrap. === scrapid === #scrapid The id of a scrap. ==== extra ==== #scrapid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #scrapscount The scraps count for an user. === scrapsvisible === #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 === #secure_connection API-call is done over a secure connection. === shorturl === #shorturl A shortened link for a regular url. ==== extra ==== #shorturl-extra The usual form is http://hyv.es/ === shorturlid === #shorturlid The id of a shorturl. === specurl === #specurl Url where the gadget spec for the gadget can be found === square_extralarge === #square_extralarge Contains the data for an extra large square icon that fits in a 120x120 rectangle. === square_large === #square_large Contains the data for a large square icon that fits in a 75x75 rectangle. === src === #src Url to the image, video or document. ==== extra ==== #src-extra * Please take into account the remarks in the FAQ on Media URLs. === subject === #subject The subject of an object (for email). ==== fancy_layout ==== #subject-fancy_layout title --- [wiki:APIReturnValues#fancy_layout more information] === tags === #tags The tags for an object. === target_blogid === #target_blogid The id of a blog, used as target. ==== extra ==== #target_blogid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #target_gadgetid The id of the widget, used as target. ==== extra ==== #target_gadgetid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #target_groupid The id of a group, used as target. ==== extra ==== #target_groupid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #target_hangoutid The id of a hangout, used as target. ==== extra ==== #target_hangoutid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #target_mediaid The id to the media, used as target. ==== extra ==== #target_mediaid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #target_privatespotid The id of a privatespot, used as target. ==== extra ==== #target_privatespotid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #target_tipid The id of a tip, used as target. ==== extra ==== #target_tipid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #target_userid The id that uniquely identifies this user, used as target. ==== extra ==== #target_userid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #testimonial Contains data on a testimonial. === testimonialid === #testimonialid The id of a testimonial. ==== extra ==== #testimonialid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #testimonialscount The testimonials count for an user. === timestamp_difference === #timestamp_difference See the info block. === tip === #tip Contains data on a tip. === tipcategory === #tipcategory Contains data on a tipcategory. === tipcategoryid === #tipcategoryid The id of a tipcategory. ==== extra ==== #tipcategoryid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #tipid The id of a tip. ==== extra ==== #tipid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #title The title of an object. ==== fancy_layout ==== #title-fancy_layout title --- [wiki:APIReturnValues#fancy_layout more information] === totalpages === #totalpages See the info block. === totalresults === #totalresults See the info block. === url === #url The link to the overview page for the item. ==== extra ==== #url-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 === #user Contains data on an user. === usercount === #usercount Number of users for this item. === userid === #userid The id to the user. ==== extra ==== #userid-extra * Please take into account the remarks in the FAQ on IDs. * 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 === #userscount Number of users for this item. === usertypes === #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 === #video Contains information on the video (flv) url of the media. Only available on videos. ==== fancy_layout ==== #video-fancy_layout naturalname --- [wiki:APIReturnValues#fancy_layout more information] === viewscount === #viewscount Number of views. === visibility === #visibility The visibility of the object. === where === #where The where part of a www. ==== fancy_layout ==== #where-fancy_layout naturalname --- [wiki:APIReturnValues#fancy_layout more information] === whitespace === #whitespace Contains the data of one of the fields on the personal profile page. === whitespacekey === #whitespacekey The key of the whitespace, either predefined or user created. ==== fancy_layout ==== #whitespacekey-fancy_layout title --- [wiki:APIReturnValues#fancy_layout more information] === whitespaces === #whitespaces List of all whitespaces for a user. === whitespacevalue === #whitespacevalue The value of the whitespace. ==== fancy_layout ==== #whitespacevalue-fancy_layout body --- [wiki:APIReturnValues#fancy_layout more information] === width === #width Width in pixels. === www === #www Contains data on a WWW. ==== extra ==== #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 === #wwwid The id of the www. ==== extra ==== #wwwid-extra * Please take into account the remarks in the FAQ on IDs. * 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 Year in 4 decimals == Fancy Layout == #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 [wiki:APIGlobalParameters#ha_fancylayout ha_fancylayout] and [wiki:APIMethods#methods-1.0-fancylayout.parse fancylayout.parse].