Page tree

Versions Compared

Key

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

blog

GET /blog

Browse blogs

Example URI

...

Parameter

Type

Require ?

Description

search[search]

string

no

Keyword for searching

user_id

number

no

Browse by owner id

sort

string

no

Support sort return results

limit

number

no

Limit return results

page

number

no

Paging return results

item_id

number

no

Support search blogs on item (pages/groups)

module_id

string

no

Support search blogs on item (pages/groups)

category

number

no

Support search blogs by category id

tag

string

no

Support search blogs by tags

view

string

no

Support some view mode: spam, pending, my, draft

...

POST /blog

Post new blog

Example URI

Code Block
bash
bash

 http://example.com/restful_api/blog

...

Parameters

Parameter

Type

Require ?

Description

val[title]

string

yes

Blog title

val[text]

string

yes

Blog text

val[categories]

array

no

Blog categories

val[privacy]

number

no

Limit return results

val[tag_list]

string

no

Tags list for the blog

val[publish]

boolean

no

Publish blog

val[draft]

boolean

no

Save blog as draft

val[module_id]

string

no

Support post blog on item (pages/groups...)

val[item_id]

string

no

Support post blog on item (pages/groups...)

...

Get information of a specific blog

Example URI

Code Block
bash
bash

 http://example.com/restful_api/blog/7

...

Parameters

Parameter

Type

Require ?

Description

id

number

yes

Blog id

...

Update information for a specific blog

Example URI

Code Block
bash
bash

 http://example.com/restful_api/blog/7

...

Parameters

Parameter

Type

Require ?

Description

id

number

yes

Blog id

val[title]

string

no

Blog title

val[text]

string

no

Blog text

val[categories]

array

no

Blog categories

val[privacy]

number

no

Limit return results

val[tag_list]

string

no

Tags list for the blog

val[publish]

boolean

no

Publish blog

...

Delete a specific blog

Example URI

Code Block
bash
bash

 http://example.com/restful_api/blog/7

...

Parameters

Parameter

Type

Require ?

Description

id

number

yes

Blog id

...