Photos.getTags

From Facebook Developers Wiki

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

[edit] Description

Returns the set of user tags for all photos specified.

[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.
	pids	array	The list of photos from which to extract photo tags. This is a comma-separated list of PIDs.
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_getTags_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_tag> <pid>34995991612795</pid> <subject>1240078</subject> <xcoord>51.4901</xcoord> <ycoord>23.6203</ycoord> <created>1132183424</created> </photo_tag> </photos_getTags_response>

[edit] Response

If no photo tags are found, the method will return an empty photos_getTags_response element. Text tags not corresponding to a user are not currently returned.

Privacy note: A tag of a user is visible to an application only 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 pid, subject, xcoord, ycoord, created FROM photo_tag WHERE 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.