Skip to content

Set Device Information

API Address:/v2/family/enduserapi/setDeviceInfo

Request Method:PUT

Request Data Type:application/json

Response Data Type:*/*

API Description:Set device information

Request Example:

javascript
[
  {
    "deviceName": "",
    "dk": "",
    "fid": "",
    "isCommonUsed": true,
    "newFrid": "",
    "oldFrid": "",
    "pk": "",
    "shareCode": ""
  }
]

Request Parameters:

Parameter NameParameter DescriptionRequest TypeRequiredData TypeSchema
paramsparamsbodytruearrayEdit Device Info Params
  deviceNameDevice namefalsestring
  dkDevice Keytruestring
  fidFamily ID, required when setting common device (can be filled or not when modifying family device name, recommended to fill to speed up interface access)falsestring
  isCommonUsedWhether it's commonly used: true-commonly used, false-not commonly usedfalseboolean
  newFridRoom ID to move intofalsestring
  oldFridRoom ID to move out offalsestring
  pkProduct Keytruestring
  shareCodeShare code, required when modifying the name of an accepted shared devicefalsestring

Response Status:

Status CodeDescriptionSchema
200Successfully set device informationRegistration code response data«SetDeviceInfoVO»
5041No permission
5635Home mode not enabled

Response Parameters:

Parameter NameParameter DescriptionTypeSchema
codeResponse status codeinteger(int32)integer(int32)
dataResponse dataSetDeviceInfoVOSetDeviceInfoVO
  failureListFailure listarrayobject
  successListSuccess listarrayobject
extMsgExtended messagestring
msgResponse messagestring

Response Example:

javascript
{
	"code": 0,
	"data": {
		"failureList": [],
		"successList": []
	},
	"extMsg": "",
	"msg": ""
}