分页查询公告可见范围
根据公告ID分页查询可见的企业/部门/用户列表
请求说明
请求地址 | https://openapi.wps.cn/v7/announce/announces/{announce_id}/visibilities |
---|---|
请求方法 | GET |
签名方式 | KSO-1 |
权限要求 | 查询公告(应用授权) kso.announce.read |
请求头(Header)
Header 名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
Content-Type | string | 是 | 使用:application/json |
X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
路径参数(Path)
名称 | 类型 | 是否必填 | 说明 |
---|---|---|---|
announce_id | string | 是 | <= 1024 characters,公告id |
查询参数(Query)
名称 | 类型 | 是否必填 | 说明 |
---|---|---|---|
page_size | int64 | 是 | 0 <= page <= 100, 分页大小 |
page_token | string | 否 | <= 1024 characters,分页token(第一次请求不传) |
with_total | bool | 否 | 是否返回总数 |
请求地址示例
[GET] https://openapi.wps.cn/v7/announce/announces/23367/visibilities?with_total=true&page_token=0&page_size=20
响应体(Response)
名称 | 类型 | 说明 |
---|---|---|
code | integer | code |
more | object | 更多的错误信息 |
msg | string | msg |
data | object | 信息返回 |
∟ items | object[] | 可见范围列表 |
∟∟ subject_id | string | 可见标识id(公司id/部门id/用户id) |
∟∟ subject_type | string | 可见类型(company=企业,dept=部门,user=用户) |
∟ next_page_token | string | 分页令牌(空字符串表示最后一页) |
∟ total | integer | 总记录数 |
响应体示例
json
{
"data": {
"items": [
{
"subject_id": "Xjj3Np4",
"subject_type": "company"
},
{
"subject_id": "Xjj3Pp4",
"subject_type": "dept"
},
{
"subject_id": "Xj33j4",
"subject_type": "user"
}
],
"next_page_token": "",
"total": 3
},
"code": 0,
"more": {},
"msg": "string"
}