Organization Management

2023-07-13
No Rating

Requests

Obtain organization binding information

Topic: thing/product/{gateway_sn}/requests

Direction: up

Method: airport_bind_status

Data:

ColumnNameTypeconstraintDescription
devicesDevice object setarray{}
»[array_item]Elements in arraystruct{}{"size": "2"}
»»snDevice serial numbertext{}

Example:

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

Topic: thing/product/{gateway_sn}/requests_reply

Direction: down

Method: airport_bind_status

Data:

ColumnNameTypeconstraintDescription
bind_statusBinding informationarray{}
»[array_item]Elements in arraystruct{}{"size": "2"}
»»snDevice serial numbertext{}
»»is_device_bind_organizationWhether device is bound to organizationbool{"0":"No","1":"Yes"}
»»organization_idOrganization idtext{}
»»organization_nameOrganization nametext{}
»»device_callsignDevice name in organizationtext{}

Example:

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

Search for the organization information that device bound to

Topic: thing/product/{gateway_sn}/requests

Direction: up

Method: airport_organization_get

Data:

ColumnNameTypeconstraintDescription
device_binding_codeDevice binding numbertext{}
organization_idOrganization idtext{}

Example:

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

Topic: thing/product/{gateway_sn}/requests_reply

Direction: down

Method: airport_organization_get

Data:

ColumnNameTypeconstraintDescription
organization_nameOrganization nametext{}

Example:

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

Device bind to organization

Topic: thing/product/{gateway_sn}/requests

Direction: up

Method: airport_organization_bind

Data:

ColumnNameTypeconstraintDescription
bind_devicesbinding parameter listarray{}
»[array_item]Elements in arraystruct{}{"size": "2"}
»»device_binding_codeDevice binding numbertext{}
»»organization_idOrganization idtext{}
»»device_callsignDevice name in organizationtext{}
»»snDevice serial numbertext{}
»»device_model_keyProduct enumeration valuetext{}Please refer to Product Supportedopen in new window

Example:

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

Topic: thing/product/{gateway_sn}/requests_reply

Direction: down

Method: airport_organization_bind

Data:

ColumnNameTypeconstraintDescription
err_infoserror informationarray{}
»[array_item]Elements in arraystruct{}{"size": "2"}
»»snDevice serial numbertext{}
»»err_codeerror codeint{}Custom field. Non-zero indicates that the bind was unsuccessful.

Example:

{
	"method": "airport_organization_bind",
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp:": 1654070968655,
	"data": {
		"result": 0,
		"output": {
			"err_infos": [
				{
					"sn": "dock-sn",
					"err_code": 210231
				},
				{
					"sn": "drone-sn",
					"err_code": 210231
				}
			]
		}
	}
}
If you have any comments or confusion about our documentation, you can click here to give feedback and we will get back to you as soon as possible.