APIMethods/beta_2/albums.getBuiltin – hyves_api

Context Navigation

albums.getBuiltin

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

Added: Nov 05, 2009
Not <a href='http://hyves-developers.nl/documentation/data-api/pagination'>Paginated</a>

params

<a href='http://hyves-developers.nl/returnvalues#visibility'>visibility</a> --- Fitler on visibility of default album.
- Optional

responsefields

This method supports the use of <a href='http://hyves-developers.nl/documentation/data-api/global-ha-parameters'>ha_responsefields</a>. Acceptable values are a comma separated list of 0 or more of the following:

<a href='http://hyves-developers.nl/returnvalues##mobileurl'>mobileurl</a>

sort

Sorted by visibility.

extra

Note that retrieving something by id always succeeds (as long as the id is valid), even if the visibility settings of the object do not allow viewing it. If some user is not allowed to view something, he/she will not get the id from another call.

examples

example 1

url

http://data.hyves-api.nl/?oauth_token=YXRfMTc3OTgxNTE5XyzzKhdJ9P0p-9URPI6SeeU%3D&ha_method=albums.getBuiltin&oauth_consumer_key=Nl-SK2c5ZCBKB_I8hCF_zjPd&oauth_timestamp=1282117544&oauth_nonce=705623_294&ha_version=beta_2&oauth_signature_method=HMAC-SHA1&ha_format=xml&ha_fancylayout=false&oauth_signature=9fZ8MpMjukYsPUNiMZY0Lm7Tq%2F0%3D

result

<?xml version="1.0" encoding="UTF-8"?>
<albums_getBuiltin_result>
        <album>
                <albumid>0050f5acec98d61cf23e6010c088bbf623</albumid>
                <title>Vrienden</title>
                <mediacount>4</mediacount>
                <userid>00cc68f39949140377bebf54013a15f63f</userid>
                <url>http://gorillaapi.hyves.nl/album/24293666/Vrienden/zF0ASfBD/</url>
                <visibility>friend</visibility>
                <printability>friend</printability>
                <lastupdate>1282117506</lastupdate>
        </album>
        <album>
                <albumid>00a22d87cad1417eeac4bca227637c16df</albumid>
                <title>Iedereen</title>
                <mediacount>0</mediacount>
                <userid>00cc68f39949140377bebf54013a15f63f</userid>
                <url/>
                <visibility>superpublic</visibility>
                <printability>superpublic</printability>
                <lastupdate>0</lastupdate>
        </album>
        <album>
                <albumid>00f1c3e65582e749cea0db2d2d4b4e5c91</albumid>
                <title>Vrienden van vrienden</title>
                <mediacount>0</mediacount>
                <userid>00cc68f39949140377bebf54013a15f63f</userid>
                <url/>
                <visibility>friends_of_friends</visibility>
                <printability>friends_of_friends</printability>
                <lastupdate>0</lastupdate>
        </album>
        <info>
                <timestamp_difference>0</timestamp_difference>
                <running_milliseconds>77</running_milliseconds>
                <secure_connection>false</secure_connection>
        </info>
</albums_getBuiltin_result>

example 2

url

http://data.hyves-api.nl/?oauth_token=YXRfMTc3OTgxNTE5XyzzKhdJ9P0p-9URPI6SeeU%3D&ha_method=albums.getBuiltin&ha_responsefields=mobileurl&oauth_consumer_key=Nl-SK2c5ZCBKB_I8hCF_zjPd&oauth_timestamp=1282117544&oauth_nonce=858316_295&ha_version=beta_2&oauth_signature_method=HMAC-SHA1&ha_format=xml&ha_fancylayout=false&oauth_signature=8H7bOus7yphseIPufSM1klE9ZRw%3D

result

<?xml version="1.0" encoding="UTF-8"?>
<albums_getBuiltin_result>
        <album>
                <albumid>0050f5acec98d61cf23e6010c088bbf623</albumid>
                <title>Vrienden</title>
                <mediacount>4</mediacount>
                <userid>00cc68f39949140377bebf54013a15f63f</userid>
                <url>http://gorillaapi.hyves.nl/album/24293666/Vrienden/zF0ASfBD/</url>
                <mobileurl>http://www.hyves.nl/mini/hyver/gorillaapi/album/24293666/Vrienden/zF0ASfBD/</mobileurl>
                <visibility>friend</visibility>
                <printability>friend</printability>
                <lastupdate>1282117506</lastupdate>
        </album>
        <album>
                <albumid>00a22d87cad1417eeac4bca227637c16df</albumid>
                <title>Iedereen</title>
                <mediacount>0</mediacount>
                <userid>00cc68f39949140377bebf54013a15f63f</userid>
                <url/>
                <mobileurl/>
                <visibility>superpublic</visibility>
                <printability>superpublic</printability>
                <lastupdate>0</lastupdate>
        </album>
        <album>
                <albumid>00f1c3e65582e749cea0db2d2d4b4e5c91</albumid>
                <title>Vrienden van vrienden</title>
                <mediacount>0</mediacount>
                <userid>00cc68f39949140377bebf54013a15f63f</userid>
                <url/>
                <mobileurl/>
                <visibility>friends_of_friends</visibility>
                <printability>friends_of_friends</printability>
                <lastupdate>0</lastupdate>
        </album>
        <info>
                <timestamp_difference>0</timestamp_difference>
                <running_milliseconds>72</running_milliseconds>
                <secure_connection>false</secure_connection>
        </info>
</albums_getBuiltin_result>

returnvalues

Download in other formats:

Plain Text

Context Navigation

TracNav

Hyves-API Home

Specs

methods

global (ha_*) parameters

oAuth

special API zones