COEX-EN
  1. Schedule
COEX-EN
  • Contents
    • API Instructions
    • Error Code
    • General
      • Retrieve Screen Information
      • Set Screen Brightness
      • Set Screen Gamma
      • Set Blackout/Freeze Screen
      • Retrieve Preset Information
      • Apply Preset
      • Retrieve All Cabinet Information
      • Enable Cabinet Mapping
      • Retrieve Input Source List
      • Switch Source for Layer
      • Set EDID
      • Set Screen Color Temperature
    • Input
      • Retrieve Input Information
        • Retrieve Input Data
        • Retrieve Input Source List
      • EDID
        • Set EDID
      • Color Adjustment
        • Set Saturation
        • Set Color Highlight
        • Set Color Shadow
        • Adjust Hue
        • Reset Color Adjustment
      • Internal Source
        • Set Sending Card Test Pattern
      • Set HDR Mode
        • Set HDR Mode
    • Screen
      • Image booster
        • Color Gamut
          • Set Custom Gamut on a Screen-Basis
          • Switch Color Gamut
        • Retrieve Screen Display Effect Parameters
        • Set Screen Color Temperature
        • Set Custom Gamma for the Screen
        • Set Screen Brightness
        • Set Screen Gamma
      • Layer
        • Switch Source for Layer
      • Processing
        • 3D LUT
          • Delete 3D LUT File
          • Import 3D LUT File
          • Set 3D LUT Strength
          • Enable 3D LUT
      • Canvas
        • Canvas Mapping
      • Preset
        • Modify Preset
        • Retrieve Preset Information
        • Apply Preset
      • Schedule
        • Retrieve All Schedule Information of the Screens
          GET
        • Set Schedule On\Off
          POST
        • Delete Brightness Schedule
          POST
      • Output
        • 3D function
          • 3D Emitter
            • Enable 3D Emitter
          • Enable/Disable 3D
        • Retrieve Output Parameters
          • Retrieve Screen Output Data
        • Display mode
          • Set Blackout/Freeze Screen
        • Multi-Mode
          • Set Multi-mode by Screens
        • 3D
          • 3D Emitter
        • Display Mode
        • Retrieve Display Status
        • Set Output Bit Depth
      • Image Booster
        • Color Gamut
      • Retrieve Screen Properties Information
        GET
      • Retrieve the Number of Cabinets of the Screen
        GET
      • Retrieve Screen Information
        GET
    • Device
      • Device Identify
        • Device Identify
      • Monitoring
        • Retrieve Real-Time Monitoring Information
      • Set Blackout/Freeze Screen
    • Cabinet
      • Retrieve Cabinet Information
        • Retrieve All Cabinet Information
      • Brightness Adjustment
        • Set Cabinet RGB Brightness
        • Set Cabinet Brightness
      • Color Temperature Adjustment
        • Adjust Cabinet Color Temperature
      • Cabinet Control
        • Set Receiving Card Test Pattern
      • Cabinet Identify
        • Enable Cabinet Mapping
      • Multi-Mode
        • Set Multi-mode by Cabinets
      • Configure Cabinet Topology
        • Move Cabinet
  1. Schedule

Retrieve All Schedule Information of the Screens

GET
/api/v1/screen/schedule/all
TIP
Retrieve all schedule information of the screens

Request

Header Params
Content-Type
string 
required
Example:
application/json

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'http://127.0.0.1:8001/api/v1/screen/schedule/all' \
--header 'Content-Type: application/json'

Responses

🟢200Successful
application/json
Body
code
number 
optional
data
array [object {10}] 
optional
screenId
string 
Screen ID
optional
enable
boolean 
Schedule enabled or not
optional
brightnessMappingMode
number 
Brightness mapping mode
optional
0: specified brightness, 1: ambient brightness, 2: brightness when light sensor fails
relatedToMultiMode
boolean 
Whether to associate multi-mode
optional
brightnessMappingList
array [object {5}] 
Brightness mapping table
optional
brightnessStrategyList
array [object {10}] 
Brightness policy
optional
presetStrategyList
array [object {8}] 
Preset policy
optional
powerStrategyList
array[string]
Power supply policy
optional
peripheralList
array [object {3}] 
Multi-function card peripheral information configured for the screen
optional
powerInfoList
array[string]
Multi-function card power channel configured for this screen
optional
message
string 
optional
Example
{
    "code": 0,
    "data": [
        {
            "screenId": "string",
            "enable": true,
            "brightnessMappingMode": 0,
            "relatedToMultiMode": true,
            "brightnessMappingList": [
                {
                    "id": "string",
                    "ambientBrightness": 0,
                    "screenBrightnessRatio": 0,
                    "screenBrightnessNit": 0,
                    "modeName": "string"
                }
            ],
            "brightnessStrategyList": [
                {
                    "strategyId": "string",
                    "strategyType": 0,
                    "startTime": "string",
                    "endTime": "string",
                    "adjustType": 0,
                    "brightnessRatio": 0,
                    "brightnessNit": 0,
                    "repeatEnable": true,
                    "repeatList": [
                        0
                    ],
                    "repeatEndTime": "string"
                }
            ],
            "presetStrategyList": [
                {
                    "strategyId": "string",
                    "strategyType": 0,
                    "startTime": "string",
                    "presetNum": 0,
                    "presetName": "string",
                    "repeatEnable": true,
                    "repeatList": [
                        0
                    ],
                    "repeatEndTime": "string"
                }
            ],
            "powerStrategyList": [
                "string"
            ],
            "peripheralList": [
                {
                    "mfCardId": 0,
                    "peripheralIndex": 0,
                    "peripheralType": 0
                }
            ],
            "powerInfoList": [
                "string"
            ]
        }
    ],
    "message": "string"
}
Modified at 2024-07-09 11:01:54
Previous
Apply Preset
Next
Set Schedule On\Off
Built with