查询场景基础信息
优质
小牛编辑
138浏览
2023-12-01
接口说明
查询场景基础信息
如需调用,请访问 开发者文档 来查看详细的接口使用说明
该接口仅开放给已获取SDK的开发者
API地址
GET
/wish3dearth/api/scene/v1.0.0/getSceneInfo
是否需要登录
是
请求字段说明
参数 | 类型 | 请求类型 | 是否必须 | 说明 |
---|---|---|---|---|
token | string | header | 否 | 当前登录用户的TOKEN |
sceneId | string | query | 是 | 场景ID |
shareId | string | query | 否 | 场景分享ID |
响应字段说明
参数 | 类型 | 说明 |
---|---|---|
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": { "id": "c9ed81fab13417e4accb3f8bee6eeb65", "title": "我的场景", "keyWord": ",实景三维", "coverImg": "image/1759a4a3e71b45d7baed362e34b15039.jpg", "logoImg": null, "description": null, "viewCount": 0, "exampleId": null, "sceneStatus": "2", "viewPoint": "{\"viewImg\":\"\"}", "sceneScope": "1", "owner": "289baa7eb41a421c9014fb1a00c887de", "createBy": "289baa7eb41a421c9014fb1a00c887de", "createDate": "2019-12-12 11:32:59", "updateBy": "289baa7eb41a421c9014fb1a00c887de", "updateDate": "2019-12-12 11:32:59", "remarks": null, "delFlag": "1", "createByName": null, "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已失效,请重新登录 |
14006 | 时间区间格式错误 |
14056 | 场景ID不能为空 |
14057 | 场景为空 |
14064 | 场景没有访问权限 |
99998 | 非法请求 |
99999 | 服务器异常 |
示例代码
$.ajax({ url: '/wish3dearth/api/scene/v1.0.0/getSceneInfo?token=&sceneId=&shareId=', type: 'GET', data: '', dataType: 'text', cache: false, contentType: 'application/json', xhrFields: { withCredentials: true }, crossDomain: true, success:function(data){ // 成功返回值 }, error:function(XMLHttpRequest, textStatus, errorThrown){ } })