Version: V4.0

Customer Service API

Get Message List

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-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
project_id	String	Body	Yes	Project ID
page_size	Integer	Body	Yes	Page size
page_index	Integer	Body	Yes	Page index

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
message_id	String	Body	Message ID
message_title	String	Body	Message title
message_content	String	Body	Message content
message_mode	String	Body	Message mode, all or device or mobile
residences	[]Object<residence>	Body	Residence information

residence description

Parameter Name	Type	Location	Description
residence_id	String	Body	Residence ID

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_message_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1,
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "message_id": "mfa332e258aae1badbb27d31128f442d2",
      "message_title": "test",
      "message_content": "test",
      "message_mode": "user",
      "residences": [
        {
          "residence_id": "rafa332e258aae1badbb27d31128f442d"
        }
      ]
    }
  ]
}

Failure Return Example

See Failure Return Example

Get Message Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-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
project_id	String	Body	Yes	Project ID
message_id	String	Body	Yes	Message 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
message_title	String	Body	Message title
message_content	String	Body	Message content
message_mode	String	Body	Message mode, all or device or mobile
residences	[]Object<residence>	Body	Residence information

residence description

Parameter Name	Type	Location	Description
residence_id	String	Body	Residence ID

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_message_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "message_id": "mfa332e258aae1badbb27d31128f442d2"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "message_title": "test",
    "message_content": "test",
    "message_mode": "user",
    "residences": [
      {
        "residence_id": "rafa332e258aae1badbb27d31128f442d"
      }
    ]
  }
}

Failure Return Example

See Failure Return Example

Create Message Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-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
project_id	String	Body	Yes	Project ID
message_title	String	Body	Yes	Message title
message_content	String	Body	Yes	Message content
message_mode	String	Body	Yes	Message mode, all or device or mobile
residences	[]Object<residence>	Body	Yes	Residence information

residence 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
message_id	String	Body	Message ID

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_message_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "message_title": "test",
    "message_content": "test",
    "message_mode": "user",
    "residences": [
      {
        "residence_id": "rafa332e258aae1badbb27d31128f442d"
      }
    ]
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Delete Message Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-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
project_id	String	Body	Yes	Project ID
message_id	String	Body	Yes	Message 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/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_message_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "message_id": "m8b5a73f8dd84abaa94dcs248be49b0d1"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Get Announcement Type List

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-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
project_id	String	Body	Yes	Project ID
page_size	Integer	Body	Yes	Page size
page_index	Integer	Body	Yes	Page index

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
announcement_type_id	String	Body	Announcement type ID
announcement_type_name	String	Body	Announcement type name
created_time	String	Body	Created time, UTC

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_announcement_type_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1,
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "announcement_type_id": "afa332e258aae1badbb27d31128f442d2",
      "announcement_type_name": "test",
      "created_time": "2024-07-23 17:13:53"
    }
  ]
}

Failure Return Example

See Failure Return Example

Get Announcement Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-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
project_id	String	Body	Yes	Project ID
announcement_type_id	String	Body	Yes	Announcement type 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
announcement_type_name	String	Body	Announcement type name
created_time	String	Body	Created time, UTC

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_announcement_type_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "announcement_type_id": "afa332e258aae1badbb27d31128f442d2"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "announcement_type_name": "test",
    "created_time": "2024-07-23 17:13:53"
  }
}

Failure Return Example

See Failure Return Example

Create Announcement Type Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-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
project_id	String	Body	Yes	Project ID
announcement_type_name	String	Body	Yes	Announcement type 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<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
announcement_type_id	String	Body	Announcement type ID

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_announcement_type_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "announcement_type_name": "test"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Update Announcement Type Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-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
project_id	String	Body	Yes	Project ID
announcement_type_id	String	Body	Yes	Announcement type ID
announcement_type_name	String	Body	Yes	Announcement type 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/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_announcement_type_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "announcement_type_id": "abafa332e258aae1badbb27d31128f446",
    "announcement_type_name": "test"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Delete Announcement Type Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-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
project_id	String	Body	Yes	Project ID
announcement_type_id	String	Body	Yes	Announcement Type 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/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_announcement_type_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "announcement_type_id": "a8b5a73f8dd84abaa94dcs248be49b0d1"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Get Announcement List

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-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
project_id	String	Body	Yes	Project ID
page_size	Integer	Body	Yes	Page size
page_index	Integer	Body	Yes	Page index

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
announcement_id	String	Body	Announcement ID
announcement_type_id	String	Body	Announcement type ID
announcement_title	String	Body	Announcement title
is_published	Boolean	Body	Whether the announcement is published or not? true: published false: unpublished
buildings	[]Object<building>	Body	Building information
created_time	String	Body	Created time, UTC
published_time	String	Body	Published time, UTC

building description

Parameter Name	Type	Location	Description
building_id	String	Body	Building ID

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_announcement_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1,
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "announcement_id": "afa332e258aae1badbb27d31128f442d2",
      "announcement_type_id": "aga332e258aae1badbb27d31128f442d2",
      "announcement_title": "test",
      "is_published": true,
      "buildings": [
        {
          "building_id": "bafa332e258aae1badbb27d31128f442d"
        }
      ],
      "created_time": "2025-07-23 17:12:53",
      "published_time": "2025-07-30 17:12:53"
    }
  ]
}

Failure Return Example

See Failure Return Example

Get Announcement Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-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
project_id	String	Body	Yes	Project ID
announcement_id	String	Body	Yes	Announcement 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
announcement_type_id	String	Body	Announcement type ID
announcement_title	String	Body	Announcement title
announcement_content	String	Body	Announcement content
is_published	Boolean	Body	Whether the announcement is published or not? true: published false: unpublished
created_time	String	Body	Created time, UTC
published_time	String	Body	Published time, UTC
buildings	[]Object<building>	Body	Building information
residences	[]Object<residence>	Body	Residence information

building description

Parameter Name	Type	Location	Description
building_id	String	Body	Building ID

residence description

Parameter Name	Type	Location	Description
residence_id	String	Body	Residence ID

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_announcement_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "announcement_id": "afa332e258aae1badbb27d31128f442d2"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "announcement_type_id": "a8b5a73f8dd84abaa94dcs248be49b0d1",
    "announcement_title": "test",
    "announcement_content": "test",
    "is_published": true,
    "created_time": "2025-07-23 17:12:53",
    "published_time": "2025-07-30 17:12:53",
    "buildings": [
      {
        "building_id": "bafa332e258aae1badbb27d31128f442d"
      }
    ],
    "residences": []
  }
}

Failure Return Example

See Failure Return Example

Create Announcement Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-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
project_id	String	Body	Yes	Project ID
announcement_type_id	String	Body	Yes	Announcement type ID
announcement_title	String	Body	Yes	Announcement title
announcement_content	String	Body	Yes	Announcement content
buildings	[]Object<building>	Body	Yes	Building information
residences	[]Object<residence>	Body	Yes	Residence information

building description

Parameter Name	Type	Location	Required	Description
building_id	String	Body	Yes	Building ID

residence 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
announcement_id	String	Body	Announcement ID

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_announcement_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "announcement_type_id": "a8b5a73f8dd84abaa94dcs248be49b0d1",
    "announcement_title": "test",
    "announcement_content": "test",
    "buildings": [
      {
        "building_id": "bafa332e258aae1badbb27d31128f442d"
      }
    ],
    "residences": []
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Update Announcement Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-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
project_id	String	Body	Yes	Project ID
announcement_id	String	Body	Yes	Announcement ID
announcement_type_id	String	Body	Yes	Announcement type ID
announcement_title	String	Body	Yes	Announcement title
announcement_content	String	Body	Yes	Announcement content
buildings	[]Object<building>	Body	Yes	Building information
residences	[]Object<residence>	Body	Yes	Residence information

building description

Parameter Name	Type	Location	Required	Description
building_id	String	Body	Yes	Building ID

residence 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	Body	Return result

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_announcement_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "announcement_id": "abafa332e258aae1badbb27d31128f446",
    "announcement_type_id": "a8b5a73f8dd84abaa94dcs248be49b0d1",
    "announcement_title": "test",
    "announcement_content": "test",
    "buildings": [
      {
        "building_id": "bafa332e258aae1badbb27d31128f442d"
      }
    ],
    "residences": []
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Publish Announcement Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-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
project_id	String	Body	Yes	Project ID
announcement_id	String	Body	Yes	Announcement 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/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "publish_announcement_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "announcement_id": "a8b5a73f8dd84abaa94dcs248be49b0d1"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Delete Announcement Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-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
project_id	String	Body	Yes	Project ID
announcement_id	String	Body	Yes	Announcement 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/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_announcement_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "announcement_id": "a8b5a73f8dd84abaa94dcs248be49b0d1"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Get Message List​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

residence description​

Request Example​

Success Return Example​

Failure Return Example​

Get Message Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

residence description​

Request Example​

Success Return Example​

Failure Return Example​

Create Message Information​

Request URL​

Request Parameter​

param description​

residence description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Delete Message Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Get Announcement Type List​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Get Announcement Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Create Announcement Type Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Update Announcement Type Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Delete Announcement Type Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

Request Example​

Success Return Example​

Get Message List

Request URL

Request Parameter

param description

Return Parameter

result description

residence description

Request Example

Success Return Example

Failure Return Example

Get Message Information

Request URL

Request Parameter

param description

Return Parameter

result description

residence description

Request Example

Success Return Example

Failure Return Example

Create Message Information

Request URL

Request Parameter

param description

residence description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Delete Message Information

Request URL

Request Parameter

param description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Get Announcement Type List

Request URL

Request Parameter

param description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Get Announcement Information

Request URL

Request Parameter

param description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Create Announcement Type Information

Request URL

Request Parameter

param description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Update Announcement Type Information

Request URL

Request Parameter

param description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Delete Announcement Type Information

Request URL

Request Parameter

param description

Return Parameter

Request Example

Success Return Example