SSHost

<back to all web services

GetSectionStatusRequest

Requires Authentication
Required role:ApiUser
The following routes are available for this service:
All Verbs/Section/GetSectionStatus
GetSectionStatusRequest Parameters:
NameParameterData TypeRequiredDescription
SecitonIdquerylongNo
SectionCodequerystringNo
IBaseRequest Parameters:
NameParameterData TypeRequiredDescription
CommandformstringNo
OptionsformRequestOptionsNo
RequestOptions Parameters:
NameParameterData TypeRequiredDescription
SendNoWaitformboolNo
RequestTimeoutformintNo
DebugformboolNo
GetSectionStatusResponse Parameters:
NameParameterData TypeRequiredDescription
DataformSectionStatusNo
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
SectionStatus Parameters:
NameParameterData TypeRequiredDescription
SectionIdformlongNo
SectionCodeformstringNo
SectionNameformstringNo
OrgNameformstringNo
LineNameformstringNo
AreaNameformstringNo
TotalformintNo
LightCountformintNo
DimmingValueformdouble?No
AvgDimmingValueformdouble?No
MinDimmingValueformdouble?No
MaxDimmingValueformdouble?No
LastDimmingValueformdouble?No
LastDimmingTimeformDateTime?No
LastQueryTimeformDateTime?No

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 /Section/GetSectionStatus HTTP/1.1 
Host: 188.68.237.94 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	SecitonId: 0,
	SectionCode: String,
	Command: String,
	Options: 
	{
		SendNoWait: False,
		RequestTimeout: 0,
		Debug: False
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	{
		SectionId: 0,
		SectionCode: String,
		SectionName: String,
		OrgName: String,
		LineName: String,
		AreaName: String,
		Total: 0,
		LightCount: 0,
		DimmingValue: 0,
		AvgDimmingValue: 0,
		MinDimmingValue: 0,
		MaxDimmingValue: 0,
		LastDimmingValue: 0,
		LastDimmingTime: "0001-01-01T00:00:00.0000000+01:00",
		LastQueryTime: "0001-01-01T00:00:00.0000000+01:00"
	},
	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
		}
	]
}