Required role: | ApiUser |
All Verbs | /Gateway/SyncTimePlan |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
GatewayList | query | List<GatewayTimePlan> | No | |
AddOneHour | query | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Command | form | string | No | |
Options | form | RequestOptions | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SendNoWait | form | bool | No | |
RequestTimeout | form | int | No | |
Debug | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
GatewayId | form | long | No | |
ItemList | form | List<TimeDimming24H> | No | |
AutoQuery_LightIdList_FromDatabase | form | bool | No | |
PackDays | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Index | form | int | No | |
Scheme_ID | form | long | No | |
SunRiseSet_ID | form | int | No | |
AstroDT | form | DateTime | No | |
ServerDT | form | DateTime | No | |
ItemCount | form | int | No | |
TimeString | form | string | No | |
Month | form | int | No | |
Day | form | int | No | |
Hour | form | int | No | |
Minute | form | int | No | |
Mode | form | int | No | |
Param1 | form | string | No | |
Param2 | form | string | No | |
ErrorMessage | form | string | No | |
IsHoliday | form | int | No | |
IsDayLight | form | int | No | |
AstroDateTimeString | form | string | No | |
ParamsString | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Command | form | string | No | |
Status | form | string | No | |
ErrorMessage | form | string | No | |
ErrList | form | List<long> | No | |
DeviceList | form | List<DeviceData> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ActionName | form | string | No | |
DeviceNumber | form | string | No | |
ActionResult | form | string | No | |
ByteData | form | byte[] | No | |
ByteResult | form | byte[] | No | |
ErrorMessage | form | string | No | |
ConnectStatus | form | int | No | |
ByteDataHstr | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Gateway/SyncTimePlan HTTP/1.1
Host: 122.112.255.199
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"GatewayList":[{"GatewayId":0,"ItemList":[{"Index":0,"Scheme_ID":0,"SunRiseSet_ID":0,"ItemCount":0,"TimeString":"String","Month":0,"Day":0,"Hour":0,"Minute":0,"Mode":0,"Param1":"String","Param2":"String","ErrorMessage":"String","IsHoliday":0,"IsDayLight":0,"AstroDateTimeString":"0001-00-00 00:00","ParamsString":"0, 0,String,DimmingValue = String"}],"AutoQuery_LightIdList_FromDatabase":false,"PackDays":0}],"AddOneHour":0,"Command":"String","Options":{"SendNoWait":false,"RequestTimeout":0,"Debug":false}}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"Command":"String","Status":"String","ErrorMessage":"String","ErrList":[0],"DeviceList":[{"ActionName":"String","DeviceNumber":"String","ActionResult":"String","ByteData":"AA==","ByteResult":"AA==","ErrorMessage":"String","ConnectStatus":0,"ByteDataHstr":"00"}]}