查询公有场景(分页查询场景列表)

优质
小牛编辑
130浏览
2023-12-01

接口说明

查询公有场景(分页查询场景列表)
如需调用,请访问 开发者文档 来查看详细的接口使用说明
该接口仅开放给已获取SDK的开发者
如开启https功能,请求地址的协议应改为https,如:https://www.example.com/wish3dearth/api/access/v1.0.0/getLicenseInfo

API地址

GET /wish3dearth/api/scene/v1.0.0/publicScenePageList

是否需要登录

请求字段说明

参数类型请求类型是否必须说明
titlestringquery场景名称
userSeachTypestringquery用户查询关键字类型(1:用户名、2:手机:3:昵称)
userSeachDatastringquery用户查询关键字
dateBetwenstringquery查询场景创建时间区间(格式:yyyy-MM-dd HH:mm:ss ~ yyyy-MM-dd HH:mm:ss)
sidxstringquery排序字段名称(去驼峰模式中间用下划线隔开)
orderstringquery排序方式(asc或desc)
pagestringquery当前页(从1开始)
limitstringquery每页显示记录条数

响应字段说明

参数类型说明
idstring场景ID
titlestring场景名称
keyWordstring场景开场信息({type:"场景类型(0:文本,1:图片,2:视频)",content":"开场内容(文本 图片路径 视频路径)"})
coverImgstring封面图片
logoImgstringLOGO图片
descriptionstring场景描述
viewCount浏览次数
exampleIdstring示例场景ID
sceneStatusstring场景状态(1:公开,2:私有)
viewPointstring初始相机位置
sceneScopestring场景使用范围(默认为1)
ownerstring场景拥有者
createBystring场景创建者
createDatestring场景创建时间
createByNamestring场景创建者名称
updateBystring场景更新者
updateDatestring场景更新时间
remarksstring备注信息
delFlagstring删除标记
powersstring权限信息
teamNamestring团队名称
teamPaystring是否付费团队(默认为0)
shareNumbernumber分享次数
layerNumbernumber图层数量

响应成功示例

{
  "code": 0,
  "data": {
    "totalCount": 3,
    "pageSize": 12,
    "totalPage": 1,
    "currPage": 1,
    "list": [
      {
        "id": "e9f4306821341781d845384d76aced3b",
        "title": "开屏测试",
        "keyWord": "{\"type\":\"2\",\"content\":\"video/2459982636e04df1a349e62166464824.mp4\"}",
        "coverImg": "image/89218e5df19d4dcd8f57e88042b8eb7f.jpg",
        "logoImg": null,
        "description": null,
        "viewCount": 31,
        "exampleId": null,
        "sceneStatus": "1",
        "viewPoint": "{\"posx\":-1581736.6615264246,\"posy\":5323215.83114638,\"posz\":3131233.4545257683,\"directionx\":0.13466964974912524,\"directiony\":-0.5347721332875878,\"directionz\":-0.8341959307593694,\"viewImg\":\"image/8a3e7b1d71dd484bb60f95ad3031def0.jpg\",\"upx\":0.2809736752184753,\"upz\":0.5496849972411687,\"upy\":-0.786702102223071}",
        "sceneScope": "1",
        "owner": "20089f6d2eac48929c2cdc923afb6b56",
        "createBy": "20089f6d2eac48929c2cdc923afb6b56",
        "createDate": "2019-11-22 14:19:25",
        "updateBy": "20089f6d2eac48929c2cdc923afb6b56",
        "updateDate": "2019-11-22 14:19:25",
        "remarks": null,
        "delFlag": "0",
        "createByName": "test02",
        "powers": null,
        "teamName": null,
        "teamPay": "0",
        "shareNumber": 0,
        "layerNumber": 0
      }
    ]
  },
  "message": "成功"
}

响应失败示例

{
  "code": 500,
  "message": "未知错误,请及时联系管理人员进行处理"
}

响应接受类型

application/json

响应状态码

HTTP状态码原因
0成功
200OK
401Unauthorized
403Forbidden
404Not Found
10000token不能为空
10001token已失效,请重新登录
14004获取团队信息失败
14005获取用户ID列表失败
14006时间区间格式错误
99998非法请求
99999服务器异常

示例代码

$.ajax({

    url: '/wish3dearth/api/scene/v1.0.0/publicScenePageList?title=&userSeachType=&userSeachData=&dateBetwen=&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){

    

    }

})