查询关联场景

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

接口说明

为了让用户更清晰的比对场景中的数据,如历史数据对比、规划前后的数据对比等,Wish3DEarth团队新增了查询关联场景的接口,开发者可以通过该接口,来获取主屏与副屏之间的关联性。
如需调用,请访问 开发者文档 来查看详细的接口使用说明
该接口仅开放给已获取SDK的开发者

API地址

POST /api/contrasts/1.0.0/get

是否需要登录

请求字段说明

参数类型请求类型是否必须说明
sIdstringform场景ID

响应字段说明

参数类型说明
guidString双屏对比ID
sceneGuidString场景ID
contrastsSceneGuidString副屏ID
contrastsSceneTitleString副屏标题

响应成功示例

{
  "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状态码原因
204No Content
401Unauthorized
403Forbidden
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){

    }
})