Platform.converdge.com

Content: API; UPML; UPML Console

Up.photos.get

Returns all visible photos according to the filters specified. This may be used to find all photos in which a user is tagged, return photos in a specific album, or to query specific pids.

Parameters

Type	Name	Required	Description
`string`	api_key	?	The application key associated with the calling application.
`string`	community	?	Community system name. Use up.community.getList method to retrieve available communities.
`string`	session_key	?	The session key of the logged in user.
`string`	sig	?	An MD5 hash of the current request and your secret key, as described in the authentication guide.
`string`	format		Desired response format. Either `XML` (default) or `JSON`.
`int`	uids	?	Filter by photos tagged with this users. This is a comma-separated list of uids.
`int`	aid	?	Filter by photos in this album
`array`	pids	?	Filter by photos in this list. This is a comma-separated list of pids.
`int`	pageSize	?	Photos quantity (default: 10)
`int`	pageNumber	?	Page number (default: 1)

This method returns all visible photos satisfying the filters specified. It can be used to:

return all photos tagged with the specified uid
return all photos from the specified aid
return the photos specified by the list of pids
any combination of these three.

It is an error to omit all three of the uids, aid, and pids parameters. They have no defaults.

Example return XML

<?xml version="1.0" encoding="UTF-8"?>
<photos_get_response list="true">
   <photo>
     <pid>34585991612804>/pid>
     <aid>34585963571485>/aid>
     <owner>1240077>/owner>
     <src>http://media1.universalplatform.com/v11/135/18/8055/s1240077_30043524_2020.jpg>/src>
     <src_big>http://media1.universalplatform.com/v11/135/18/8055/n1240077_30043524_2020.jpg>/src>
     <src_small>http://media1.universalplatform.com/v11/135/18/8055/t1240077_30043524_2020.jpg>/src>
     <link>http://my.mashable.com/photo/id/30043524>/link>
     <caption>From The Deathmatch (Trailer) (1999)>/caption>
     <created>1132553361>
   </photo>
   <photo>
     <pid>34585991612805>/pid>
     <aid>34585963571485>/aid>
     <owner>1240077>/owner>
     <src>http://media1.universalplatform.com/v11/135/18/8055/s1240077_30043525_2184.jpg>/src>
     <src_big>http://media1.universalplatform.com/v11/135/18/8055/n1240077_30043525_2184.jpg>/src>
     <src_small>http://media1.universalplatform.com/v11/135/18/8055/t1240077_30043525_2184.jpg>/src>
     <link>http://my.mashable.com/photo/id/30043525>/link>
     <caption>Mexico City, back cover of the CYHS Student Underground 1999.>/caption>
     <created>1132553362>/created>
   </photo>
</photos_get_response>

Response

If no such photos are found, the method will return 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 will be visible on the Converdge Platform only if the photo owner has added the calling application, or the photo owner has not turned off access to the Platform.

UPQL equivalent

This function is similar to doing the following UPQL 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)

Error codes