Facebook Methods description: photos.getAlbums

anna_150.jpg

Returns metadata about all of the photo albums uploaded by the specified user. The values returned from this call are not storable.

Parameters

 

string api_key The application key associated with the calling application.
string session_key The session key of the logged in user.
float call_id The request’s sequence number. Each successive call for any session must use a sequence number greater than the last. We suggest using the current time in milliseconds, such as PHP’s microtime(true) function.
string sig An MD5 hash of the current request and your secret key, as described in the authentication guide.
string v This must be set to 1.0 to use this version of the API.
string format Optional - desired response format. Either “XML” (default) or “JSON”.
string callback Optional - wrap the response inside a function call. This is primarily to enable cross-domain javascript requests using the <script> tag, sometimes known as “JSONP“. This works with both XML and JSON.
int uid Optional - Return albums created by this user.
array pids Optional - Return albums with aids in this list. This is a comma-separated list of pids.

This method returns all visible photos satisfying the filters specified. The method can be used to return all photo albums created by a user, query a specific set of albums by a list of aids, or filter on any combination of these two. It is an error to omit both of the uid and aids parameters. They have no defaults.

Example Return XML

 

 

<?xml version="1.0" encoding="UTF-8"?>
<photos_getAlbums_response xmlns="http://api.facebook.com/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://api.facebook.com/1.0/ http://api.facebook.com/1.0/facebook.xsd" list="true">
  <album>
    <aid>34595963571485</aid>
    <cover_pid>34595991612812</cover_pid>
    <owner>8055</owner>
    <name>Films you will never see</name>
    <created>1132553109</created>
    <modified>1132553363</modified>
    <description>No I will not make out with you</description>
    <location>York, PA</location>
    <link>http://www.facebook.com/album.php?aid=2002205&id=8055</link>
    <size>30</size>
  </album>
</photos_getAlbums_response>

Response

The album ids returned by this function can be passed in to facebook.photos.get. Privacy note: In this call, an album owned by a user will be returned to an application if that user has not turned off access to the Facbook Platform.

FQL Equivalent

This function is similar to doing the following FQL query, with the appropriate parameters filled in:

 

SELECT aid, cover_pid, owner, name, created, modified, description, location
FROM album
WHERE owner=uid AND aid IN (aids)

Error codes

1 An unknown error occurred. Please resubmit the request.
2 The service is not available at this time.
4 The application has reached the maximum number of requests allowed. More requests are allowed once the time window has completed.
5 The request came from a remote address not allowed by this application.
100 One of the parameters specified was missing or invalid.
101 The api key submitted is not associated with any known application.
102 The session key was improperly submitted or has reached its timeout. Direct the user to log in again to obtain another key.
103 The submitted call_id was not greater than the previous call_id for this session.
104 Incorrect signature.

Source page

Tags: ,

Related Post

March 1st, 2008
Categories: Apps development, Facebook Methods . Author: admin

No Comments

No comments yet.

Comments RSS TrackBack Identifier URI

Leave a comment

6 Steps to Promote Your New Cause on Facebook Facebook PHP Error Codes Table: Full Listing