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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<GetLightLevelsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LedServer.SS">
  <Command>String</Command>
  <Options>
    <Debug>false</Debug>
    <RequestTimeout>0</RequestTimeout>
    <SendNoWait>false</SendNoWait>
  </Options>
</GetLightLevelsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetLightLevelsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LedServer.SS">
  <Command>String</Command>
  <DeviceList xmlns:d2p1="http://schemas.datacontract.org/2004/07/LedServer.Models">
    <d2p1:DeviceData>
      <d2p1:ActionName>String</d2p1:ActionName>
      <d2p1:ActionResult>String</d2p1:ActionResult>
      <d2p1:ByteData>AA==</d2p1:ByteData>
      <d2p1:ByteResult>AA==</d2p1:ByteResult>
      <d2p1:ConnectStatus>0</d2p1:ConnectStatus>
      <d2p1:DeviceNumber>String</d2p1:DeviceNumber>
      <d2p1:ErrorMessage>String</d2p1:ErrorMessage>
    </d2p1:DeviceData>
  </DeviceList>
  <ErrList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </ErrList>
  <ErrorMessage>String</ErrorMessage>
  <Status>String</Status>
  <Data>
    <OrgList>
      <LightLevels.Org>
        <AreaList>
          <LightLevels.Area>
            <AreaId>0</AreaId>
            <AreaName>String</AreaName>
            <LineList>
              <LightLevels.Line>
                <AreaId>0</AreaId>
                <LineId>0</LineId>
                <LineName>String</LineName>
                <OrgId>0</OrgId>
                <SectionList>
                  <LightLevels.Section>
                    <AreaId>0</AreaId>
                    <LineId>0</LineId>
                    <OrgId>0</OrgId>
                    <SectionId>0</SectionId>
                    <SectionName>String</SectionName>
                  </LightLevels.Section>
                </SectionList>
              </LightLevels.Line>
            </LineList>
            <OrgId>0</OrgId>
          </LightLevels.Area>
        </AreaList>
        <OrgId>0</OrgId>
        <OrgName>String</OrgName>
      </LightLevels.Org>
    </OrgList>
  </Data>
</GetLightLevelsResponse>