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 .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 /Section/GetSectionStatus HTTP/1.1 
Host: 122.112.255.199 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetSectionStatusRequest 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>
  <SecitonId>0</SecitonId>
  <SectionCode>String</SectionCode>
</GetSectionStatusRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetSectionStatusResponse 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>
    <AreaName>String</AreaName>
    <AvgDimmingValue>0</AvgDimmingValue>
    <DimmingValue>0</DimmingValue>
    <LastDimmingTime>0001-01-01T00:00:00</LastDimmingTime>
    <LastDimmingValue>0</LastDimmingValue>
    <LastQueryTime>0001-01-01T00:00:00</LastQueryTime>
    <LightCount>0</LightCount>
    <LineName>String</LineName>
    <MaxDimmingValue>0</MaxDimmingValue>
    <MinDimmingValue>0</MinDimmingValue>
    <OrgName>String</OrgName>
    <SectionCode>String</SectionCode>
    <SectionId>0</SectionId>
    <SectionName>String</SectionName>
    <Total>0</Total>
  </Data>
</GetSectionStatusResponse>