保存场景
优质
小牛编辑
128浏览
2023-12-01
接口说明
保存场景
如需调用,请访问 开发者文档 来查看详细的接口使用说明
该接口仅开放给已获取SDK的开发者
API地址
POST
/wish3dearth/api/scene/v1.0.0/saveScene
是否需要登录
是
请求字段说明
参数 | 类型 | 请求类型 | 是否必须 | 说明 |
---|---|---|---|---|
token | string | header | 是 | 当前登录用户的TOKEN |
sceneId | string | formData | 是 | 场景ID |
dataJson | string | formData | 是 | 场景信息JSON |
saveType | string | formData | 是 | 保存方式(1:正式保存,2:临时保存,3:另存为) |
dataJson详细描述:
dataJson是由前端创建的一个对象,若是首次创建场景则通过new GUID().newGUID()生成场景ID
{ "basicInfo": { "sceneId": "String 场景ID", "title": "String 场景名称", "keyWord": "String 场景开屏弹框({type:\"类型0:文字 1:图片 2:视频\",content:\"路径或文字\"})", "coverImg": "String 场景封面路径", "logoImg": "String 场景LOGO路径", "description": "String 场景描述", "sceneStatus": "String 场景状态(1:公开,2:私有))", "viewPoint": "Object 场景默认视角基本信息" }, "scene": { "VERSION": "String js引擎版本号", "asset": { "version": "1.0.0", "date": "String 场景创建时间(yyyy-MM-dd hh:mm:ss)" }, "scene": { "properties": { "minimumDisableDepthTestDistance": 0, "shadows": true }, "layers": "Array 人工模型图层集合", "pageLODLayers": "Array 实景三维模型图层集合", "imageryLayers": "Array 影像或shp矢量数据图层(默认:谷歌全球影像、天地图全球影像、ArcGis全球影像)", "datasources": "Array 矢量图层集合", "terrainLayers": "Array 地形图层集合(默认:天地图中文道路标注)" } }, "fly": { "sceneId": "String 场景ID", "lines": "Array 飞行路线" }, "splitscreen": { "sceneId": "String 场景ID", "screens": "Array 分屏集合" }, "draw": { "type": "String 默认为FeatureCollection", "features": "Array 标绘点线面的集合" }, "monomer": { "type": "String 默认为FeatureCollection", "features": "Array 标绘单体化的集合" }, "push": { "type": "String 默认为FeatureCollection", "features": "Array 标绘压平的集合" }, "water": { "type": "String 默认为FeatureCollection", "features": "Array 标绘水面的集合" }, "clip": { "type": "String 默认为FeatureCollection", "features": "Array 标绘裁剪的集合" }, "drawDetail": { "sceneId": "String 场景ID", "points": "Array 标绘点的附属信息集合", "polylines": [], "polygons": [] }, "deleteObj": { "sceneId": "String 场景ID", "images": "Array 存放删除的图片路径集合", "videos": "Array 存放删除的视频路径集合", "drawDetails": "Array 存放删除的entity的id" } }
响应字段说明
无
响应成功示例
{ "code": 0, "message": "成功" }
响应失败示例
{ "code": 500, "message": "未知错误,请及时联系管理人员进行处理" }
响应接受类型
application/json
响应状态码
HTTP状态码 | 原因 |
---|---|
0 | 成功 |
200 | OK |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
10000 | token不能为空 |
10001 | token已失效,请重新登录 |
14004 | 获取团队信息失败 |
14005 | 获取用户ID列表失败 |
14006 | 时间区间格式错误 |
14019 | 获取上传限制和容量限制失败 |
14056 | 场景ID不能为空 |
14058 | 场景数据JSON为空 |
14061 | 场景保存方式为空 |
14065 | 场景超出最大容量限制 |
14066 | 没有场景保存权限 |
99998 | 非法请求 |
99999 | 服务器异常 |
示例代码
$.ajax({ url: '/wish3dearth/api/scene/v1.0.0/saveScene', type: 'POST', data: 'token=&sceneId=&dataJson=&saveType=', dataType: 'text', cache: false, contentType: 'application/json', xhrFields: { withCredentials: true }, crossDomain: true, success:function(data){ // 成功返回值 }, error:function(XMLHttpRequest, textStatus, errorThrown){ } })