photo-front/documentation/api/GetPhotos.markdown

Open Photo API / Get Photos

OpenPhoto, a photo service for the masses

---

1. Purpose
2. Endpoint
3. Parameters
4. Examples

• Command line
• PHP

1. Response

• Sample

---

Purpose of the Get Photos API

Use this API to get a set of photos for a user.

NOTE: Always pass in the returnSizes parameter for sizes you plan on using. It's the only way to guarantee that a URL for that size will be present in the response. See Photo Generation for details.

---

Endpoint

Authentication: optional

GET /photos.json

Parameters

1. returnSizes (optional), The photo sizes you'd like in the response. Specify every size you plan on using. Docs for this parameter
2. pageSize (optional), Number of photos to return per request.
3. page (optional), Page number when browsing through photos. Starts at 1.
4. tags (optional), i.e. dog,cat - A comma delimited string of strings.

---

Examples

Command Line (using openphoto-php)

./openphoto -p -h current.openphoto.me -e /photos/list.json -F 'tags=sunnyvale'

PHP (using openphoto-php)

$client = new OpenPhotoOAuth($host, $consumerKey, $consumerSecret, $oauthToken, $oauthTokenSecret);
$response = $client->get("/photos/list.json", array('tags' => 'sunnyvale'));

---

Response

The response is in a standard response envelope.

• message, A string describing the result. Don't use this for anything but reading.
• code, 200 on success
• result, An array of Photo objects

Sample

{
  "message":"",
  "code":200,
  "result":[
    {
      "tags":[
         ""
      ],
      "pathBase":"\/base\/201107\/1311045184-opme7Z0WBh.jpg",
      "appId":"opme",
      "host":"testjmathai1.s3.amazonaws.com",
      "dateUploadedMonth":"07",
      "status":"1",
      "hash":"fba49a238426ac3485af6d69967ccd2d08c1fe5c",
      "width":"569",
      "dateTakenMonth":"07",
      "dateTakenDay":"18",
      "permission":"0",
      "pathOriginal":"\/original\/201107\/1311045184-opme7Z0WBh.jpg",
      "exifCameraMake":"",
      "size":"0",
      "dateTaken":"1311045184",
      "height":"476",
      "views":"0",
      "dateUploadedYear":"2011",
      "dateTakenYear":"2011",
      "creativeCommons":"BY-NC",
      "dateUploadedDay":"18",
      "dateUploaded":"1311045188",
      "exifCameraModel":"",
      "path200x200":"\/custom\/201107\/1311045184-opme7Z0WBh_200x200.jpg",
      "id":"hl"
    },
    {
      "tags":[
         ""
      ],
      "pathBase":"\/base\/201107\/1311027064-opme0WBhqP.jpg",
      "appId":"opme",
      "host":"testjmathai1.s3.amazonaws.com",
      "dateUploadedMonth":"07",
      "status":"1",
      "hash":"fba49a238426ac3485af6d69967ccd2d08c1fe5c",
      "width":"569",
      "dateTakenMonth":"07",
      "dateTakenDay":"18",
      "permission":"0",
      "pathOriginal":"\/original\/201107\/1311027064-opme0WBhqP.jpg",
      "exifCameraMake":"",
      "size":"0",
      "dateTaken":"1311027064",
      "height":"476",
      "views":"0",
      "dateUploadedYear":"2011",
      "dateTakenYear":"2011",
      "creativeCommons":"BY-NC",
      "dateUploadedDay":"18",
      "dateUploaded":"1311027066",
      "exifCameraModel":"",
      "id":"ob"
    }
  ]
}