Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

GET /photo

Browse photos

Example URI

http://example.com/restful_api/photo?user_id=10

Parameters

ParameterTypeRequire ?Description
search[search]stringnoKeyword for searching
user_idnumbernoBrowse by owner id
sortstringnoSupport sort return results, available values: latestmost-likedmost-talked
limitnumbernoLimit return results
pagenumbernoPaging return results
item_idnumbernoSupport browse photos on item (pages/groups)
module_idstringnoSupport browse photos on item (pages/groups)
categorynumbernoSupport search photos by category id
tagstringnoSupport search photos by tags
viewstringnoSupport some view mode: pendingmyfeatured

Response

{
  "status": "success",
  "data": [
    {
      "is_liked": null,
      "user_id": "1",
      "photo_id": "11",
      "album_id": "0",
      "module_id": null,
      "group_id": "0",
      "privacy": "0",
      "privacy_comment": "0",
      "title": "photo_1",
      "time_stamp": "1481515372",
      "is_featured": "0",
      "is_sponsor": "0",
      "categories": null,
      "bookmark_url": "http://example.com/photo/11/509795882_preview_maxresdefault/",
      "photo_url": "http://example.com/PF.Base/file/pic/photo/2016/12/c266f348b34952c46eda13ced1daed00_1024.jpg"
    },
    {
      "is_liked": null,
      "user_id": "1",
      "photo_id": "10",
      "album_id": "0",
      "module_id": null,
      "group_id": "0",
      "privacy": "0",
      "privacy_comment": "0",
      "title": "photo_2",
      "time_stamp": "1481247906",
      "is_featured": "0",
      "is_sponsor": "0",
      "categories": null,
      "bookmark_url": "http://example.com/photo/10/509795882_preview_maxresdefault/",
      "photo_url": "http://example.com/PF.Base/file/pic/photo/2016/12/0a59cf98aef18ad53619bdec43d47c97_1024.jpg"
    }
  ],
  "messages": []
}

POST /photo

Share new photos

Example URI

http://example.com/restful_api/photo

Parameters

ParameterTypeRequire ?Description
image[]arrayyesPhotos lists
val[description]stringyesExtra text to share with
val[user_id]numbernoSupport share photo on user profile
val[is_cover_photo]booleannoSupport upload cover photo
val[album_id]numbernoAlbum id
val[privacy]numbernoPrivacy id
val[module_id]stringnoSupport share photo on item (pages/groups/event)
val[item_id]numbernoSupport share photo on item (pages/groups/event)
val[custom_pages_post_as_page]numbernoSupport share photo as page

Response

 {
  "status": "success",
  "data": [
    {
      "is_liked": null,
      "user_id": "1",
      "photo_id": "14",
      "album_id": "0",
      "module_id": "event",
      "group_id": "1",
      "privacy": "0",
      "privacy_comment": "0",
      "title": "christmas-tree",
      "time_stamp": "1481888433",
      "is_featured": "0",
      "is_sponsor": "0",
      "categories": null,
      "bookmark_url": "http://example.com/photo/14/christmas-tree/",
      "photo_url": "http://example.com/PF.Base/file/pic/photo/2016/12/718d0e2a99dbe3091bf5e7734ed03098_1024.png"
    },
    {
      "is_liked": null,
      "user_id": "1",
      "photo_id": "15",
      "album_id": "0",
      "module_id": "event",
      "group_id": "1",
      "privacy": "0",
      "privacy_comment": "0",
      "title": "snowman",
      "time_stamp": "1481888433",
      "is_featured": "0",
      "is_sponsor": "0",
      "categories": null,
      "bookmark_url": "http://example.com/photo/15/snowman/",
      "photo_url": "http://example.com/PF.Base/file/pic/photo/2016/12/43a46fac997e887034c23c085ab0bbe8_1024.png"
    }
  ],
  "messages": [
    "Photos successfully uploaded."
  ]
}

GET /photo/:id

Get information of a specific photo

Example URI

http://example.com/restful_api/photo/15

Parameters

ParameterTypeRequire ?Description
idnumberyesPhoto id

Response

 {
  "status": "success",
  "data": {
    "is_liked": null,
    "user_id": "1",
    "photo_id": "15",
    "album_id": "0",
    "module_id": "event",
    "group_id": "1",
    "privacy": "0",
    "privacy_comment": "0",
    "title": "snowman",
    "time_stamp": "1481888433",
    "is_featured": "0",
    "is_sponsor": "0",
    "categories": null,
    "bookmark_url": "http://example.com/photo/15/snowman/",
    "photo_url": "http://example.com/PF.Base/file/pic/photo/2016/12/43a46fac997e887034c23c085ab0bbe8_1024.png"
  },
  "messages": []
}

PUT /photo/:id

Update information for a specific photo

Example URI

http://example.com/restful_api/photo/15

Parameters

ParameterTypeRequire ?Description
idnumberyesPhoto id
val[privacy]numbernoPrivacy id
val[move_to]numbernoAlbum id to move
val[description]stringnoPhoto description
val[category_id][]arraynoList of category id
val[tag_list]stringnoList of tags
val[mature]booleannoPhoto is mature photo or not
val[allow_download]booleannoCan download photo or not

Response

 {
  "status": "success",
  "data": {
    "is_liked": null,
    "user_id": "1",
    "photo_id": "15",
    "album_id": "1",
    "module_id": null,
    "group_id": "0",
    "privacy": "0",
    "privacy_comment": "0",
    "title": "snowman",
    "time_stamp": "1481189921",
    "is_featured": "0",
    "is_sponsor": "0",
    "categories": [
      {
        "0": "Comedy",
        "1": "http://example.com/photo/category/4/comedy/",
        "category_id": "4"
      }
    ],
    "bookmark_url": "http://example.com/15/snowman/",
    "photo_url": "http://example.com/PF.Base/file/pic/photo/2016/12/43a46fac997e887034c23c085ab0bbe8_1024.png"
  },
  "messages": [
    "Photo successfully updated."
  ]
}

DELETE /photo/:id

Delete a specific photo

Example URI

http://example.com/restful_api/photo/15

Parameters

ParameterTypeRequire ?Description
idnumberyesPhoto id

Response

 {
  "status": "success",
  "data": [],
  "messages": [
    "Photo successfully deleted."
  ]
}
  • No labels