查询场景(分页查询场景列表,带有检测示例场景功能)
优质
小牛编辑
143浏览
2023-12-01
接口说明
查询场景(分页查询场景列表,带有检测示例场景功能)
如需调用,请访问 开发者文档 来查看详细的接口使用说明
该接口仅开放给已获取SDK的开发者
API地址
GET
/wish3dearth/api/scene/v1.0.0/pageList
是否需要登录
是
请求字段说明
参数 | 类型 | 请求类型 | 是否必须 | 说明 |
---|---|---|---|---|
token | string | header | 是 | 当前登录用户的TOKEN |
title | string | query | 否 | 场景名称 |
userSeachType | string | query | 否 | 用户查询关键字类型(1:用户名、2:手机:3:昵称) |
userSeachData | string | query | 否 | 用户查询关键字 |
dateBetwen | string | query | 否 | 查询场景创建时间区间(格式:yyyy-MM-dd HH:mm:ss ~ yyyy-MM-dd HH:mm:ss) |
sceneStatus | string | query | 否 | 场景状态(1:公开,2:私有) |
sidx | string | query | 否 | 排序字段名称(去驼峰模式中间用下划线隔开) |
order | string | query | 否 | 排序方式(asc或desc) |
page | string | query | 是 | 当前页(从1开始) |
limit | string | query | 是 | 每页显示记录条数 |
响应字段说明
参数 | 类型 | 说明 |
---|---|---|
id | string | 场景ID |
title | string | 场景名称 |
keyWord | string | 场景开场信息({type:"场景类型(0:文本,1:图片,2:视频)",content":"开场内容(文本 图片路径 视频路径)"}) |
coverImg | string | 封面图片 |
logoImg | string | LOGO图片 |
description | string | 场景描述 |
viewCount | 浏览次数 | |
exampleId | string | 示例场景ID |
sceneStatus | string | 场景状态(1:公开,2:私有) |
viewPoint | string | 初始相机位置 |
sceneScope | string | 场景使用范围(默认为1) |
owner | string | 场景拥有者 |
createBy | string | 场景创建者 |
createDate | string | 场景创建时间 |
createByName | string | 场景创建者名称 |
updateBy | string | 场景更新者 |
updateDate | string | 场景更新时间 |
remarks | string | 备注信息 |
delFlag | string | 删除标记 |
powers | string | 权限信息 |
teamName | string | 团队名称 |
teamPay | string | 是否付费团队(默认为0) |
shareNumber | number | 分享次数 |
layerNumber | number | 图层数量 |
响应成功示例
{ "code": 0, "data": { "totalCount": 3, "pageSize": 15, "totalPage": 1, "currPage": 1, "list": [ { "id": "91f0f1412134177d108359f5599fb87b", "title": "场景1", "keyWord": "{\"type\":0,\"content\":\"\"}", "coverImg": "image/8c06a342e0eb42028f901c391f4000c9.jpg", "logoImg": "image/09359234487e4cef9d71baa319f36437.jpg", "description": null, "viewCount": 11, "exampleId": null, "sceneStatus": "1", "viewPoint": "{\"viewImg\":\"\"}", "sceneScope": "1", "owner": "0254822cd3d841acbf6474f23b2d5f97", "createBy": "0254822cd3d841acbf6474f23b2d5f97", "createDate": "2019-11-25 17:32:10", "updateBy": "0254822cd3d841acbf6474f23b2d5f97", "updateDate": "2019-12-04 14:48:56", "remarks": null, "delFlag": "0", "createByName": "test01", "powers": null, "teamName": null, "teamPay": "0", "shareNumber": 0, "layerNumber": 0 } ] }, "message": "成功" }
响应失败示例
{ "code": 500, "message": "未知错误,请及时联系管理人员进行处理" }
响应接受类型
application/json
响应状态码
HTTP状态码 | 原因 |
---|---|
0 | 成功 |
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
10000 | token不能为空 |
10001 | token已失效,请重新登录 |
14004 | 获取团队信息失败 |
14005 | 获取用户ID列表失败 |
14006 | 时间区间格式错误 |
99998 | 非法请求 |
99999 | 服务器异常 |
示例代码
$.ajax({ url: '/wish3dearth/api/scene/v1.0.0/pageList?token=&title=&userSeachType=&userSeachData=&dateBetwen=&sceneStatus=&sidx=&order=&page=&limit=', type: 'GET', data: '', dataType: 'text', cache: false, contentType: 'application/json', xhrFields: { withCredentials: true }, crossDomain: true, success:function(data){ // 成功返回值 }, error:function(XMLHttpRequest, textStatus, errorThrown){ } })