Skip to content

Latest commit

 

History

History
98 lines (70 loc) · 2.55 KB

segment_clean.md

File metadata and controls

98 lines (70 loc) · 2.55 KB

Segment Cleaning

Starts, stops and resumes the segment cleaning (= room cleaning).

Start Segment Cleaning

Command

Key Value Comment
method "app_segment_clean"
params [array of segments] List of segments (rooms) to clean, to get segments the command get_room_mapping can be used.
id id Random integer which is returned in the response used to link request and response.

Example

{
    "method": "app_segment_clean",
    "params": [16, 17, 18],
    "id": 6764
}

Response

Standard response to succeeded command.

Example

{
    "result": ["ok"],
    "id": 3453
}

Stop Segment Cleaning

Command

Key Value Comment
method "stop_segment_clean"
id id Random integer which is returned in the response used to link request and response.

Example

{
    "method": "stop_segment_clean",
    "id": 3453
}

Response

Standard response to succeeded command.

Example

{
    "result": ["ok"],
    "id": 3453
}

Resume Segment Cleaning

Command

Key Value Comment
method "resume_segment_clean"
id id Random integer which is returned in the response used to link request and response.

Example

{
    "method": "resume_segment_clean",
    "id": 342
}

Response

Standard response to succeeded command.

Example

{
    "result": ["ok"],
    "id": 342
}