SSHost

<back to all web services

GetLightLevelsRequest

Requires Authentication
Required role:ApiUser
The following routes are available for this service:
All Verbs/Light/GetLightLevels
IBaseRequest Parameters:
NameParameterData TypeRequiredDescription
CommandformstringNo
OptionsformRequestOptionsNo
RequestOptions Parameters:
NameParameterData TypeRequiredDescription
SendNoWaitformboolNo
RequestTimeoutformintNo
DebugformboolNo
GetLightLevelsResponse Parameters:
NameParameterData TypeRequiredDescription
DataformLightLevelsNo
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
LightLevels Parameters:
NameParameterData TypeRequiredDescription
OrgListformList<Org>No
Org Parameters:
NameParameterData TypeRequiredDescription
OrgIdformlongNo
OrgNameformstringNo
AreaListformList<Area>No
Area Parameters:
NameParameterData TypeRequiredDescription
OrgIdformlongNo
AreaIdformlongNo
AreaNameformstringNo
LineListformList<Line>No
Line Parameters:
NameParameterData TypeRequiredDescription
OrgIdformlongNo
AreaIdformlongNo
LineIdformlongNo
LineNameformstringNo
SectionListformList<Section>No
Section Parameters:
NameParameterData TypeRequiredDescription
OrgIdformlongNo
AreaIdformlongNo
LineIdformlongNo
SectionIdformlongNo
SectionNameformstringNo

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

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

{
	Data: 
	{
		OrgList: 
		[
			{
				OrgId: 0,
				OrgName: String,
				AreaList: 
				[
					{
						OrgId: 0,
						AreaId: 0,
						AreaName: String,
						LineList: 
						[
							{
								OrgId: 0,
								AreaId: 0,
								LineId: 0,
								LineName: String,
								SectionList: 
								[
									{
										OrgId: 0,
										AreaId: 0,
										LineId: 0,
										SectionId: 0,
										SectionName: String
									}
								]
							}
						]
					}
				]
			}
		]
	},
	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
		}
	]
}