Logo码如云文档中心

码如云官网 进入后台
新建实例(高级方式)

新建实例(高级方式) #

功能描述 #

通过高级方式新建一个实例。

调用方式 #

调用选项选项内容
HTTP方法POST
URL路径https://api.mryqr.com/integration/qrs/advanced-creation
正常返回状态码201

URL参数 #

无

请求体 #

{
    "name": "XXX设备",
    "groupId": "GRP377461113043920897",
    "customId": "0-1JgFOXRsW9wagvLE2gIw",
    "description": "This is the descrition.",
    "headerImageUrl": "https://an-image-server.com/7jbTR50q91/1t58KYbJwt/whatever.png",
    "directAttributeValues": {
        "a_elEqyvc7RlilugfeSYNWnw": "hello"
    },
    "geolocation": {
        "point": {
            "longitude": 111.696846,
            "latitude": 27.524004
        },
        "address": {
            "province": "河北省",
            "city": "张家口市",
            "district": "怀安县",
            "address": "详细地址"
        },
        "note": null
    }
}

请求体字段定义 #

字段解释必填备注
name实例名称是最长50个字符
groupId分组ID是
customId实例自定义编号否最长50个字符，应用范围内唯一
description实例简介，在实例首页中，简介将显示在实例名称的下方否最长50000个字符
directAttributeValues直接填入值类型的自定义属性值否key为自定义属性的ID，value为填入值
geolocationGeolocation类型的实例定位信息否

返回体 #

{
    "qrId": "QRC377459339302011904",
    "plateId": "MRY377459339302011905",
    "groupId": "GRP377459338282796033",
    "appId": "APP377459338270213120"
}

返回体字段定义 #

字段解释
qrId新创建的实例ID
plateId实例的码牌编号
groupId实例所在分组的ID
appId应用ID