Skip to main content

Organization Management

Requests

Get device binding information

Topic: thing/product/{gateway_sn}/requests

Direction: up

Method: airport_bind_status

Data:

ColumnNameTypeconstraintDescription
devicesDevice object collectionarray{"size": 2, "item_type": struct}
»snDevice serial number (SN)text

Example:

{
"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"data": {
"devices": [
{
"sn": "drone-sn"
},
{
"sn": "dock-sn"
}
]
},
"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"timestamp": 1654070968655,
"method": "airport_bind_status"
}

Topic: thing/product/{gateway_sn}/requests_reply

Direction: down

Method: airport_bind_status

Data:

ColumnNameTypeconstraintDescription
resultReturn codeintNon-zero indicates an error
outputOutputstruct
»bind_statusBinding informationarray{"size": 2, "item_type": struct}
»»snDevice serial number (SN)text
»»is_device_bind_organizationWhether the device is bound to the organizationbool{"false":"No","true":"Yes"}
»»organization_idOrganization IDtext
»»organization_nameOrganization nametext
»»device_callsignDevice name in the organizationtext

Example:

{
"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"data": {
"output": {
"bind_status": [
{
"device_callsign": "Device organization callsign",
"is_device_bind_organization": true,
"organization_id": "12345678",
"organization_name": "12345",
"sn": "12345"
},
{
"device_callsign": "Device organization callsign",
"is_device_bind_organization": true,
"organization_id": "12345678",
"organization_name": "12345",
"sn": "12345"
}
]
},
"result": 0
},
"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"timestamp": 1654070968655,
"method": "airport_bind_status"
}

Query the organization information to which the device is bound

Topic: thing/product/{gateway_sn}/requests

Direction: up

Method: airport_organization_get

Data:

ColumnNameTypeconstraintDescription
device_binding_codeDevice binding codetext
organization_idOrganization IDtext

Example:

{
"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"data": {
"device_binding_code": "device_binding_code",
"organization_id": "organization_id"
},
"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"timestamp": 1654070968655,
"method": "airport_organization_get"
}

Topic: thing/product/{gateway_sn}/requests_reply

Direction: down

Method: airport_organization_get

Data:

ColumnNameTypeconstraintDescription
resultReturn codeintNon-zero indicates an error
outputOutputstruct
»organization_nameOrganization nametext

Example:

{
"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"data": {
"output": {
"organization_name": "organization_name"
},
"result": 0
},
"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"timestamp": 1654070968655,
"method": "airport_organization_get"
}

Bind device to organization

Topic: thing/product/{gateway_sn}/requests

Direction: up

Method: airport_organization_bind

Data:

ColumnNameTypeconstraintDescription
bind_devicesBinding parameter listarray{"size": 2, "item_type": struct}
»device_binding_codeDevice binding codetext
»organization_idOrganization IDtext
»device_callsignDevice name in the organizationtext
»snDevice serial number (SN)text
»device_model_keyProduct enumeration valuetextReference: Product Support

Example:

{
"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"data": {
"bind_devices": [
{
"device_binding_code": "device_binding_code",
"device_callsign": "dock-device-callsign",
"device_model_key": "3-1-0",
"organization_id": "organization_id",
"sn": "dock-sn"
},
{
"device_binding_code": "device_binding_code",
"device_callsign": "drone-device-callsign",
"device_model_key": "0-67-0",
"organization_id": "organization_id",
"sn": "drone-sn"
}
]
},
"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"timestamp": 1654070968655,
"method": "airport_organization_bind"
}

Topic: thing/product/{gateway_sn}/requests_reply

Direction: down

Method: airport_organization_bind

Data:

ColumnNameTypeconstraintDescription
resultReturn codeintNon-zero indicates an error
outputOutputstruct
»err_infosError informationarray{"size": 2, "item_type": struct}
»»snDevice serial number (SN)text
»»err_codeError codeint

Example:

{
"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"data": {
"output": {
"err_infos": [
{
"err_code": 210231,
"sn": "dock-sn"
},
{
"err_code": 210231,
"sn": "drone-sn"
}
]
},
"result": 0
},
"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"timestamp": 1654070968655,
"method": "airport_organization_bind"
}