Get presentation list

1. API Description

This API is used to get the presentation list

Request mode:

  • V2.6.0 and above: POST [ip]/mwapi/V2.0/presentation/get-presentations-list
  • V2.5.0 and below: POST [ip]/mwapi/get-presentations-list
Administrator Rights Logged-in
No Yes

2. Input Parameters

None

3. Output Parameters

Name Type Description
result Int Status code
message String Status description
showList Array of ShowData Presentation list
ShowData
Name Type Description
configFilePath String Configuration file path
currentScene Int Current scene ID, that is the scene which will display automatically when switching to this presentation
id Int Presentation ID
name String Presentation name
isCurrent Int Whether it is current presentation
0: No; 1: Yes
sceneList SceneListData Scene list contained in the presentation

4. Example

Obtaining the presentation list.

Input Example
None
Output Example
{
    "message": "success",
    "result": 0,
    "showList": [
        {
            "configFilePath": "scenes.json",
            "currentScene": 0,
            "id": 7,
            "isCurrent": 0,
            "name": "New Presentation 1",
            "sceneList": [ … ]
        }
    ]
}

5. Error Code

No error code related to the API business logic. For other error codes, see Common Error Codes.

results matching ""

    No results matching ""