泽元网站内容管理系统(ZCMS)V2.2 数据接口文档

作者:  最后修改:2014年01月26日  浏览数:741

 1 广告数据接口(AdvertiseDataProvider

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=advertise。

  参数password可通过系统后台配置项配置数据接口认证码指定。

  参数datatype指定不同的数据类型。

  接口参数:

参数名称

参数类型

必填

  说明

columns

String

自定义需要返回的数据字段,多个字段间逗号分隔。例如:ID、Name、Type、AddTime

SiteID

Long

广告所属站点ID

2 文章数据接口(article

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=article。

  接口参数:

支持的参数

参数类型

必填

说明

ID

Long

N

  文章内容ID

SiteID

Long

N

站点ID

catalogid

Long

N

栏目ID

level

String

N

栏目级别(子栏目:Child,当前栏目:Current,子栏目和当前栏目:CurrentAndChild)

type

String

N

排序类型(Recent:发布时间,Hot:点击量)

pagesize

Int

N

每一页显示数量

pageindex

Int

N

显示第几页

loadextend

Bollean

N

是否加载扩展内容

loaddetail

Bollean

N

是否加载文章详细内容

3 音频数据接口(audio

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=audio。

  接口参数:

支持的参数

参数类型

必填

说明

ID

Long

N

音频内容ID

SiteID

Long

N

站点ID

catalogid

Long

N

栏目ID

level

String

N

栏目级别(子栏目:Child,当前栏目:Current,子栏目和当前栏目:CurrentAndChild)

type

String

N

排序类型(Recent:发布时间,Hot:点击量)

pagesize

Int

N

每一页显示数量

 pageindex

Int

N

显示第几页

loadextend

Boolean

N

是否加载扩展内容

4 区块数据接口(block

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=block。

  接口参数:

支持的参数

参数类型

必填

说明

SiteID

Long

N

站点ID

columns

String

N

英文逗号分割的字段名称,指定此参数后只返回指定的字段数据。

catalogid

Long

N

栏目ID

5 栏目数据接口(catalog

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=catalog。

  接口参数:

支持的参数

参数类型

必填

说明

SiteID

Long

N

站点ID

columns

String

N

英文逗号分割的字段名称,指定此参数后只返回指定的字段数据。

6评论数据接口(comment

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=comment。

  接口参数:

支持的参数

参数类型

必填

说明

columns

String

N

英文逗号分割的字段名称,指定此参数后只返回指定的字段数据。

type

String

N

排序类型(Recent:发布时间,Hot:点击量)

contentid

Long

N

栏目ID

pagesize

Int

N

每一页显示数量

pageindex

Int

N

显示第几页

page

String

N

是否分页(“true”:分页,”false”:不分页)

7 内容类型数据接口(contenttype

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=contenttype。

  接口参数:

支持的参数

参数类型

必填

说明

  不需要支持参数

8 文件内容数据接口(file

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=file。

  接口参数:

支持的参数

参数类型

必填

说明

id

Long

N

文件内容ID

SiteID

Long

N

站点ID

catalogid

Long

N

栏目ID

level

String

N

栏目级别(子栏目:Child,当前栏目:Current,子栏目和当前栏目:CurrentAndChild)

type

String

N

排序类型(Recent:发布时间,Hot:点击量)

pagesize

Int

N

每一页显示数量

pageindex

Int

N

显示第几页

loadextend

Boolean

N

是否加载扩展内容

9 友情链接数据接口(friendlink

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=friendlink。

  接口参数:

支持的参数

参数类型

必填

说明

SiteID

Long

N

站点ID

columns

String

N

英文逗号分割的字段名称,指定此参数后只返回指定的字段数据。

10 图片集数据接口(imagegroup

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=imagegroup

  接口参数:

支持的参数

参数类型

必填

说明

id

Long

N

图片集内容ID

SiteID

Long

N

站点ID

catalogid

Long

N

栏目ID

level

String

N

栏目级别(子栏目:Child,当前栏目:Current,子栏目和当前栏目:CurrentAndChild)

type

String

N

排序类型(Recent:发布时间,Hot:点击量)

pagesize

Int

N

每一页显示数量

pageindex

Int

N

显示第几页

loadextend

Bollean

N

是否加载扩展内容

loaddetail

Bollean

N

是否加载图片集详细内容

11 图片播放器数据接口(imageplayer

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=imageplayer。

  接口参数:

支持的参数

参数类型

必填

说明

SiteID

Long

N

站点ID

columns

String

N

英文逗号分割的字段名称,指定此参数后只返回指定的字段数据。

CatalogID

Long

N

栏目ID

12 留言板数据接口(messageboard

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=messageboard。

  接口参数:

支持的参数

参数类型

必填

说明

SiteID

Long

N

站点ID

columns

String

N

英文逗号分割的字段名称,指定此参数后只返回指定的字段数据。

CatalogID

Long

N

栏目ID

13 多点登录数据接口(multiServer

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=multiServer。

  接口参数:

支持的参数

参数类型

必填

说明

columns

String

N

英文逗号分割的字段名称,指定此参数后只返回指定的字段数据。

14 站点板数据接口(site

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=site。

  接口参数:

支持的参数

参数类型

必填

说明

columns

String

N

英文逗号分割的字段名称,指定此参数后只返回指定的字段数据。

15 视频数据接口(video

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=video。

  接口参数:

支持的参数

参数类型

必填

说明

  Id

Long

N

视频内容ID

SiteID

Long

N

站点ID

catalogid

Long

N

栏目ID

level

String

N

栏目级别(子栏目:Child,当前栏目:Current,子栏目和当前栏目:CurrentAndChild)

type

String

N

排序类型(Recent:发布时间,Hot:点击量)

pagesize

Int

N

每一页显示数量

pageindex

Int

N

显示第几页

loadextend

Bollean

N

是否加载扩展内容

16 调查投票数据接口(vote

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=vote。

  接口参数:

支持的参数

参数类型

必填

说明

SiteID

Long

N

站点ID

columns

String

N

英文逗号分割的字段名称,指定此参数后只返回指定的字段数据。

CatalogID

Long

N

栏目ID

17 用户文章数据接口(userarticledata

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=userarticledata。

  接口参数:

支持的参数

参数类型

必填

说明

username

String

N

用户名称筛选条件,稿件创建人

statuscode

 

String

 

N

内容状态筛选条件,可选值有draft(初稿)、workflow(流转中)、audited(已审核,包括待发布和已发布的稿件)、rejected(驳回,对应重新编辑状态的稿件)、published(已发布,默认)

loadextend

Boolean

N

是否加载扩展数据,默认false

pageSize

Int

N

每页显示的文档数量,默认20

page

Int

N

当前页面,默认0

columns

String

N

英文逗号分割的字段名称,指定此参数后只返回指定的字段数据。

18 用户文章数量接口(userarticlecount

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=userarticlecount。

  接口参数:

支持的参数

参数类型

必填

说明

username

String

N

用户名称筛选条件,稿件创建人

statuscode

String

N

内容状态筛选条件,可选值有draft(初稿)、workflow(流转中)、audited(已审核,包括待发布和已发布的稿件)、rejected(驳回,对应重新编辑状态的稿件)、published(已发布,默认)

19 文章详细信息接口(articleinfo

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=articleinfo。

  接口参数:

支持的参数

参数类型

必填

说明

id

Long

Y

文章唯一ID

columns

String

N

英文逗号分割的字段名称,指定此参数后只返回指定的字段数据

20 发稿接口(addarticle

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=addarticle。

  接口参数:

支持的参数

参数类型

必填

说明

title

String

Y

文章标题

catalogid

Long

Y

所属栏目ID

summary

String

N

文章摘要

logofile

String

N

文章logo图地址

content

String

Y

文章内容

21 用户登录接口(userlogin

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=userlogin。

  接口参数:

支持的参数

参数类型

必填

说明

username

String

Y

用户名称

password

String

Y

用户密码

22 用户信息接口(userinfo

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=userinfo。

  接口参数:

支持的参数

参数类型

必填

说明

username

String

N

用户名称

columns

String

N

英文逗号分割的字段名称,指定此参数后只返回指定的字段数据。

23 修改用户密码接口(changepassword

  接口地址:http://localhost/zcms/api/dataservice/getdata?password=&datatype=changepassword。

  接口参数:

支持的参数

参数类型

必填

说明

username

String

N

用户名称,默认为当前登录用户名称

password

String

Y

修改后的新密码