Skip to content

Query Current Family

API Address:/v2/family/enduserapi/getCurrentFamily

Request Method:GET

Request Data Type:application/x-www-form-urlencoded

Response Data Type:*/*

API Description:Query current family

Request Parameters:

Parameter NameParameter DescriptionRequest TypeRequiredData TypeSchema
currentCoordinatesCurrent location coordinatesqueryfalsestring
fidFamily IDqueryfalsestring

Response Status:

Status CodeDescriptionSchema
200Successfully queried current familyRegistration code response data«Current Family»
5041No permission
5633Coordinate format error
5635Home mode not enabled

Response Parameters:

Parameter NameParameter DescriptionTypeSchema
codeResponse status codeinteger(int32)integer(int32)
dataResponse dataCurrent FamilyCurrent Family
  addTimeCreation timeinteger(int64)
  addTimeTsCreation timestampinteger(int64)
  familyCoordinatesFamily coordinatesstring
  familyLocationFamily addressstring
  familyNameFamily namestring
  fidFamily IDstring
  memberRoleFamily roleinteger(int32)
extMsgExtended messagestring
msgResponse messagestring

Response Example:

javascript
{
	"code": 0,
	"data": {
		"addTime": 0,
		"addTimeTs": 0,
		"familyCoordinates": "",
		"familyLocation": "",
		"familyName": "",
		"fid": "",
		"memberRole": 0
	},
	"extMsg": "",
	"msg": ""
}