Data-API

 

Data-API

 

Methods

Returnvalues

description

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

fancylayout

body

age

description

age of the user, in years

description

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.

    • description

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

    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.

    • description

    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.

    • description

    Contains data on a blog.

    description

    The id of a blog.

    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.

    • description

    The body of an object.

    fancylayout

    body

    description

    The URL the listener will do the callback to.

    description

    Contains the data on a city.

    description

    The id to the city.

    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.

    • description

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

    fancylayout

    naturalname

    description

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

    • description

    Contains data on a comment.

    description

    The id of a comment.

    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.

    • description

    The comments count for an object.

    description

    Contains the data on a country.

    description

    The id to the country.

    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.

    • description

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

    fancylayout

    naturalname

    description

    The date an object was created.

    extra

  • Timestamp (POSIX time, Unix time) is the number of seconds since 1-1-1970 0:00:00 UTC, corrected for leap seconds.

    • description

    See the info block.

    day

    description

    day in the range (1-31)

    description

    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.

    description

    The number of delete's.

    description

    The description of an object.

    fancylayout

    body

    description

    The displaybody of an object, usable for displaying.

    fancylayout

    body

    description

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

    description

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

    description

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

    fancylayout

    naturalname

    description

    The emotion part of a www.

    fancylayout

    oneliner

    description

    Contains data on an event.

    description

    The id to the event.

    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.

    • description

    The moment until which the accesstoken is valid.

    extra

  • Timestamp (POSIX time, Unix time) is the number of seconds since 1-1-1970 0:00:00 UTC, corrected for leap seconds.

    • description

    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.

    description

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

    fancylayout

    naturalname

    description

    Gefancylayoutte string.

    description

    Contains data on a friendgroup.

    description

    The id to the friendgroup.

    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.

    • description

    Contains data on a friendinvitation.

    description

    Number of friends for this user.

    description

    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.

    • description

    The id of the widget.

    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.

    • description

    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.

    • description

    Geolocation data (latitude and longitude) of the item.

    description

    Contains data on a hangout.

    description

    The id of a hangout.

    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.

    • description

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

    description

    Height in pixels.

    description

    The html of the widget.

    extra

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

    hub

    description

    Contains data on a hub.

    description

    Contains the data for address of the hub.

    description

    Contains the hubcategories of the hub.

    description

    Contains the data for categories of the hub.

    description

    The id of the hubcategory.

    description

    The id to the hub.

    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.

    • description

    Contains the data for the opening hours of the hub.

    description

    Number of hubs for this item.

    description

    The type of the hub.

    description

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

    description

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

    description

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

    description

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

    description

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

    description

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

    description

    Contains the data for the largest image we have.

    description

    Contains the data for the original image.

    description

    See the info block.

    description

    The language locale of the user.

    description

    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.

    • fancylayout

    naturalname

    description

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

    extra

  • Timestamp (POSIX time, Unix time) is the number of seconds since 1-1-1970 0:00:00 UTC, corrected for leap seconds.

    • description

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

    description

    Contains data on a listener.

    description

    The id of the listener.

    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.

    • description

    The type of the listener

    description

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

    description

    Whether this object may be copied by some other user.

    description

    Contains the data on a media.

    description

    The number of media in an album.

    description

    The id to the media.

    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.

    • description

    The type of a media.

    description

    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.

    description

    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.

    description

    month in the range (1-12)

    description

    The name of the object.

    fancylayout

    naturalname

    description

    The nickname as filled in by the user.

    fancylayout

    nickname

    description

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

    description

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

    description

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

    fancylayout

    body

    description

    Contains data on a ping.

    description

    The id of a ping.

    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.

    • description

    The id of a poll.

    description

    The printability of the media.

    description

    Contains data on a privatespot.

    description

    The id of a privatespot.

    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.

    • description

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

    description

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

    description

    The rating of an item, values 1 to 5.

    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.

    • description

    Contains the data on a region.

    description

    The id of the region.

    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.

    • description

    Relation type of the user.

    description

    Contains data on a respect.

    description

    The id of a respect.

    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.

    • description

    The respects count for an object.

    description

    The type of the respect

    description

    See the info block.

    description

    See the info block.

    description

    Contains data on a scrap.

    description

    The id of a scrap.

    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.

    • description

    The scraps count for a user.

    description

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

    description

    API-call is done over a secure connection.

    description

    A shortened link for a regular url.

    extra

    The usual form is http://hyv.es/

    description

    The id of a shorturl.

    description

    Url where the gadget spec for the gadget can be found

    description

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

    description

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

    src

    description

    Url to the image, video or document.

    extra

  • Please take into account the remarks in the FAQ on Media URLs.

    • description

    The subject of an object (for email).

    fancylayout

    title

    description

    The tags for an object.

    description

    The id of a blog, used as target.

    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.

    • description

    The id of the widget, used as target.

    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.

    • description

    The id of a group, used as target.

    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.

    • description

    The id of a hangout, used as target.

    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.

    • description

    The id to the media, used as target.

    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.

    • description

    The id of a privatespot, used as target.

    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.

    • description

    The id of a tip, used as target.

    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.

    • description

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

    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.

    • description

    Contains data on a testimonial.

    description

    The id of a testimonial.

    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.

    • description

    The testimonials count for a user.

    description

    See the info block.

    tip

    description

    Contains data on a tip.

    description

    Contains data on a tipcategory.

    description

    The id of a tipcategory.

    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.

    • description

    The id of a tip.

    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.

    • description

    The title of an object.

    fancylayout

    title

    description

    See the info block.

    description

    See the info block.

    url

    description

    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.

    description

    Contains data on a user.

    description

    Number of users for this item.

    description

    The id to the user.

    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.

    • description

    Number of users for this item.

    description

    Possible usertypes are: goldmember,h-team,designer,commercial designer,pionier,artiest,politicus,sporter,acteur,presentator,reality,auteur,nep,betatester,barter partner,overleden,ex-crew,creative,fashion,mvno connector,mvno prizewinner,seo moderator,personage,in memoriam.

    description

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

    fancylayout

    naturalname

    description

    Number of views.

    description

    The visibility of the object.

    description

    The where part of a www.

    fancylayout

    naturalname

    description

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

    description

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

    fancylayout

    title

    description

    List of all whitespaces for a user.

    description

    The value of the whitespace.

    fancylayout

    body

    description

    Width in pixels.

    www

    description

    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.

    • description

    The id of the www.

    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.

    • description

    Year in 4 decimals

    description

    The id of an option from a poll.

    description

    State of member's MVNO subscription (none / pending / active)

    description

    Id of pimp