• Topics

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
0:Normal schedule

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, Type:
array|In: [mon,tue,wed,thu,fri,sat]
                "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 schedlue

{
    "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