Visit BenQ Education website for education solutions
  • Topics

X-Sign OpenAPI

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

Model-schedule

2021 / 04 / 24

column

schema

descript

column

*id

schema

Type: integer

descript

schedule_head_id

column

*name

schema

Type: string

descript

Between:1~30

column

*group_id             

schema

Type: integer|null

required_if: equipment_id=null

descript

channel id

column

*equipment_id      

schema

Type: integer|null
required_if: group_id=null

descript

equipment id

column

*schedule_type     

schema

Type: integer|In:0,1

descript

type

0:Normal schedule

1:Top schedule

column

*play_id

schema

Type: integer

descript

play_id, id from Model-archive

column

*all_day

schema

Type: integer|In:0,1

descript

0: not all day
1:all day

column

*open_loop                  

schema

Type: integer|In:0,1  

descript

0: single event
1: repeat

column

*finity           

schema

 Type: integer|In:0,1        

descript

0: infinity
1: finity

column

*open_date      

schema

Type: string

Format: yyyy-MM-dd

descript

 

column

open_time

schema

Required_if.all_day=0
Type: string
Format: hh:mm

descript

open_time

column

close_time

schema

Required_if.all_day=0

Type: string

Format: hh:mm

descript

close_time

column

close_date

schema

Required_if.finity=1

Type: string

Format: yyyy-MM-dd

descript

 

column

cycle

schema

Required_if.open_loop=1

Type: string
Value:day|week

descript

 

column

cycle_interval   

schema

Required_if.open_loop=1
Type: array|In:[mon,tue,wed,thu,fri,sat]

descript

 

column

*created_at           

schema

Type: timestamp    

descript

0000-00-00 00:00:00 (UTC)

column

*updated_at                                          

schema

  Type: timestamp       

descript

0000-00-00 00:00:00 (UTC)

{
    "id":2,
    "company_id":3,
    "group_id":1232,
    "equipment_id":null,
    "name":"scheduleName",
    "play_id":321,
    "all_day":1,
    "open_loop":1,
    "finity":1,
    "open_date":"2019-12-12",
    "close_date":"2019-12-30",
    "cycle":"week",
    "cycle_interval":2,
    "week":["mon","tue"],
    "created_at": "2019-11-29 10:10:10",
    "updated_at": "2019-11-29 10:10:10"
}