CMS Data Objects
User
Key | Type | Mandatory | Comment |
---|---|---|---|
user_id | int | Yes | User id |
name | string | Yes | User display name |
avatar | string | No | User avatar url |
Category
Key | Type | Mandatory | Comment |
---|---|---|---|
cat_id | int | Yes | Category id |
name | string | Yes | Category name |
count | int | Yes | Blogs count in this category |
parent | int | Yes | Parent id of this category |
child | array | Depends | Sub categories list of this one. It's an array of Category data object. Returned for category request only |
Tag
Key | Type | Mandatory | Comment |
---|---|---|---|
tag_id | int | Yes | Tag id |
name | string | Yes | Tag name |
count | int | Yes | Blogs count in this tag |
parent | int | Yes | Parent id of this tag |
Blog_Preview
Key | Type | Mandatory | Comment |
---|---|---|---|
blog_id | int | Yes | Blog id |
title | string | Yes | Blog title |
timestamp | int | Yes | Blog post timestamp |
author | hash | Yes | User data object of blog author |
preview | string | Yes | Preview of the blog content |
preview_image | string | No | First image url in the blog if it has |
status | string | No | Blog status. Optional value: 'publish', 'private', 'pending', 'draft' |
password | boolean | No | Return true to indicate the blog was password protected |
comment_count | int | No | Comment count of this blog |
category | array | No | Array of Category data object |
tag | array | No | Array of Tag data object |
type | string | No | Blog type, 'post' or 'link' for now, default is 'post' |
link | string | No | External link to the real content, only when type is 'link' |
Blog_Full
Key | Type | Mandatory | Comment |
---|---|---|---|
blog_id | int | Yes | Blog id |
title | string | Yes | Blog title |
timestamp | int | Yes | Blog post timestamp |
content | string | Yes | Blog content |
author | hash | Yes | User data object of blog author |
status | string | No | Blog status. Optional value: 'publish', 'private', 'pending', 'draft' |
password | boolean | No | Return true to indicate the blog was password protected |
comment_count | int | No | Comment count of this blog |
category | array | No | Array of Category data object |
tag | array | No | Array of Tag data object |
prev | int | No | Previous Blog id |
prev_title | string | No | Previous Blog title |
next | int | No | Next Blog id |
next_title | string | No | Next Blog title |
type | string | No | Blog type, 'post' or 'link' for now, default is 'post' |
link | string | No | External link to the real content, only when type is 'link' |
Comment
Key | Type | Mandatory | Comment |
---|---|---|---|
comment_id | int | Yes | Comment ID |
timestamp | int | Yes | Comment post timestamp |
content | string | Yes | Comment content |
author | hash | Yes | User data object of comment author |
parent | int | No | Parent(Comment it replied to) ID of the comment |
status | string | No | Comment status. Optional value: 'approve', 'hold', 'spam', 'trash' |
child | array | No | Comments reply to this comment. Array of Comment data object. Only for nested comments mode |