| Revised:
March 19th, 2007 [Click here for the AOL Pictures ATOM Feed API Documentation] |
|
| |
| getAlbumList |
|
|
Retrieves a list of all public
albums for a given screenname.
Parameters
- owner
- A string specifying the album owner's screenname. The call will
return a list of all public albums for this screenname. This parameter
is required.
- category
- Limit results to the named category of albums. Valid categories are:
"myAlbums", "aimPages", "blogs", and "memberProfile". This parameter is
optional.
- maxResults
- An integer that specifies the maximum number of albums to return.
This parameter is optional.
Sample call
http://api.pictures.aol.com/gv1/pictures/json/getAlbumList?owner=winterWoohoo
Sample Response
|
{ "albums": [ { "title": "Travels", "category": "aimPages", "creationDate": "Mon, 19 Jun 2006 12:57:54 -0800", "id": "aeVRhXusOtL1P2a9U6kbKJDqmBf4L92GMzxDvzOGjCK/jFCnkV3ciA==", "pictureCount": 4 }, { "title": "Barbeque Party", "category": "aimPages", "creationDate": "Mon, 19 Jun 2006 12:56:51 -0800", "id": "aeVRhXusOtKPs7/i20yPNpDqmBf4L92GnR1KtrPRF62/jFCnkV3ciA==", "pictureCount": 5 } ] }
|
Decoding the Response
getAlbumList returns an array
of albums. Each album has the following properties:
- title
- the user-created album title.
- category
- the category the album belongs to.
- creationDate
- the date on which the album was created. The date is formatted an an
RFC 822 date string. This string can be used to instantiate a
JavaScript or ActionScript Date object.
- id
- the server ID of the album. This id can be passed to the getAlbum
call to retrieve pictures for the album.
- pictureCount
- the number of pictures in the album.
|
| |
| getPicturesByAlbumId |
|
|
Retrieves picture data and
album metadata for the one album in AOL Pictures.
Parameters
- id
- the id of the album to be returned. The album id contains characters
that need to be URL-escaped before sending to the server. For example,
in JavaScript, users must call encodeURIComponent() on the id that is
returned by getAlbumList.This parameter is required.
- f
- how should the data be formatted. Valid values: json. This parameter
is required.
- devId -
Developer Id from http://dev.aol.com. This parameter is required.
- h
- Host. A human readable name for the caller. This parameter is
required.
- locale
- Locale of the user. Valid values: de_DE, en_GB, en_IE, en_US, es_US,
es_ES, fr_FR, it_IT, nl_NL. This parameter is required.
- c
- Callback for JSON response. The valid characters in the callback
function are upper and lowercase alphabetic characters (A-Z a-z),
numbers (0-9), period (.), underscore (_). Response will be wrapped as
callback(response)
- r
- A URL safe request id string. This parameter is optional.
- max
- A positive integer that specifies the maximum number of pictures to
return. This parameter is optional.
- sort
- Sort pictures by this field. Valid values: sequence, creationDate,
modificationDate. This parameter is optional. Default value is
sequence.
- order
- Sort ascending or descending. Valid values: asc, desc. This parameter
is optional. Default value is asc.
Sample call
http://api.pictures.aol.com/gv1/pictures/getPicturesByAlbumId?f=json&devId=MYID&h=THEHOST&locale=en_
US&max=10&id=esv4e%2B9w77lSgWr%2BvV4/YO18yBt30TBPOFIlVfWvHIWJJdNX5w59hg==
Sample Response
|
{ { "response": { "statusCode": 200, "statusText": "Ok", "statusDetailCode": 1234, "requestId": "2345", "data": { "loginId": "winterWoohoo", "creationDate": "Mon, 19 Jun 2006 12:57:54 -0800", "id": "mFQYMXJcDsVX+KJF5a9ZLdpkLUSEf2dWgsz9yokfTk+JJdNX5w59hg==", "pictureCount": 3, "pictures": [ { "creationDate": "Mon, 19 Jun 2006 12:57:54 -0800", "caption": "", "permalink": "http://links.pictures.aol.com/pic?id=5a70kV4KOAVzNQ-wVCHXSMZhPlUYuX7B- kZMv4xQp5Fd3Ig=", "gallery": "http://pictures.aol.com/galleries/winterWoohoo/5a70kV4KOAVzNQ- wVCHXSMZhPlUYuX7B-kZMv4xQp5Fd3Ig=", "id": "5a70kV4KOAVzNQ-wVCHXSMZhPlUYuX7B-kZMv4xQp5Fd3Ig=", "sizes": [ { "width": 96, "height": 72, "url": "http://shutter04.pictures.aol.com:80/data/pictures/06/008/75/B4/85/F7/ Y8is+DPsKG-JxKyEPadZdrKER4zlep320060.jpg" }, { "width": 160, "height": 120, "url": "http://shutter04.pictures.aol.com:80/data/pictures/06/008/75/B4/85/F7/ Y8is+DPsKG-JxKyEPadZdrKER4zlep3200A0.jpg" }, { "width": 384, "height": 288, "url": "http://shutter04.pictures.aol.com:80/data/pictures/06/008/75/B4/85/F7/ Y8is+DPsKG-JxKyEPadZdrKER4zlep320180.jpg" }, { "width": 768, "height": 576, "url": "http://shutter04.pictures.aol.com:80/data/pictures/06/008/75/B4/85/ F7/Y8is+DPsKG-JxKyEPadZdrKER4zlep320300.jpg" }, { "width": 1600, "height": 1200, "url": "http://shutter04.pictures.aol.com:80/data/pictures/06/008/75/B4/85/F7/ Y8is+DPsKG-JxKyEPadZdrKER4zlep320640.jpg" } ] }, { "creationDate": "Mon, 19 Jun 2006 12:57:54 -0800", "caption": "", "permalink": "http://links.pictures.aol.com/pic?id=5a70kV4KOAVzNQ-wVCHXSMZh Pm2OY4BqJwmjv4xQp5Fd3Ig=", "gallery": "http://pictures.aol.com/galleries/winterWoohoo/5a70kV4KOAVzNQ-wVC HXSMZhPm2OY4BqJwmjv4xQp5Fd3Ig=", "id": "5a70kV4KOAVzNQ-wVCHXSMZhPm2OY4BqJwmjv4xQp5Fd3Ig=", "sizes": [ { "width": 96, "height": 72, "url": "http://shutter10.pictures.aol.com:80/data/pictures/05/004/56/1F/83/C9/ KpZdbh5RgGiUYRQrq8UWq-aDu1k64w-90060.jpg" }, { "width": 160, "height": 120, "url": "http://shutter10.pictures.aol.com:80/data/pictures/05/004/56/1F/83/C9/ KpZdbh5RgGiUYRQrq8UWq-aDu1k64w-900A0.jpg" }, { "width": 384, "height": 288, "url": "http://shutter10.pictures.aol.com:80/data/pictures/05/004/56/1F/83/C9/ KpZdbh5RgGiUYRQrq8UWq-aDu1k64w-90180.jpg" }, { "width": 768, "height": 576, "url": "http://shutter10.pictures.aol.com:80/data/pictures/05/004/56/1F/83/C9/ KpZdbh5RgGiUYRQrq8UWq-aDu1k64w-90300.jpg" }, { "width": 800, "height": 600, "url": "http://shutter10.pictures.aol.com:80/data/pictures/05/004/56/1F/83/C9/ KpZdbh5RgGiUYRQrq8UWq-aDu1k64w-90320.jpg" } ] }, { "creationDate": "Mon, 19 Jun 2006 12:57:54 -0800", "caption": "", "permalink": "http://links.pictures.aol.com/pic?id=5a70kV4KOAVzNQ- wVCHXSMZhPoNdBES7dyxBv4xQp5Fd3Ig=", "gallery": "http://pictures.aol.com/galleries/winterWoohoo/5a70kV4KOAVzNQ- wVCHXSMZhPoNdBES7dyxBv4xQp5Fd3Ig=", "id": "5a70kV4KOAVzNQ-wVCHXSMZhPoNdBES7dyxBv4xQp5Fd3Ig=", "sizes": [ { "width": 72, "height": 96, "url": "http://shutter06.pictures.aol.com:80/data/pictures/05/006/7F/6A/91/0C/ mVt3mdhKLlZGNcdS1PaNcnF+dgQUuByT0060.jpg" }, { "width": 120, "height": 160, "url": "http://shutter06.pictures.aol.com:80/data/pictures/05/006/7F/6A/91/0C/ mVt3mdhKLlZGNcdS1PaNcnF+dgQUuByT00A0.jpg" }, { "width": 250, "height": 332, "url": "http://shutter06.pictures.aol.com:80/data/pictures/05/006/7F/6A/91/0C/ mVt3mdhKLlZGNcdS1PaNcnF+dgQUuByT014C.jpg" }, { "width": 250, "height": 332, "url": "http://shutter06.pictures.aol.com:80/data/pictures/05/006/7F/6A/91/0C/ mVt3mdhKLlZGNcdS1PaNcnF+dgQUuByT014C.jpg" }, { "width": 250, "height": 332, "url": "http://shutter06.pictures.aol.com:80/data/pictures/05/006/7F/6A/91/0C/ mVt3mdhKLlZGNcdS1PaNcnF+dgQUuByT014C.jpg"
} ] } ] } } }
|
Decoding the Response
getPicturesByAlbumId returns
response status data, metadata for the album in AOL Pictures, and an
array of the album's pictures.
- statusCode
- A status code from a list of 3 digit standard codes.
- statusText
- A description of the error for developers, should not be shown to end
users.
- statusDetailCode
- A N digit code that is application specific. Service consumers can
use this code to provide more detail to their users, but it isn't
required.
- requestId
- If r parameter was used in the request, this echoes the value.
- data
- application data.
The application data has
metadata for the album and an array of the pictures.
- loginId
- the user that owns this album.
- creationDate
- the date on which the album was created. The date is formatted an an
RFC 822 date string.
- pictureCount
- the number of pictures in the album.
- pictures
- the number of pictures in the album.
Each picture in the pictures array has the following properties:
-
creationDate - the date the
picture was created. The date is formatted an an ISO 8601 date string.
-
caption - a user-created caption
for the picture, or an empty string ("") if no caption has been entered.
-
id - the picture ID. It contains
characters that need to be URL-escaped before sending to the server.
-
sizes - an array of the image
sizes that are available
for the picture, in the order smallest to largest. AOL stores each
picture at several different resolutions, based on the length of the
longest edge in pixels. For each size, the array provides the height
and width of the image in pixels, and the URL to retrieve that image
size.
These image sizes are available for each picture,
measured in pixels
on the longest edge: 96, 160, 364, 768, and full size (the original
picture resolution when it was uploaded to AOL Pictures). If the
full-sized picture is small, the largest available size will be
duplicated for larger sizes; refer to the last photo in the same
response above for an example.
-
permalink - URL's that are
returned in the sizes array
refer directly to their storage location, using URL's that start with
"shutterXX" (e.g. " http://shutter04.pictures.aol.com/...")
These URL's are transient, and may change over time. They should only
be used for the duration of an application session, and should not be
stored or exposed to the end user.
- Instead, the permalink provides a permanent link
to the picture,
i.e. an URL that is guaranteed not to change in the future. In order to
make a permalink to a particular image size, you must append a "size"
parameter to the URL with one of the following values (NB: The value
must be lowercase)
-
- "s" (small, 96 px)
- "t" (thumbnail, 160px)
- "m" (medium, 364px)
- "l" (large, 768px)
- "f" (full-size image, original resolution)
The final permalink URL should look like this:
http://links.pictures.aol.com/pic?id=5a70kV4KOAVzNQ-wVCHXSMZhPuLaA8VzTr6gv4xQp5Fd3Ig=&size=m
-
gallery - URL to the Public
Gallery showing this picture. Only shown if album is the Public Gallery.
|
| |
| getPublicGallery |
|
|
Retrieves
picture data and album metadata for the one Public Gallery album in AOL
Pictures. Pictures are sorted by most recently created first
Parameters
- t
- A string specifying the album owner's loginId. This parameter is
required
- f
- how should the data be formatted. Valid values: json. This parameter
is required.
- devId -
Developer Id from http://dev.aol.com. This parameter is required.
- h
- Host. A human readable name for the caller. This parameter is
required.
- locale
- Locale of the user. Valid values: de_DE, en_GB, en_IE, en_US, es_US,
es_ES, fr_FR, it_IT, nl_NL. This parameter is required.
- c
- Callback for JSON response. The valid characters in the callback
function are upper and lowercase alphabetic characters (A-Z a-z),
numbers (0-9), period (.), underscore (_). Response will be wrapped as
callback(response)
- r
- A URL safe request id string. This parameter is optional.
- max
- A positive integer that specifies the maximum number of pictures to
return. This parameter is optional.
Sample call
http://api.pictures.aol.com/gv1/pictures/getPublicGallery?f=json&devId=MYID&h=THEHOST&locale=en_
US&t=winterWoohoo
Sample Response
|
{ "response": { "statusCode": 200, "statusText": "Ok", "statusDetailCode": 1234, "requestId": "2345", "data": { "loginId": "winterWoohoo", "creationDate": "Mon, 19 Jun 2006 12:57:54 -0800", "id": "mFQYMXJcDsVX+KJF5a9ZLdpkLUSEf2dWgsz9yokfTk+JJdNX5w59hg==", "pictureCount": 3, "pictures": [ { "creationDate": "Mon, 19 Jun 2006 12:57:54 -0800", "caption": "", "permalink": "http://links.pictures.aol.com/pic?id=5a70kV4KOAVzNQ-wVCHXSMZhPlUYuX7B- kZMv4xQp5Fd3Ig=", "gallery": "http://pictures.aol.com/galleries/winterWoohoo/5a70kV4KOAVzNQ-wVCHXSMZhPlUYuX7B- kZMv4xQp5Fd3Ig=", "id": "5a70kV4KOAVzNQ-wVCHXSMZhPlUYuX7B-kZMv4xQp5Fd3Ig=", "sizes": [ { "width": 96, "height": 72, "url": "http://shutter04.pictures.aol.com:80/data/pictures/06/008/75/B4/85/F7/ Y8is+DPsKG-JxKyEPadZdrKER4zlep320060.jpg" }, { "width": 160, "height": 120, "url": "http://shutter04.pictures.aol.com:80/data/pictures/06/008/75/B4/85/F7/ Y8is+DPsKG-JxKyEPadZdrKER4zlep3200A0.jpg" }, { "width": 384, "height": 288, "url": "http://shutter04.pictures.aol.com:80/data/pictures/06/008/75/B4/85/F7/ Y8is+DPsKG-JxKyEPadZdrKER4zlep320180.jpg" }, { "width": 768, "height": 576, "url": "http://shutter04.pictures.aol.com:80/data/pictures/06/008/75/B4/85/F7/ Y8is+DPsKG-JxKyEPadZdrKER4zlep320300.jpg" }, { "width": 1600, "height": 1200, "url": "http://shutter04.pictures.aol.com:80/data/pictures/06/008/75/B4/85/F7/ Y8is+DPsKG-JxKyEPadZdrKER4zlep320640.jpg" } ] }, { "creationDate": "Mon, 19 Jun 2006 12:57:54 -0800", "caption": "", "permalink": "http://links.pictures.aol.com/pic?id=5a70kV4KOAVzNQ- wVCHXSMZhPm2OY4BqJwmjv4xQp5Fd3Ig=", "gallery": "http://pictures.aol.com/galleries/winterWoohoo/5a70kV4KOAVzNQ- wVCHXSMZhPm2OY4BqJwmjv4xQp5Fd3Ig=", "id": "5a70kV4KOAVzNQ-wVCHXSMZhPm2OY4BqJwmjv4xQp5Fd3Ig=", "sizes": [ { "width": 96, "height": 72, "url": "http://shutter10.pictures.aol.com:80/data/pictures/05/004/56/1F/83/C9/ KpZdbh5RgGiUYRQrq8UWq-aDu1k64w-90060.jpg" }, { "width": 160, "height": 120, "url": "http://shutter10.pictures.aol.com:80/data/pictures/05/004/56/1F/83/C9/ KpZdbh5RgGiUYRQrq8UWq-aDu1k64w-900A0.jpg" }, { "width": 384, "height": 288, "url": "http://shutter10.pictures.aol.com:80/data/pictures/05/004/56/1F/83/C9/ KpZdbh5RgGiUYRQrq8UWq-aDu1k64w-90180.jpg" }, { "width": 768, "height": 576, "url": "http://shutter10.pictures.aol.com:80/data/pictures/05/004/56/1F/83/C9/ KpZdbh5RgGiUYRQrq8UWq-aDu1k64w-90300.jpg" }, { "width": 800, "height": 600, "url": "http://shutter10.pictures.aol.com:80/data/pictures/05/004/56/1F/83/C9/ KpZdbh5RgGiUYRQrq8UWq-aDu1k64w-90320.jpg" } ] }, { "creationDate": "Mon, 19 Jun 2006 12:57:54 -0800", "caption": "", "permalink": "http://links.pictures.aol.com/pic?id=5a70kV4KOAVzNQ- wVCHXSMZhPoNdBES7dyxBv4xQp5Fd3Ig=", "gallery": "http://pictures.aol.com/galleries/winterWoohoo/5a70kV4KOAVzNQ- wVCHXSMZhPoNdBES7dyxBv4xQp5Fd3Ig=", "id": "5a70kV4KOAVzNQ-wVCHXSMZhPoNdBES7dyxBv4xQp5Fd3Ig=", "sizes": [ { "width": 72, "height": 96, "url": "http://shutter06.pictures.aol.com:80/data/pictures/05/006/7F/6A/91/0C/ mVt3mdhKLlZGNcdS1PaNcnF+dgQUuByT0060.jpg" }, { "width": 120, "height": 160, "url": "http://shutter06.pictures.aol.com:80/data/pictures/05/006/7F/6A/91/0C/ mVt3mdhKLlZGNcdS1PaNcnF+dgQUuByT00A0.jpg" }, { "width": 250, "height": 332, "url": "http://shutter06.pictures.aol.com:80/data/pictures/05/006/7F/6A/91/0C/ mVt3mdhKLlZGNcdS1PaNcnF+dgQUuByT014C.jpg" }, { "width": 250, "height": 332, "url": "http://shutter06.pictures.aol.com:80/data/pictures/05/006/7F/6A/91/0C/ mVt3mdhKLlZGNcdS1PaNcnF+dgQUuByT014C.jpg" }, { "width": 250, "height": 332, "url": "http://shutter06.pictures.aol.com:80/data/pictures/05/006/7F/6A/91/0C/ mVt3mdhKLlZGNcdS1PaNcnF+dgQUuByT014C.jpg" } ] } ] } } }
|
Decoding the Response
getPublicGallery
returns response status data, metadata for the My Public Photos album
in AOL Pictures, and an array of the album's pictures:
- statusCode
- A status code from a list of 3 digit standard codes.
- statusText
- A description of the error for developers, should not be shown to end
users.
- statusDetailCode
- An N digit code that is application specific. Service consumers can
use this code to provide more detail to their users, but it isn't
required.
- requestId
- If parameter r was used in the request, this echoes the value.
- data -
application data.
The application data has
metadata for the album and an array of the pictures.
- loginId
- the user that owns this album.
- creationDate
- the date on which the album was created. The date is formatted an an
RFC 822 date string.
- id
- the album ID. It contains characters that need to be URL-escaped
before sending to the server.
- pictureCount
- the number of pictures in the album.
- pictures
- an array of all pictures in the album.
Each picture in the pictures
array has the following properties:
- creationDate
- the date the picture was created. The date is
formatted an an ISO 8601 date string.
- caption
- a user-created caption for the picture, or an empty string ("") if
no caption has been entered.
- id
- the picture ID. It contains characters that need to be URL-escaped
before sending to the server.
-
sizes
-an array of the image sizes that are available for the picture, in the
order smallest to largest. AOL stores each picture at several different
resolutions, based on the length of the longest edge in pixels. For
each size, the array provides the height and width of the image in
pixels, and the URL to retrieve that image size
These
image sizes are available for each picture, measured in pixels on the
longest edge: 96, 160, 364, 768, and full size (the original picture
resolution when it was uploaded to AOL Pictures). If the full-sized
picture is small, the largest available size will be duplicated for
larger sizes; refer to the last photo in the same response above for an
example.
-
permalink
- URL's that are returned in the sizes array refer directly to
their
storage location, using URL's that start with "shutterXX" (e.g. " http://shutter04.pictures.aol.com/...")
These URL's are transient, and may change over time. They should only
be used for the duration of an application session, and should not be
stored or exposed to the end user.
- Instead, the permalink provides a permanent link
to the picture,
i.e. an URL that is guaranteed not to change in the future. In order to
make a permalink to a particular image size, you must append a "size"
parameter to the URL with one of the following values (NB: The value
must be lowercase)
-
- "s" (small, 96 px)
- "t" (thumbnail, 160px)
- "m" (medium, 364px)
- "l" (large, 768px)
- "f" (full-size image, original resolution)
The final permalink URL should look like this:
http://links.pictures.aol.com/pic?id=5a70kV4KOAVzNQ-wVCHXSMZhPuLaA8VzTr6gv4xQp5Fd3Ig=&size=m
- gallery
- URL to the Public Gallery showing this picture.
|
| |
| getPublicTagsByUser |
|
|
Retrieves list of tag on
Public Photos for a given user loginId. Tags are sorted by most popular
first.
Parameters
- t
- A string specifying the album owner's loginId. This parameter is
required
- f-
How should the data be formatted. Valid values: json. This parameter is
required.Limit results to the named category of albums. Valid
categories are: "myAlbums", "aimPages", "blogs", and "memberProfile".
This parameter is optional.
- devId -
Developer Id from http://dev.aol.com. This parameter is required.
- h
- Host. A human readable name for the caller. This parameter is
required.
- locale
- Locale of the user. Valid values: de_DE, en_GB, en_IE, en_US, es_US,
es_ES, fr_FR, it_IT, nl_NL. This parameter is required.
- c
- Callback for JSON response. The valid characters in the callback
function are upper and lowercase alphabetic characters (A-Z a-z),
numbers (0-9), period (.), underscore (_). Response will be wrapped as
callback(response)
- r
- A URL safe request id string. This parameter is optional.
- max
- A positive integer that specifies the maximum number of pictures to
return. This parameter is optional.
Sample call
http://api.pictures.aol.com/gv1/pictures/getPublicTagsByUser?f=json&devId=MYID&h=THEHOST&
locale=en_US&t=winterWoohoo
Sample Response
|
{ "response": { "statusCode": 200, "statusText": "Ok", "statusDetailCode": 1234, "requestId": "2345", "data": { { "loginId": "winterWoohoo", "tags": [ { "name": "snow", "cnt": 18, }, { "name": "ski", "cnt": 12, } ] } } }
}
|
Decoding the Response
getMyPublicTags returns
response status data and an array of tags on Public photos for the
specified user.
- statusCode
- A status code from a list of 3 digit standard codes
- statusText
- A description of the error for developers,
should not be shown to end users.
- statusDetailCode
- A N digit code that is application specific. Service consumers can
use this code to provide more detail to their users, but it isn't
required.
- requestId
- If r parameter was used in the request, this
echoes the value.
- data -
application data
The application data has an
array of the tags.
|
| |
| getTaggedPublicPhotos |
|
|
Retrieves picture data for
tagged Public Photos in AOL Pictures. Pictures are sorted by most
recently tagged first.
Parameters
- tag
- A string specifying the tag name. Multiple tags can be
comma-separated. This parameter is required.
- f
- - how should the data be formatted. Valid values: json. This
parameter is required.
- devId -
Developer Id from http://dev.aol.com. This parameter is required.
- h
- Host. A human readable name for the caller. This parameter is
required.
- locale
- Locale of the user. Valid values: de_DE, en_GB, en_IE, en_US, es_US,
es_ES, fr_FR, it_IT, nl_NL. This parameter is required.
- c
- Callback for JSON response. The valid characters in the callback
function are upper and lowercase alphabetic characters (A-Z a-z),
numbers (0-9), period (.), underscore (_). Response will be wrapped as
callback(response)
- r
- A URL safe request id string. This parameter is optional.
- max
- A positive integer that specifies the maximum number of pictures to
return. This parameter is optional.
Sample call
http://api.pictures.aol.com/gv1/pictures/getTaggedPublicPhotos?f=json&devId=MYID&h=THEHOST&
locale=en_US&tag=snow
Sample Response
|
{ "response": { "statusCode": 200, "statusText": "Ok", "statusDetailCode": 1234, "requestId": "2345", "data": { { "tags": [ { "tag": "snow" } ], "pictureCount": 3, "pictures": [ { "loginId": "winterWoohoo", "creationDate": "Mon, 19 Jun 2006 12:57:54 -0800", "caption": "", "permalink": "http://links.pictures.aol.com/pic?id=5a70kV4KOAVzNQ-wVCHXSMZhPlUYuX7B- kZMv4xQp5Fd3Ig=", "gallery": "http://pictures.aol.com/galleries/winterWoohoo/5a70kV4KOAVzNQ-wVCHXSMZhPlUYuX7B- kZMv4xQp5Fd3Ig=", "id": "5a70kV4KOAVzNQ-wVCHXSMZhPlUYuX7B-kZMv4xQp5Fd3Ig=", "sizes": [ { "width": 96, "height": 72, "url": "http://shutter04.pictures.aol.com:80/data/pictures/06/008/75/B4/85/F7/ Y8is+DPsKG- JxKyEPadZdrKER4zlep320060.jpg" }, { "width": 160, "height": 120, "url": "http://shutter04.pictures.aol.com:80/data/pictures/06/008/75/B4/85/F7/ Y8is+DPsKG-JxKyEPadZdrKER4zlep3200A0.jpg" }, { "width": 384, "height": 288, "url": "http://shutter04.pictures.aol.com:80/data/pictures/06/008/75/B4/85/F7/ Y8is+DPsKG-JxKyEPadZdrKER4zlep320180.jpg" }, { "width": 768, "height": 576, "url": "http://shutter04.pictures.aol.com:80/data/pictures/06/008/75/B4/85/F7/ Y8is+DPsKG-JxKyEPadZdrKER4zlep320300.jpg" }, { "width": 1600, "height": 1200, "url": "http://shutter04.pictures.aol.com:80/data/pictures/06/008/75/B4/85/F7/ Y8is+DPsKG-JxKyEPadZdrKER4zlep320640.jpg" } ] }, { "loginId": "winterWoohoo", "creationDate": "Mon, 19 Jun 2006 12:57:54 -0800", "caption": "", "permalink": "http://links.pictures.aol.com/pic?id=5a70kV4KOAVzNQ- wVCHXSMZhPm2OY4BqJwmjv4xQp5Fd3Ig=", "gallery": "http://pictures.aol.com/galleries/winterWoohoo/5a70kV4KOAVzNQ- wVCHXSMZhPm2OY4BqJwmjv4xQp5Fd3Ig=", "id": "5a70kV4KOAVzNQ-wVCHXSMZhPm2OY4BqJwmjv4xQp5Fd3Ig=", "sizes": [ { "width": 96, "height": 72, "url": "http://shutter10.pictures.aol.com:80/data/pictures/05/004/56/1F/83/C9/ KpZdbh5RgGiUYRQrq8UWq-aDu1k64w-90060.jpg" }, { "width": 160, "height": 120, "url": "http://shutter10.pictures.aol.com:80/data/pictures/05/004/56/1F/83/C9/ KpZdbh5RgGiUYRQrq8UWq-aDu1k64w-900A0.jpg" }, { "width": 384, "height": 288, "url": "http://shutter10.pictures.aol.com:80/data/pictures/05/004/56/1F/83/C9/ KpZdbh5RgGiUYRQrq8UWq-aDu1k64w-90180.jpg" }, { "width": 768, "height": 576, "url": "http://shutter10.pictures.aol.com:80/data/pictures/05/004/56/1F/83/C9/ KpZdbh5RgGiUYRQrq8UWq-aDu1k64w-90300.jpg" }, { "width": 800, "height": 600, "url": "http://shutter10.pictures.aol.com:80/data/pictures/05/004/56/1F/83/C9/ KpZdbh5RgGiUYRQrq8UWq-aDu1k64w-90320.jpg" } ] }, { "loginId": "winterWoohoo", "creationDate": "Mon, 19 Jun 2006 12:57:54 -0800", "caption": "", "permalink": "http://links.pictures.aol.com/pic?id=5a70kV4KOAVzNQ- wVCHXSMZhPoNdBES7dyxBv4xQp5Fd3Ig=", "gallery": "http://pictures.aol.com/galleries/winterWoohoo/5a70kV4KOAVzNQ- wVCHXSMZhPoNdBES7dyxBv4xQp5Fd3Ig=", "id": "5a70kV4KOAVzNQ-wVCHXSMZhPoNdBES7dyxBv4xQp5Fd3Ig=", "sizes": [ { "width": 72, "height": 96, "url": "http://shutter06.pictures.aol.com:80/data/pictures/05/006/7F/6A/91/0C/ mVt3mdhKLlZGNcdS1PaNcnF+dgQUuByT0060.jpg" }, { "width": 120, "height": 160, "url": "http://shutter06.pictures.aol.com:80/data/pictures/05/006/7F/6A/91/0C/ mVt3mdhKLlZGNcdS1PaNcnF+dgQUuByT00A0.jpg" }, { "width": 250, "height": 332, "url": "http://shutter06.pictures.aol.com:80/data/pictures/05/006/7F/6A/91/0C/ mVt3mdhKLlZGNcdS1PaNcnF+dgQUuByT014C.jpg" }, { "width": 250, "height": 332, "url": "http://shutter06.pictures.aol.com:80/data/pictures/05/006/7F/6A/91/0C/ mVt3mdhKLlZGNcdS1PaNcnF+dgQUuByT014C.jpg" }, { "width": 250, "height": 332, "url": "http://shutter06.pictures.aol.com:80/data/pictures/05/006/7F/6A/91/0C/ mVt3mdhKLlZGNcdS1PaNcnF+dgQUuByT014C.jpg" } ] } ] } } } }
|
Decoding the Response
getTaggedPublicPhotos returns
an array of the tags and the pictures:
- statusCode
- A status code from a list of 3 digit standard codes.
- statusText
- A description of the error for developers, should not be shown to end
users.
- statusDetailCode
- An N digit code that is application specific. Service consumers can
use this code to provide more detail to their users, but it isn't
required.
- requestId
- If parameter r was used in the request, this echoes the value.
- data -
application data.
The application data has an
array of the tags and an array of the pictures.
- pictureCount
- the number of pictures.
- tags
- an array of the tags.
- pictures
- an array of all pictures.
Each picture in the pictures
array has the following properties:
- loginId
- the user that owns this picture.
- creationDate
- the date the picture was created. The date is
formatted an an ISO 8601 date string.
- caption
- a user-created caption for the picture, or an empty string ("") if
no caption has been entered.
- id
- the picture ID. It contains characters that need to be URL-escaped
before sending to the server.
-
sizes
-an array of the image sizes that are available for the picture, in the
order smallest to largest. AOL stores each picture at several different
resolutions, based on the length of the longest edge in pixels. For
each size, the array provides the height and width of the image in
pixels, and the URL to retrieve that image size.
These
image sizes are available for each picture, measured in pixels on the
longest edge: 96, 160, 364, 768, and full size (the original picture
resolution when it was uploaded to AOL Pictures). If the full-sized
picture is small, the largest available size will be duplicated for
larger sizes; refer to the last photo in the same response above for an
example.
-
permalink
- URL's that are returned in the sizes array refer directly to their
storage location, using URL's that start with "shutterXX" (e.g. "
http://shutter04.pictures.aol.com/...") These URL's are transient, and
may change over time. They should only be used for the duration of an
application session, and should not be stored or exposed to the end
user.
Instead,
the permalink provides a permanent link to the picture, i.e. an URL
that is guaranteed not to change in the future. In order to make a
permalink to a particular image size, you must append a "size"
parameter to the URL with one of the following values (NB: The value
must be lowercase):
- "s" (small,
96 px)
- "t"
(thumbnail, 160px)
- "m"
(medium, 364px)
- "l" (large,
768px)
- "f" (full-size image,
original resolution)
The final permalink URL
should look like this:
http://links.pictures.aol.com/pic?id=5a70kV4KOAVzNQ-wVCHXSMZhPuLaA8VzTr6gv4xQp5Fd3Ig=&size=m
- gallery
- URL to the Public Gallery showing this picture.
|
| |
| getTaggedPublicPhotosByUser |
|
|
Retrieves
picture data and album metadata for tagged Public Photos in AOL
Pictures for a given user loginId. Pictures are sorted by most recently
tagged first.
Parameters
- t
- A string specifying the album owner's loginId. This parameter is
required
- tag
- A string specifying the tag name. Multiple tags can be
comma-separated. This parameter is required.
- f-
How should the data be formatted. Valid values: json. This parameter is
required..
- devId -
Developer Id from http://dev.aol.com. This parameter is required.
- h
- Host. A human readable name for the caller. This parameter is
required.
- locale
- Locale of the user. Valid values: de_DE, en_GB, en_IE, en_US, es_US,
es_ES, fr_FR, it_IT, nl_NL. This parameter is required.
- c
- Callback for JSON response. The valid characters in the callback
function are upper and lowercase alphabetic characters (A-Z a-z),
numbers (0-9), period (.), underscore (_). Response will be wrapped as
callback(response)
- r
- A URL safe request id string. This parameter is optional.
- max
- A positive integer that specifies the maximum number of pictures to
return. This parameter is optional.
Sample call
http://api.pictures.aol.com/gv1/pictures/getTaggedPublicPhotosByUser?f=json&devId=MYID&h=
THEHOST&locale=en_US&t=winterWoohoo&tag=snow
Sample Response
|
{ "response": { "statusCode": 200, "statusText": "Ok", "statusDetailCode": 1234, "requestId": "2345", "data": { { "tags": [ { "tag": "snow" } ], "loginId": "winterWoohoo", "creationDate": "Mon, 19 Jun 2006 12:57:54 -0800, "id": "mFQYMXJcDsVX+KJF5a9ZLdpkLUSEf2dWgsz9yokfTk+JJdNX5w59hg==", "pictureCount": 3, "pictures": [ { "creationDate": "Mon, 19 Jun 2006 12:57:54 -0800", "caption": "", "permalink": "http://links.pictures.aol.com/pic?id=5a70kV4KOAVzNQ- wVCHXSMZhPlUYuX7B-kZMv4xQp5Fd3Ig=", "gallery": "http://pictures.aol.com/galleries/winterWoohoo/5a70kV4KOAVzNQ- wVCHXSMZhPlUYuX7B-kZMv4xQp5Fd3Ig=", "id": "5a70kV4KOAVzNQ-wVCHXSMZhPlUYuX7B-kZMv4xQp5Fd3Ig=", "sizes": [ { "width": 96, "height": 72, "url": "http://shutter04.pictures.aol.com:80/data/pictures/06/008/75/B4/85/F7/ Y8is+DPsKG-JxKyEPadZdrKER4zlep320060.jpg" }, { "width": 160, "height": 120, "url": "http://shutter04.pictures.aol.com:80/data/pictures/06/008/75/B4/85/F7/ Y8is+DPsKG-JxKyEPadZdrKER4zlep3200A0.jpg" }, { "width": 384, "height": 288, "url": "http://shutter04.pictures.aol.com:80/data/pictures/06/008/75/B4/85/F7/ Y8is+DPsKG-JxKyEPadZdrKER4zlep320180.jpg" }, { "width": 768, "height": 576, "url": "http://shutter04.pictures.aol.com:80/data/pictures/06/008/75/B4/85/F7/ Y8is+DPsKG-JxKyEPadZdrKER4zlep320300.jpg" }, { "width": 1600, "height": 1200, "url": "http://shutter04.pictures.aol.com:80/data/pictures/06/008/75/B4/85/F7/ Y8is+DPsKG-JxKyEPadZdrKER4zlep320640.jpg" } ] }, { "creationDate": "Mon, 19 Jun 2006 12:57:54 -0800", "caption": "", "permalink": "http://links.pictures.aol.com/pic?id=5a70kV4KOAVzNQ- wVCHXSMZhPm2OY4BqJwmjv4xQp5Fd3Ig=", "gallery": "http://pictures.aol.com/galleries/winterWoohoo/5a70kV4KOAVzNQ- wVCHXSMZhPm2OY4BqJwmjv4xQp5Fd3Ig=", "id": "5a70kV4KOAVzNQ-wVCHXSMZhPm2OY4BqJwmjv4xQp5Fd3Ig=", "sizes": [ { "width": 96, "height": 72, "url": "http://shutter10.pictures.aol.com:80/data/pictures/05/004/56/1F/83/C9/ KpZdbh5RgGiUYRQrq8UWq-aDu1k64w-90060.jpg" }, { "width": 160, "height": 120, "url": "http://shutter10.pictures.aol.com:80/data/pictures/05/004/56/1F/83/C9/ KpZdbh5RgGiUYRQrq8UWq-aDu1k64w-900A0.jpg" }, { "width": 384, "height": 288, "url": "http://shutter10.pictures.aol.com:80/data/pictures/05/004/56/1F/83/C9/ KpZdbh5RgGiUYRQrq8UWq-aDu1k64w-90180.jpg" }, { "width": 768, "height": 576, "url": "http://shutter10.pictures.aol.com:80/data/pictures/05/004/56/1F/83/C9/ KpZdbh5RgGiUYRQrq8UWq-aDu1k64w-90300.jpg" }, { "width": 800, "height": 600, "url": "http://shutter10.pictures.aol.com:80/data/pictures/05/004/56/1F/83/C9/ KpZdbh5RgGiUYRQrq8UWq-aDu1k64w-90320.jpg" } ] }, { "creationDate": "Mon, 19 Jun 2006 12:57:54 -0800", "caption": "", "permalink": "http://links.pictures.aol.com/pic?id=5a70kV4KOAVzNQ- wVCHXSMZhPoNdBES7dyxBv4xQp5Fd3Ig=", "gallery": "http://pictures.aol.com/galleries/winterWoohoo/5a70kV4KOAVzNQ- wVCHXSMZhPoNdBES7dyxBv4xQp5Fd3Ig=", "id": "5a70kV4KOAVzNQ-wVCHXSMZhPoNdBES7dyxBv4xQp5Fd3Ig=", "sizes": [ { "width": 72, "height": 96, "url": "http://shutter06.pictures.aol.com:80/data/pictures/05/006/7F/6A/91/0C/ mVt3mdhKLlZGNcdS1PaNcnF+dgQUuByT0060.jpg" }, { "width": 120, "height": 160, "url": "http://shutter06.pictures.aol.com:80/data/pictures/05/006/7F/6A/91/0C /mVt3mdhKLlZGNcdS1PaNcnF+dgQUuByT00A0.jpg" }, { "width": 250, "height": 332, "url": "http://shutter06.pictures.aol.com:80/data/pictures/05/006/7F/6A/91/0C/ mVt3mdhKLlZGNcdS1PaNcnF+dgQUuByT014C.jpg" }, { "width": 250, "height": 332, "url": "http://shutter06.pictures.aol.com:80/data/pictures/05/006/7F/6A/91/0C/ mVt3mdhKLlZGNcdS1PaNcnF+dgQUuByT014C.jpg" }, { "width": 250, "height": 332, "url": "http://shutter06.pictures.aol.com:80/data/pictures/05/006/7F/6A/91/0C/ mVt3mdhKLlZGNcdS1PaNcnF+dgQUuByT014C.jpg" } ] } ] } } } }
|
Decoding the Response
getMyTaggedPublicPhotos
returns metadata for the My Public Photos album in AOL Pictures, and an
array of the album's pictures which have the specific tag(s).
- statusCode
- A status code from a list of 3 digit standard codes
- statusText
- A description of the error for developers,
should not be shown to end users.
- statusDetailCode
- A N digit code that is application specific. Service consumers can
use this code to provide more detail to their users, but it isn't
required.
- requestId
- If r parameter was used in the request, this
echoes the value.
- data -
application data
The application data has
metadata for the album, an array of tags and an array of the pictures.
- loginId
- the user that owns this album.
- creationDate
- the date on which the album was created. The date is formatted an an
RFC 822 date string.
- id
- the album ID. It contains characters that need to be URL-escaped
before sending to the server.
- pictureCount
- the number of pictures in the album.
- tags
- an array of the tags
- pictures
- an array of all pictures.
Each picture in the pictures
array has the following properties:
- creationDate
- the date the picture was created. The date is
formatted an an ISO 8601 date string.
- caption
- - a user-created caption for the picture, or an empty string ("") if
no caption has been entered.
- id
- the picture ID. It contains characters that need to be URL-escaped
before sending to the server.
-
sizes
-an array of the image sizes that are available for the picture, in the
order smallest to largest. AOL stores each picture at several different
resolutions, based on the length of the longest edge in pixels. For
each size, the array provides the height and width of the image in
pixels, and the URL to retrieve that image size.
These
image sizes are available for each picture, measured in pixels on the
longest edge: 96, 160, 364, 768, and full size (the original picture
resolution when it was uploaded to AOL Pictures). If the full-sized
picture is small, the largest available size will be duplicated for
larger sizes; refer to the last photo in the same response above for an
example.
-
permalink
- URL's that are returned in the sizes array refer directly to their
storage location, using URL's that start with "shutterXX" (e.g. "
http://shutter04.pictures.aol.com/...") These URL's are transient, and
may change over time. They should only be used for the duration of an
application session, and should not be stored or exposed to the end
user.
Instead,
the permalink provides a permanent link to the picture, i.e. an URL
that is guaranteed not to change in the future. In order to make a
permalink to a particular image size, you must append a "size"
parameter to the URL with one of the following values (NB: The value
must be lowercase):
- "s" (small,
96 px)
- "t"
(thumbnail, 160px)
- "m"
(medium, 364px)
- "l" (large,
768px)
- "f" (full-size image,
original resolution)
The final permalink URL
should look like this:
http://links.pictures.aol.com/pic?id=5a70kV4KOAVzNQ-wVCHXSMZhPuLaA8VzTr6gv4xQp5Fd3Ig=&size=m
- gallery
- URL to the Public Gallery showing this picture.
|