- Topics
- Release Information
- X-Sign Quick guide
-
X-sign User manual
- Account (4)
- Licence (4)
-
Manager (15)
- Pairing the device with X-Sign Manager
- Creating the channel
- Scheduling the content by channel
- Scheduling the content by device
- Editing the device management structure
- Pushing Real-Time Message to your BenQ Smart Signage remotely
- Controlling the device remotely
- Updating device Player remotely
- Managing the calling system
- Creating an API table in X-Sign Manager
- Setting Verification
- Getting the system notification
- Updating device status immediately New
- Player report (proof-of-play) New
- Using Designer Express New
-
Designer (18)
- Creating a new project file in X-Sign Designer
- Uploading your content from Designer
- Creating content in X-Sign Designer
- Creating content from Designed Templates
- Creating a clock widget in X-Sign Designer
- Setting a weather widget
- Creating an Image or Video slideshow
- Rotating an image or video
- Generating a QR Code
- Adding a data connection
- Setting a timer widget
- Creating an API template using the demo kit
- Creating a TV Input source widget in X-Sign Designer
- Setting background music in X-Sign Designer
- Changing the playing order of pages
- Sealing a file in X-Sign Designer
- Opening an X-Sign 1.x project file
- Changing your language in X-Sign Designer
- Player (6)
- Local Delivery (3)
- Report (2)
- Video Wall (3)
- Interactive (Premium) (6)
- API (Premium) (1)
- GPL/LGPL Software Licenses Used by X-Sign
- X-Sign OpenAPI
X-Sign OpenAPI
X-sign 2.0 / X-Sign OpenAPI / Documentation / APIs
Schedule
2021 / 04 / 22
POST /schedule/update
update schedule by schedule_head_id
Request Parameter
| column | schema | descript |
column company_id | schema Required. Type: integer | descript company id |
column schedule_head_id | schema Required. Type: integer|Min: 1 | descript schedule_head_id |
column name | schema Required. Type: string|Between:1,30 | descript schedule name |
column schedule_type | schema Required. Type: integer|In:0,1 | descript type 1:Top schedule |
column play_id | schema Optional. Type: string | descript play_id, id from Model-archive No change without passing this parameter |
column all_day | schema Required. Type: integer|In:0,1 | descript 0: not all day 1:all day |
column open_loop | schema Required. Type: integer|In:0,1 | descript 0: single event 1:repeat |
column finity | schema Required. Type: integer|In:0,1 | descript 0: infinity 1:finity |
column open_date | schema Required. 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|In:day|week | descript |
column cycle_interval | schema Required_if.open_loop=1 Type: integer|Min:1 | descript |
column week | schema Required_if.cycle=week Type: array|In: [mon,tue,wed,thu,fri,sat] | descript |
curl -X POST "/equipment/schedule"
-H "Content-Type: application/json"
-H "Authorization: Bearer sdk308123903"
-d '{
"company_id":3, "schedule_head_id":1232,
"name":"scheduleName",
"schedule_type":1,
"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"]
}'
Response Code
General HTTP Status Code
| Code | Description |
Code 200 | Description Success |
Code 4XX | Description TODO |
Response Value - 200
| Name | Schema | Description |
Name *data | Schema Type: Model - schedule | Description updated schedule |
{
"data":{
"id":1232,
"company_id":3,
"group_id":null,
"equipment_id":2,
"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"
}
}
DELETE /schedule
delete schedule by schedule_head_id
Request Parameter
| Name | Schema | Description |
Name company_id | Schema Required. Type: integer | Description company id |
Name schedule_head_id | Schema Required. Type: integer|Min: 1 | Description schedule_head_id |
curl -X DELETE "/schedule"
-H "Content-Type: application/json"
-H "Authorization: Bearer sdk308123903"
-d '{
"company_id":4,
"schedule_head_id":3
}'
Response Code
General HTTP Status Code
| Code | Description |
Code 200 | Description Delete successfully |
Code 4XX | Description TODO |