Appearance
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 Name | Parameter Description | Request Type | Required | Data Type | Schema |
---|---|---|---|---|---|
currentCoordinates | Current location coordinates | query | false | string | |
fid | Family ID | query | false | string |
Response Status:
Status Code | Description | Schema |
---|---|---|
200 | Successfully queried current family | Registration code response data«Current Family» |
5041 | No permission | |
5633 | Coordinate format error | |
5635 | Home mode not enabled |
Response Parameters:
Parameter Name | Parameter Description | Type | Schema |
---|---|---|---|
code | Response status code | integer(int32) | integer(int32) |
data | Response data | Current Family | Current Family |
addTime | Creation time | integer(int64) | |
addTimeTs | Creation timestamp | integer(int64) | |
familyCoordinates | Family coordinates | string | |
familyLocation | Family address | string | |
familyName | Family name | string | |
fid | Family ID | string | |
memberRole | Family role | integer(int32) | |
extMsg | Extended message | string | |
msg | Response message | string |
Response Example:
javascript
{
"code": 0,
"data": {
"addTime": 0,
"addTimeTs": 0,
"familyCoordinates": "",
"familyLocation": "",
"familyName": "",
"fid": "",
"memberRole": 0
},
"extMsg": "",
"msg": ""
}