Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

GET /photo

Browse photos

Example URI

Code Block
bash
bash

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

...

Parameters

Parameter

Type

Require ?

Description

searchsearch

string

no

Keyword for searching

user_id

number

no

Browse by owner id

sort

string

no

Support sort return results, available values: latest, most-liked, most-talked

limit

number

no

Limit return results

page

number

no

Paging return results

item_id

number

no

Support browse photos on item (pages/groups)

module_id

string

no

Support browse photos on item (pages/groups)

category

number

no

Support search photos by category id

tag

string

no

Support search photos by tags

view

string

no

Support some view mode: pending, my, featured

...

Share new photos

Example URI

Code Block
bash
bash

 http://example.com/restful_api/photo

...

Parameters

Parameter

Type

Require ?

Description

image[]

array

yes

Photos lists

val[description]

string

yes

Extra text to share with

val[user_id]

number

no

Support share photo on user profile

val[is_cover_photo]

boolean

no

Support upload cover photo

val[album_id]

number

no

Album id

val[privacy]

number

no

Privacy id

val[module_id]

string

no

Support share photo on item (pages/groups/event)

val[item_id]

number

no

Support share photo on item (pages/groups/event)

val[custom_pages_post_as_page]

number

no

Support share photo as page

...

Get information of a specific photo

Example URI

Code Block
bash
bash

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

...

Parameters

Parameter

Type

Require ?

Description

id

number

yes

Photo id

...

Update information for a specific photo

Example URI

Code Block
bash
bash

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

...

Parameters

Parameter

Type

Require ?

Description

id

number

yes

Photo id

val[privacy]

number

no

Privacy id

val[move_to]

number

no

Album id to move

val[description]

string

no

Photo description

val[category_id][]

array

no

List of category id

val[tag_list]

string

no

List of tags

val[mature]

boolean

no

Photo is mature photo or not

val[allow_download]

boolean

no

Can download photo or not

...

Delete a specific photo

Example URI

Code Block
bash
bash

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

...

Parameters

Parameter

Type

Require ?

Description

id

number

yes

Photo id

...