GET api/v1/NetworkModules/{id}

Returns information for given network module

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Network module id	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

NetworkModule

Name	Description	Type	Additional information
AdapterNr	Adapter number	string	None.
AdapterVersion	Adapter version	string	None.
AllowedIP	Allowed IP	string	None.
AllowedSocketRequest	Allowed socket request mask	AllowedSocketRequestTypeMask	None.
BoardHotSpot	Board hot spot	integer	None.
BoardSettings	Board settings	string	None.
CalendarDataModifiedDate	Date when calendar data was modified	date (nullable)	None.
CalendarDataReceivedDate	Date when calendar data was received	date (nullable)	None.
CalendarDataState	Calendar data state	enuCalendarDataState	None.
Description	Description	string	None.
DeviceLimitCount	Device limit count	integer	None.
FProgKey_ID	Network module ID	globally unique identifier	None.
IPAddress	Network module's ip address	string	None.
IPAddressUserDefined	Network module's ip address if user has defined it.	string	None.
KeyId	Key id	string	None.
KeyProgPacketListReceivedDate	Programming packet list received date	date (nullable)	None.
LicenseMode	License mode	integer	None.
LocationPicture_ID	Location picture ID	globally unique identifier (nullable)	None.
LocationPointAttributes	Additional attributes if linked to location picture	string	None.
LocationPointX	Location point X coordinate if linked to location picture	decimal number	None.
LocationPointY	Location point Y coordinate if linked to location picture	decimal number	None.
OnlineConnectionDate	Connection date	date (nullable)	None.
OnlineKey	Key	globally unique identifier (nullable)	None.
OnlineMacAddress	Mac address	string	None.
OnlineSoftwareVersion	Software version	string	None.
Port	Network module's port	integer	None.
PortUserDefined	Network module's port if user has defined it.	integer (nullable)	None.
RealEstate_ID	Real estate id	globally unique identifier (nullable)	None.
RequestType	Request type	enuLockSocketRequestType	None.
RequestTypeInfo	Information related to request type, for example reboot time if reboot is requested	string	None.
State	State	pniProgrammingKeyState	None.
Type	Type	pniProgrammingKeyType	None.
Zone_ID	Zone id	globally unique identifier (nullable)	None.

Response Formats

application/json, text/json

Sample:

{
  "AdapterNr": "sample string 1",
  "AdapterVersion": "sample string 2",
  "AllowedIP": "sample string 3",
  "AllowedSocketRequest": 0,
  "BoardHotSpot": 4,
  "BoardSettings": "sample string 5",
  "CalendarDataModifiedDate": "2025-05-20T11:05:23.8730616+03:00",
  "CalendarDataReceivedDate": "2025-05-20T11:05:23.8730616+03:00",
  "CalendarDataState": 0,
  "Description": "sample string 6",
  "DeviceLimitCount": 7,
  "FProgKey_ID": "3341ec42-6282-41ce-a220-dc581ab2e40d",
  "IPAddress": "sample string 9",
  "IPAddressUserDefined": "sample string 10",
  "KeyId": "sample string 11",
  "KeyProgPacketListReceivedDate": "2025-05-20T11:05:23.8730616+03:00",
  "LicenseMode": 12,
  "LocationPicture_ID": "95c3f6c6-9370-4888-9089-deafc994ce6d",
  "LocationPointAttributes": "sample string 13",
  "LocationPointX": 14.1,
  "LocationPointY": 15.1,
  "OnlineConnectionDate": "2025-05-20T11:05:23.8730616+03:00",
  "OnlineKey": "c92fa35e-bcf1-4b49-9957-390cac14fca4",
  "OnlineMacAddress": "sample string 16",
  "OnlineSoftwareVersion": "sample string 17",
  "Port": 18,
  "PortUserDefined": 1,
  "RealEstate_ID": "3e45d1a8-63af-459e-ba0b-5ae74e43e432",
  "RequestType": 0,
  "RequestTypeInfo": "sample string 19",
  "State": 0,
  "Type": 0,
  "Zone_ID": "a7f90c4a-2489-48d7-acbe-c0635b75038f"
}

application/xml, text/xml

Sample:

<NetworkModule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iloq.manager.server.bus">
  <AdapterNr>sample string 1</AdapterNr>
  <AdapterVersion>sample string 2</AdapterVersion>
  <AllowedIP>sample string 3</AllowedIP>
  <AllowedSocketRequest>NotUse</AllowedSocketRequest>
  <BoardHotSpot>4</BoardHotSpot>
  <BoardSettings>sample string 5</BoardSettings>
  <CalendarDataModifiedDate>2025-05-20T11:05:23.8730616+03:00</CalendarDataModifiedDate>
  <CalendarDataReceivedDate>2025-05-20T11:05:23.8730616+03:00</CalendarDataReceivedDate>
  <CalendarDataState>eniPlanning</CalendarDataState>
  <Description>sample string 6</Description>
  <DeviceLimitCount>7</DeviceLimitCount>
  <FProgKey_ID>3341ec42-6282-41ce-a220-dc581ab2e40d</FProgKey_ID>
  <IPAddress>sample string 9</IPAddress>
  <IPAddressUserDefined>sample string 10</IPAddressUserDefined>
  <KeyId>sample string 11</KeyId>
  <KeyProgPacketListReceivedDate>2025-05-20T11:05:23.8730616+03:00</KeyProgPacketListReceivedDate>
  <LicenseMode>12</LicenseMode>
  <LocationPicture_ID>95c3f6c6-9370-4888-9089-deafc994ce6d</LocationPicture_ID>
  <LocationPointAttributes>sample string 13</LocationPointAttributes>
  <LocationPointX>14.1</LocationPointX>
  <LocationPointY>15.1</LocationPointY>
  <OnlineConnectionDate>2025-05-20T11:05:23.8730616+03:00</OnlineConnectionDate>
  <OnlineKey>c92fa35e-bcf1-4b49-9957-390cac14fca4</OnlineKey>
  <OnlineMacAddress>sample string 16</OnlineMacAddress>
  <OnlineSoftwareVersion>sample string 17</OnlineSoftwareVersion>
  <Port>18</Port>
  <PortUserDefined>1</PortUserDefined>
  <RealEstate_ID>3e45d1a8-63af-459e-ba0b-5ae74e43e432</RealEstate_ID>
  <RequestType>eniNone</RequestType>
  <RequestTypeInfo>sample string 19</RequestTypeInfo>
  <State>eniNotActive</State>
  <Type>eniProgrammingKey</Type>
  <Zone_ID>a7f90c4a-2489-48d7-acbe-c0635b75038f</Zone_ID>
</NetworkModule>