Photos.getAlbums

From Facebook Developers Wiki

Contents 1 Description 2 Parameters 3 Example Request 4 Example Return XML 5 Response 6 FQL Equivalent 7 Error Codes 8 Notes

[edit] Description

Returns metadata about all of the photo albums uploaded by the specified user.

This method returns information from all visible albums 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.

The values returned from this call cannot be stored.

[edit] Parameters

Required	Name	Type	Description
required	api_key	string	The application key associated with the calling application.
	session_key	string	The session key of the logged in user.
	call_id	float	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.
	sig	string	An MD5 hash of the current request and your secret key, as described in the authentication guide.
	v	string	This must be set to 1.0 to use this version of the API.
	uid	int	Return albums created by this user. You must specify either uid or aids. The uid parameter has no default value.
	aids	array	Return albums with aids in this list. This is a comma-separated list of aids. You must specify either uid or aids. The aids parameter has no default value.
optional	format	string	Desired response format. Either XML (default) or JSON.
	callback	string	Name of a function to call. This is primarily to enable cross-domain JavaScript requests using the <script> tag, also known as JSONP, and works with both the XML and JSON formats. The function will be called with the response passed as the parameter.

[edit] Example Request

This is using the PHP library $albums = $facebook->api_client->photos_getAlbums($uid, NULL); print_r($albums);

[edit] 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>

[edit] Response

The album IDs (aids) returned by this function can be passed in to photos.get.

Privacy note: In this call, an album owned by a user gets returned to an application if that user has not turned off access to the Facebook Platform.

[edit] 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)

[edit] Error Codes

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

[edit] Notes

A user's Profile archive album -- the place where their profile images are stored -- does not get returned by this call.