Platform.converdge.com

Content: API; UPML; UPML Console

Up.photos.getAlbums

Returns metadata about all of the photo albums uploaded by the specified user. The values returned from this call are not storable.

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`	uid	☑	Return albums created by this user.
`array`	aids	☑	Return albums with aids in this list. This is a comma-separated list of aids.

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.

It is an error to omit both of the uid and aids parameters. They have no defaults.

Example return XML

<?xml version="1.0" encoding="UTF-8"?>
 <photos_getAlbums_response 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.communitysite.com/photo/album/id/2002205</link>
    <size>30</size>
  </album>
 </photos_getAlbums_response>

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 will be returned to an application if that user has not turned off access to the Converdge Platform.

UPQL equivalent

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

Error codes