Family Management API

---

Get Family List

Request URL

POST /api/v1.0/invoke/open-ability/method/user-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object	Body	Yes	Command parameter

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	[]Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
account_id	String	Body	Account ID
residence_id	String	Body	Residence ID
family_name	String	Body	Family name
online	Boolean	Body	Whether the family is online or not? true: online false: offline
installed	Boolean	Body	Whether the family is installed or not? true: installed false: yet to be installed

Request Example

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_family_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {}
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "account_id": "ar58fa9ac8b6a2401bba0828fab548850",
      "residence_id": "r8b5a73f8dd84abaa94dcs248be49b0db",
      "family_name": "my home",
      "online": true,
      "installed": true
    }
  ]
}

Failure Return Example

See Failure Return Example

---

Get Family Information

Request URL

POST /api/v1.0/invoke/open-ability/method/user-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
residence_id	String	Body	Yes	Residence ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
family_name	String	Body	Family name
online	Boolean	Body	Whether the family is online or not? true: online false: offline
installed	Boolean	Body	Whether the family is installed or not? true: installed false: yet to be installed
accounts	[]Object<account>	Body	Account information

account description

Parameter Name	Type	Location	Description
account_id	String	Body	Account ID
account_name	String	Body	Account name
first_name	String	Body	First name
last_name	String	Body	Last name
email	String	Body	Email
auth	String	Body	Account authorization admin: owner, the top administrator user: family administrator guest: family ordinary user

Request Example

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_family_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "family_name": "my home",
    "online": true,
    "installed": true,
    "accounts": [
      {
        "account_id": "ar58fa9ac8b6a2401bba0828fab548850",
        "account_name": "demo@akubela.com",
        "first_name": "tom",
        "last_name": "fly",
        "email": "demo@akubela.com",
        "auth": "user"
      }
    ]
  }
}

Failure Return Example

See Failure Return Example

---

Update Family Information

Request URL

POST /api/v1.0/invoke/open-ability/method/user-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
residence_id	String	Body	Yes	Residence ID
family_name	String	Body	Yes	Family name

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_family_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
    "family_name": "my home"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

---

Change Family Admin

Request URL

POST /api/v1.0/invoke/open-ability/method/user-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
residence_id	String	Body	Yes	Residence ID
account_id	String	Body	Yes	Account ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "change_family_admin",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
    "account_id": "ar31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

---

Invite Family Account

Request URL

POST /api/v1.0/invoke/open-ability/method/user-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
residence_id	String	Body	Yes	Residence ID
email	String	Body	Yes	Email
auth	String	Body	Yes	Account authorization user: family administrator guest: family ordinary user

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "invite_family_account",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
    "email": "demo@akubela.com",
    "auth": "user"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

---

Account Join Family

Request URL

POST /api/v1.0/invoke/open-ability/method/user-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
residence_id	String	Body	Yes	Residence ID
auth	String	Body	Yes	Account authorization user: family administrator guest: family ordinary user

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "account_join_family",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
    "auth": "user"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

---

Create Family Account

Request URL

POST /api/v1.0/invoke/open-ability/method/user-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
residence_id	String	Body	Yes	Residence ID
password	String	Body	No	Password
first_name	String	Body	Yes	First name
last_name	String	Body	Yes	Last name
email	String	Body	Yes	Email
auth	String	Body	Yes	Account authorization user: family administrator guest: family ordinary user

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
account_id	String	Body	Account ID

Request Example

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_family_account",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
    "auth": "guest",
    "first_name": "tom",
    "last_name": "fly",
    "email": "demo@akubela.com"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "account_id": "ar58fa9ac8b6a2401bba0828fab548850"
  }
}

Failure Return Example

See Failure Return Example

---

Update Family Account Authorization

Request URL

POST /api/v1.0/invoke/open-ability/method/user-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
account_id	String	Body	Yes	Account ID
residence_id	String	Body	Yes	Residence ID
auth	String	Body	Yes	Account authorization user: family administrator guest: family ordinary user

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_family_account_auth",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "account_id": "ar58fa9ac8b6a2401bba0828fab548850",
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
    "auth": "guest"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

---

Batch Update Family Account Authorization

Request URL

POST /api/v1.0/invoke/open-ability/method/user-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
residence_id	String	Body	Yes	Residence ID
accounts	[]Object<account>	Body	Yes	Account information

account description

Parameter Name	Type	Location	Required	Description
account_id	String	Body	Yes	Account ID
auth	String	Body	Yes	Account authorization user: family administrator guest: family ordinary user

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "batch_update_family_account_auth",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
    "accounts": [
      {
        "account_id": "ar58fa9ac8b6a2401bba0828fab548850",
        "auth": "guest"
      }
    ]
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

---

Delete Family Account

Request URL

POST /api/v1.0/invoke/open-ability/method/user-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
account_id	String	Body	Yes	Account ID
residence_id	String	Body	Yes	Residence ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_family_account",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "account_id": "ar58fa9ac8b6a2401bba0828fab548850",
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

---

Batch Delete Family Account

Request URL

POST /api/v1.0/invoke/open-ability/method/user-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
residence_id	String	Body	Yes	Residence ID
accounts	[]Object<account>	Body	Yes	Account information

account description

Parameter Name	Type	Location	Required	Description
account_id	String	Body	Yes	Account ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "batch_delete_family_account",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
    "accounts": [
      {
        "account_id": "ar58fa9ac8b6a2401bba0828fab548850"
      }
    ]
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

---

Get Family Remote Connect

Request URL

POST /api/v1.0/invoke/open-ability/method/user-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
residence_id	String	Body	Yes	Residence ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
remote_connect_url	String	Body	Remote connect URL
online	Boolean	Body	Whether the family is online or not? true: online false: offline

Request Example

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_family_remote_connect",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r2c4b070cc928496198944858b344fc68"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724721898925,
  "result": {
    "remote_connect_url": "https://test.my.ecloud.akubela.com",
    "online": true
  }
}

Failure Return Example

See Failure Return Example