Photos.createAlbum

From Facebook Developers Wiki

Contents 1 Description 2 Parameters 3 Example Return XML 4 Response 5 Error Codes 6 Notes

[edit] Description

Creates and returns a new album owned by the specified user or the current session user. See photo uploads for a description of the upload workflow. The only storable values returned from this call are aid and owner. No relationships between them are storable.

For Web applications, you must pass either the ID of the user on whose behalf you're making this call or the session key for that user, but not both. If you don't specify a user with the uid parameter, then that user whose session it is will be the target of the call.

However, if your application is a desktop application, you must pass a valid session key for security reasons. Do not pass a uid parameter.

[edit] Parameters

Required	Name	Type	Description
required	api_key	string	The application key associated with the calling application.
	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.
	name	string	The album name.
optional	session_key	string	The session key of the user for whom you are creating the album. Note: A session key is always required for desktop applications. It is required for Web applications only when the uid is not specified.
	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, sometimes known as "JSONP". This works with both XML and JSON.
	location	string	The album location.
	description	string	The album description.
	uid	int	The user ID of the user for whom you are creating the album. If this parameter is not specified, then it defaults to the session user. Note: This parameter applies only to Web applications and is required by them only if the session_key is not specified. Facebook ignores this parameter if it is passed by a desktop application.

[edit] Example Return XML

<?xml version="1.0" encoding="UTF-8"?> <photos_createAlbum_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"> <aid>34595963571485</aid> <cover_pid>0</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>0</size> </photos_createAlbum_response>

[edit] Response

The returned cover_pid is always 0.

[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.
200	The application does not have permission to operate on the passed in uid parameter.

[edit] Notes

• This function does not require a session_key, unless it is being called by a desktop application.