GET HwStructure/getC4HwStructure?C4Identification={C4Identification}&Token={Token}

Retrieve all sensor and relay structure assigned to C4 system connection. Application privilege "View" for licensed agenda "Physical HW structure" required.

Request Information

Authorization

Authorization by token required

Availability

Method can be used

URI Parameters

Name	Description	Type	Additional information
C4Identification	C4 identification. It is used to identify the C4 system in the system Aktion.	string	Required
Token	The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds	globally unique identifier	Required

Body Parameters

None.

Request Formats

application/json

Sample:

{"C4Identification":"C4 main instalation","Token":null}

application/xml

Sample:


<UriParametersGetC4HwStructure>
  <C4Identification>C4 main instalation</C4Identification>
  <Token d2p1:nil="true" xmlns:d2p1="http://www.w3.org/2001/XMLSchema-instance" />
</UriParametersGetC4HwStructure>

Response Information

Response Codes

Http Code	Error Number	Description
200 request succesfully done	0	Successfully done
400 bad request	1002	Entry parameter missing or parameter bindigs failed
401 unauthorized	1000	Token {0} not found
401 unauthorized	1001	Token {0} already expired
401 unauthorized	1006	Ip filter violated for ip client address [{0}]
401 unauthorized	1007	Ip filter [{0}] parsing failed
401 unauthorized	1008	Request rate policy violated for [{0}]
403 server refuses fo fulfill the request	1227	Show hw structure physical privilege violated
404 required resource does not exist on the server	1228	Hw structure physical not found
415 unsupported Media Type		The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported
500 internal error		Server exception description

Resource Description

HwStructGetC4HwStructResp

Name	Description	Type	Additional information
C4HwStruct		Collection of C4HwStructure	None.

Response Formats

application/json

Sample:

{"C4HwStruct":[{"ID":"fe7e0867-051e-4723-8fea-25e76bd7e583","IDParent":null,"Type":"DM","Title":"eBox","APType":null,"Active":true,"SRType":null,"CommonDoor":null,"FingerPrint":null,"DirectControl":null,"SensorIndex":null,"RelayIndex":null,"TimeLastChange":"\/Date(1757327731642)\/"},{"ID":"ee0b9f7f-737f-49f6-926d-64f93185a194","IDParent":"fe7e0867-051e-4723-8fea-25e76bd7e583","Type":"CL","Title":"ETH 192.168.1.24:80","APType":null,"Active":true,"SRType":null,"CommonDoor":null,"FingerPrint":null,"DirectControl":null,"SensorIndex":null,"RelayIndex":null,"TimeLastChange":"\/Date(1757327731642)\/"},{"ID":"5e242070-bd36-44ab-a1fd-9ae7d4e66a2e","IDParent":"fe7e0867-051e-4723-8fea-25e76bd7e583","Type":"CL","Title":"ETH 192.168.1.25:80","APType":null,"Active":true,"SRType":null,"CommonDoor":null,"FingerPrint":null,"DirectControl":null,"SensorIndex":null,"RelayIndex":null,"TimeLastChange":"\/Date(1757327731642)\/"},{"ID":"8e4031f2-a6b6-4de8-bd27-2717315f7ba4","IDParent":"ee0b9f7f-737f-49f6-926d-64f93185a194","Type":"AP","Title":"eReader Office 22","APType":220,"Active":true,"SRType":null,"CommonDoor":false,"FingerPrint":null,"DirectControl":null,"SensorIndex":null,"RelayIndex":null,"TimeLastChange":"\/Date(1757327731642)\/"},{"ID":"febd54a7-80d3-4cfb-99f1-c428bbace1fa","IDParent":"5e242070-bd36-44ab-a1fd-9ae7d4e66a2e","Type":"AP","Title":"eSmartReader Main entry","APType":221,"Active":true,"SRType":null,"CommonDoor":true,"FingerPrint":null,"DirectControl":null,"SensorIndex":null,"RelayIndex":null,"TimeLastChange":"\/Date(1757327731642)\/"},{"ID":"eec5e091-7873-477e-92a0-e91ce877c580","IDParent":"8e4031f2-a6b6-4de8-bd27-2717315f7ba4","Type":"SR","Title":"Office 22","APType":220,"Active":true,"SRType":220,"CommonDoor":false,"FingerPrint":false,"DirectControl":true,"SensorIndex":0,"RelayIndex":null,"TimeLastChange":"\/Date(1757327731642)\/"},{"ID":"be4941bb-2615-4d99-92e5-8f8105acd2ea","IDParent":"febd54a7-80d3-4cfb-99f1-c428bbace1fa","Type":"SR","Title":"Main entry IN","APType":220,"Active":true,"SRType":220,"CommonDoor":true,"FingerPrint":true,"DirectControl":false,"SensorIndex":1,"RelayIndex":null,"TimeLastChange":"\/Date(1757327731642)\/"},{"ID":"5e1bd6b7-271e-48dd-8b03-814c15b79e66","IDParent":"febd54a7-80d3-4cfb-99f1-c428bbace1fa","Type":"SR","Title":"Main entry OUT","APType":221,"Active":true,"SRType":221,"CommonDoor":true,"FingerPrint":false,"DirectControl":true,"SensorIndex":0,"RelayIndex":null,"TimeLastChange":"\/Date(1757327731642)\/"}]}

application/xml

Sample:


<Response>
  <C4HwStructures>
    <C4HwStructure>
      <ID>fe7e0867-051e-4723-8fea-25e76bd7e583</ID>
      <IDParent d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <Type>DM</Type>
      <Title>eBox</Title>
      <APType d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <Active>true</Active>
      <SRType d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <CommonDoor d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <FingerPrint d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <DirectControl d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <SensorIndex d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <RelayIndex d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <TimeLastChange>2025-09-08T10:35:31.6421853Z</TimeLastChange>
    </C4HwStructure>
    <C4HwStructure>
      <ID>ee0b9f7f-737f-49f6-926d-64f93185a194</ID>
      <IDParent>fe7e0867-051e-4723-8fea-25e76bd7e583</IDParent>
      <Type>CL</Type>
      <Title>ETH 192.168.1.24:80</Title>
      <APType d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <Active>true</Active>
      <SRType d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <CommonDoor d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <FingerPrint d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <DirectControl d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <SensorIndex d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <RelayIndex d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <TimeLastChange>2025-09-08T10:35:31.6421853Z</TimeLastChange>
    </C4HwStructure>
    <C4HwStructure>
      <ID>5e242070-bd36-44ab-a1fd-9ae7d4e66a2e</ID>
      <IDParent>fe7e0867-051e-4723-8fea-25e76bd7e583</IDParent>
      <Type>CL</Type>
      <Title>ETH 192.168.1.25:80</Title>
      <APType d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <Active>true</Active>
      <SRType d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <CommonDoor d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <FingerPrint d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <DirectControl d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <SensorIndex d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <RelayIndex d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <TimeLastChange>2025-09-08T10:35:31.6421853Z</TimeLastChange>
    </C4HwStructure>
    <C4HwStructure>
      <ID>8e4031f2-a6b6-4de8-bd27-2717315f7ba4</ID>
      <IDParent>ee0b9f7f-737f-49f6-926d-64f93185a194</IDParent>
      <Type>AP</Type>
      <Title>eReader Office 22</Title>
      <APType>220</APType>
      <Active>true</Active>
      <SRType d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <CommonDoor>false</CommonDoor>
      <FingerPrint d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <DirectControl d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <SensorIndex d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <RelayIndex d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <TimeLastChange>2025-09-08T10:35:31.6421853Z</TimeLastChange>
    </C4HwStructure>
    <C4HwStructure>
      <ID>febd54a7-80d3-4cfb-99f1-c428bbace1fa</ID>
      <IDParent>5e242070-bd36-44ab-a1fd-9ae7d4e66a2e</IDParent>
      <Type>AP</Type>
      <Title>eSmartReader Main entry</Title>
      <APType>221</APType>
      <Active>true</Active>
      <SRType d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <CommonDoor>true</CommonDoor>
      <FingerPrint d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <DirectControl d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <SensorIndex d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <RelayIndex d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <TimeLastChange>2025-09-08T10:35:31.6421853Z</TimeLastChange>
    </C4HwStructure>
    <C4HwStructure>
      <ID>eec5e091-7873-477e-92a0-e91ce877c580</ID>
      <IDParent>8e4031f2-a6b6-4de8-bd27-2717315f7ba4</IDParent>
      <Type>SR</Type>
      <Title>Office 22</Title>
      <APType>220</APType>
      <Active>true</Active>
      <SRType>220</SRType>
      <CommonDoor>false</CommonDoor>
      <FingerPrint>false</FingerPrint>
      <DirectControl>true</DirectControl>
      <SensorIndex>0</SensorIndex>
      <RelayIndex d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <TimeLastChange>2025-09-08T10:35:31.6421853Z</TimeLastChange>
    </C4HwStructure>
    <C4HwStructure>
      <ID>be4941bb-2615-4d99-92e5-8f8105acd2ea</ID>
      <IDParent>febd54a7-80d3-4cfb-99f1-c428bbace1fa</IDParent>
      <Type>SR</Type>
      <Title>Main entry IN</Title>
      <APType>220</APType>
      <Active>true</Active>
      <SRType>220</SRType>
      <CommonDoor>true</CommonDoor>
      <FingerPrint>true</FingerPrint>
      <DirectControl>false</DirectControl>
      <SensorIndex>1</SensorIndex>
      <RelayIndex d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <TimeLastChange>2025-09-08T10:35:31.6421853Z</TimeLastChange>
    </C4HwStructure>
    <C4HwStructure>
      <ID>5e1bd6b7-271e-48dd-8b03-814c15b79e66</ID>
      <IDParent>febd54a7-80d3-4cfb-99f1-c428bbace1fa</IDParent>
      <Type>SR</Type>
      <Title>Main entry OUT</Title>
      <APType>221</APType>
      <Active>true</Active>
      <SRType>221</SRType>
      <CommonDoor>true</CommonDoor>
      <FingerPrint>false</FingerPrint>
      <DirectControl>true</DirectControl>
      <SensorIndex>0</SensorIndex>
      <RelayIndex d4p1:nil="true" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance" />
      <TimeLastChange>2025-09-08T10:35:31.6421853Z</TimeLastChange>
    </C4HwStructure>
  </C4HwStructures>
</Response>