APIUSB / 平台接口 / 获取公告

获取公告

接口描述: 获取当前公告

HTTP/HTTPS
请求协议
GET/POST
请求方式
UTF-8
编码格式
JSON
返回格式

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.items数组公告列表
data.items[].id整型公告的ID号
data.items[].notice_content字符串公告内容
data.items[].notice_url字符串公告跳转链接
data.items[].notice_start_time字符串公告开始时间
data.items[].notice_end_time字符串公告结束时间
data.items[].notice_publisher字符串公告发布人
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选

客户端请求示例

# 暂无示例,可添加示例文件:./src/view/docs/demos/Platform.Notice.GetNoticeNow.json

错误列表

错误状态码错误描述信息
400ret=400,客户端参数错误或非法请求
404表示接口服务不存在
406ret=406,access_token令牌校验不通过
407ret=407,app_key权限不足,或未知应用
408ret=408,当前用户禁止使用,或用户未登录
500表示服务端内部错误

本文档生成时间:2024-03-28 20:26:05