Photos.get

From Facebook Developers Wiki

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

[edit] Description

Returns all visible photos according to the filters specified. You can use this method to find all photos that are:

• Tagged with the specified uid
• Contained within the album specified by aid
• Included in the list of photos specified by pids
• Any combination of these three criteria

[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.
	subj_id	int	Filter by photos tagged with this user. You must specify at least one of subj_id, aid or pids. The subj_id parameter has no default value.
	aid	int	Filter by photos in this album. You must specify at least one of subj_id, aid or pids. The aid parameter has no default value.
	pids	array	Filter by photos in this list. This is a comma-separated list of pids. You must specify at least one of subj_id, aid or pids. The pids 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, sometimes known as "JSONP". This works with both XML and JSON.

[edit] Example Return XML

<?xml version="1.0" encoding="UTF-8"?> <photos_get_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"> <photo> <pid>34585991612804</pid> <aid>34585963571485</aid> <owner>1240077</owner> <src>http://ip002.facebook.com/v11/135/18/8055/s1240077_30043524_2020.jpg</src> <src_big>http://ip002.facebook.com/v11/135/18/8055/n1240077_30043524_2020.jpg</src> <src_small>http://ip002.facebook.com/v11/135/18/8055/t1240077_30043524_2020.jpg</src> <link>http://www.facebook.com/photo.php?pid=30043524&id=8055</link> <caption>From The Deathmatch (Trailer) (1999)</caption> <created>1132553361</created> </photo> <photo> <pid>34585991612805</pid> <aid>34585963571485</aid> <owner>1240077</owner> <src>http://ip002.facebook.com/v11/135/18/8055/s1240077_30043525_2184.jpg</src> <src_big>http://ip002.facebook.com/v11/135/18/8055/n1240077_30043525_2184.jpg</src> <src_small>http://ip002.facebook.com/v11/135/18/8055/t1240077_30043525_2184.jpg</src> <link>http://www.facebook.com/photo.php?pid=30043525&id=8055</link> <caption>Mexico City, back cover of the CYHS Student Underground 1999.</caption> <created>1132553362</created> </photo> </photos_get_response>

[edit] Response

If no such photos are found, the method returns an empty photos_get_response element.

Note: The following size constraints on photos returned:

• src - URL of photo, with max width 130px and max height 130px. May be blank.
• src_big - URL of photo, with max width 604px and max height 604px. May be blank.
• src_small - URL of photo, with with max width 75px and max height 225px. May be blank.

Privacy Note: Photos are visible on the Facebook Platform only if the photo owner has added the calling application, or the photo owner has not turned off access to the Platform.

[edit] FQL Equivalent

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

SELECT pid, aid, owner, src, src_big, src_small, link, caption, created FROM photo WHERE pid IN (SELECT pid FROM photo_tag WHERE subject=subj_id) AND aid=aid AND pid IN (pids)

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