SSHost

<back to all web services

GatewaySyncTimePlanRequest

Requires Authentication
Required role:ApiUser
The following routes are available for this service:
All Verbs/Gateway/SyncTimePlan
GatewaySyncTimePlanRequest Parameters:
NameParameterData TypeRequiredDescription
GatewayListqueryList<GatewayTimePlan>No
AddOneHourqueryintNo
IBaseRequest Parameters:
NameParameterData TypeRequiredDescription
CommandformstringNo
OptionsformRequestOptionsNo
RequestOptions Parameters:
NameParameterData TypeRequiredDescription
SendNoWaitformboolNo
RequestTimeoutformintNo
DebugformboolNo
GatewayTimePlan Parameters:
NameParameterData TypeRequiredDescription
GatewayIdformlongNo
ItemListformList<TimeDimming24H>No
AutoQuery_LightIdList_FromDatabaseformboolNo
PackDaysformintNo
TimeDimming24H Parameters:
NameParameterData TypeRequiredDescription
IndexformintNo
Scheme_IDformlongNo
SunRiseSet_IDformintNo
AstroDTformDateTimeNo
ServerDTformDateTimeNo
ItemCountformintNo
TimeStringformstringNo
MonthformintNo
DayformintNo
HourformintNo
MinuteformintNo
ModeformintNo
Param1formstringNo
Param2formstringNo
ErrorMessageformstringNo
IsHolidayformintNo
IsDayLightformintNo
AstroDateTimeStringformstringNo
ParamsStringformstringNo
IBaseResult Parameters:
NameParameterData TypeRequiredDescription
CommandformstringNo
StatusformstringNo
ErrorMessageformstringNo
ErrListformList<long>No
DeviceListformList<DeviceData>No
DeviceData Parameters:
NameParameterData TypeRequiredDescription
ActionNameformstringNo
DeviceNumberformstringNo
ActionResultformstringNo
ByteDataformbyte[]No
ByteResultformbyte[]No
ErrorMessageformstringNo
ConnectStatusformintNo
ByteDataHstrformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: 188.68.237.94 
Accept: text/jsv
Content-Type: text/jsv
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/jsv
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
		}
	]
}