• Topics

X-Sign OpenAPI

X-sign 2.0 / X-Sign OpenAPI / Documentation / APIs

Mda

2021 / 04 / 23

GET /mda/schedule/screen
get mda screenSetting

Request Parameter

column schema descript
column
company_id
schema
Required.
Type: integer
descript
company id
column

equipment_id_list

 

schema
Required.
Type: array
Max:50
descript
array of equipment id

curl -X GET "/mda/schedule/screen"
-H "Content-Type: application/json"
-H "Authorization: Bearer sdk308123903"
-d '{
    "company_id":3,
    "equipment_id_list": [3,55]
    }'



Response Code

General HTTP Status Code

Code Description
Code
200
Description
success
Code
4XX
Description
TODO



Response Code - 200



Created successfully.

Name Schema Description
Name
*data
Schema

Type: list of mda/schedule/screen model
Description

list of mda/schedule/screen model

null model if never set

{
    "data":{
        "3":{
            "equipment_id": 3,
            "enabled":1,
            "start_time":"05:00",
            "end_time":"15:00",
            "auto_reboot":1,
            "created_at": "2019-11-29 10:10:10",
            "updated_at": "2019-11-29 10:10:10"
        },
        "55":null,
    }
}

 
POST /mda/schedule/screen
set mda screenSetting

Request Parameter

column schema descript
column
company_id
schema

Required.
Type: integer
descript
company id
column
equipment_id_list
schema
Required.
Type: array|Max:50
descript
array of equipment_id
column
enabled
schema
Required.
Type: integer|In0,1
descript
enable mdaScreen schedule setting
0: disabled
1: enabled
column
start_time
schema
Required.
Type: string|Format: hh:mm
descript
start screen on
column
end_time
schema

Required.

Type: string|Format: hh:mm

descript
screen off
column
auto_reboot
schema
Required.
Type: integer|In0,1
descript

reboot before screen on
0: disabled
1: enabled

curl -X POST "/mda/schedule/screen"
-H "Content-Type: application/json"
-H "Authorization: Bearer sdk308123903"
-d '{
    "company_id":3,
    "equipment_id_list": [3,55],
    "enabled":1,
    "start_time": "05:00",
    "end_time": "15:00",
    "auto_reboot":1
}'



Response Code 

General HTTP Status Code

Code Description
Code
200
Description
Created successfully
Code
4XX
Description
TODO