查询关联场景
优质
小牛编辑
139浏览
2023-12-01
接口说明
为了让用户更清晰的比对场景中的数据,如历史数据对比、规划前后的数据对比等,Wish3DEarth团队新增了查询关联场景的接口,开发者可以通过该接口,来获取主屏与副屏之间的关联性。
如需调用,请访问 开发者文档 来查看详细的接口使用说明
该接口仅开放给已获取SDK的开发者
API地址
POST
/api/contrasts/1.0.0/get
是否需要登录
否
请求字段说明
参数 | 类型 | 请求类型 | 是否必须 | 说明 |
---|---|---|---|---|
sId | string | form | 是 | 场景ID |
响应字段说明
参数 | 类型 | 说明 |
---|---|---|
guid | String | 双屏对比ID |
sceneGuid | String | 场景ID |
contrastsSceneGuid | String | 副屏ID |
contrastsSceneTitle | String | 副屏标题 |
响应成功示例
{ "code": 200, "data": [ { "contrastsSceneGuid": "778919c0-86e0-4c6e-aa02-1c5ab2efb177/image.png", "sceneGuid": "c92f4c6d-8ba9-4e07-924b-de40eb629f00", "guid": "c92f4c6d-8ba9-4e07-924b-de40eb629f00", "contrastsSceneTitle": "标题" } ], "message": "OK" }
响应失败示例
{ "code": 500, "message": "未知错误,请及时联系管理人员进行处理" }
响应接受类型
application/json:charset=utf-8
响应状态码
HTTP状态码 | 原因 |
---|---|
204 | No Content |
401 | Unauthorized |
403 | Forbidden |
40001 | 查询结果为空 |
40001 | 查询结果不是JSON数据 |
40001 | 查询结果JSON不符合要求 |
40002 | 请求接口失败 |
40003 | 参数无效 |
40004 | 令牌无效 |
40004 | 令牌为空 |
示例代码
$.ajax({ url:'/api/contrasts/1.0.0/get', type:'POST', data:'sId=', dataType:'text', cache:false, contentType: "application/x-www-form-urlencoded", xhrFields: { withCredentials: true }, crossDomain: true, success:function(data){ // 成功返回值 }, error:function(XMLHttpRequest, textStatus, errorThrown){ } })