保存标注

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

接口说明

该接口已经废弃,请使用【单体化、标绘、压平 -> GEOJSON上传】接口
如果需要标识模型上某个位置信息,可以通过调用该接口,来记录标识的位置
可以设置的内容有名称、位置信息以及标注图标和字体颜色
如需调用,请访问 开发者文档 来查看详细的接口使用说明
该接口仅开放给已获取SDK的开发者

API地址

POST /api/marker/1.0.0/add

是否需要登录

请求字段说明

参数类型请求类型是否必须说明
sIdstringform场景ID
textstringform名称
xnumberform坐标位置x
ynumberform坐标位置y
znumberform坐标位置z
iconPathstringform标注图标
fontColorstringform字体颜色
posxnumberform相机位置,从camera.position中获取
posynumberform相机位置,从camera.position中获取
posznumberform相机位置,从camera.position中获取
directionxnumberform相机位置,从camera.direction中获取
directionynumberform相机位置,从camera.direction中获取
directionznumberform相机位置,从camera.direction中获取
upxnumberform相机位置,从camera.up中获取
upynumberform相机位置,从camera.up中获取
upznumberform相机位置,从camera.up中获取

响应字段说明

响应成功示例

{
  "code": 200,
  "data": {
    "markerGuid": "7bbf39cd-41e0-42cc-a324-8956cdcda59a",
    "viewpointGuid": "7bbf39cd-41e0-42cc-a324-8956cdcda59a"
  },
  "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/marker/1.0.0/add',
    type:'POST',
    data:'sId=&posx=&posy=&posz=&x=&y=&directionx=&z=&directiony=&text=&directionz=&iconPath=&upx=&fontColor=&upz=&upy=',
    dataType:'text',
    cache:false,
    contentType: "application/x-www-form-urlencoded",
	xhrFields: {
        withCredentials: true
    },
    crossDomain: true,
    success:function(data){
        // 成功返回值
    },
    error:function(XMLHttpRequest, textStatus, errorThrown){

    }
})