Skip to content

Gateway Details by Floor

The API returns details for all gateways on the floor.

Request

GET https://{em_ip_address_or_hostname}/ems/api/org/floor/v1/{floor_id}/gateways

Parameters

Request

NameDescription
em_ip_address_or_hostnameManage’s IP address or hostname
floor_idFloor identifier. Use the Get All Floors API, or in EM, select Facility > Floor in the left panel, and click the Settings tab to obtain the Floor ID.

Response

NameDescription
idGateway Identifier.
nameGateway name.
xaxisScaled reference of the distance measured in the horizontal dimension from the lower-left corner of the uploaded floor plan.
yaxisScaled reference of the distance measured in the vertical dimension from the lower-left corner of the uploaded floor plan.
lastCommTime of last sensor communication (YYYY-MM-DD 24HH-MM:SS.sssZ).
commStatusCommunication status of the gateway: Okay, Out
macAddressGateway MAC address. NOTE: Manage does not store leading zeros when saving or returning MAC/SNAP addresses. For example, "00:c0:17" will be stored as "0:c0:17”.
localIpAddressCurrentGateway IP address.

Sample Request

Using the Floor ID '1' returned by the Get All Floors sample response, request gateway details for all gateways on the floor.

GET https://192.80.3.2/ems/api/org/floor/v1/1/gateways

Sample Response

{
  "gateway": [
     {
        "id": "2",
        "name": "GWf9c730",
        "xaxis": "3285",
        "xaxis": "3848",
        "lastComm": "2020-10-19T05:33:04.852Z",
        "commStatus": "okay",   
        "macAddress": "0-B3-D6-63-C1-23",
        "localIpAddressCurrent": "192.168.32.1"
      },
      {
        "id": "3",
        "name": "GWf9efa7",
        "xaxis": "2952",
        "xaxis": "4449",
        "lastComm": "2020-10-19T04:32:02.202Z",
        "commStatus": "okay",
        "macAddress": "0-B3-D6-63-C1-23", 
        "localIpAddressCurrent": "192.168.32.1"    
     },
       {
        "id": "4",
        "name": "GWf9c726",
        "xaxis": "2351",
        "xaxis": "3715",
        "lastComm": "2020-10-19T05:33:04.854Z",
        "commStatus": "okay",
        "macAddress": "0-B3-D6-63-C1-23",  
        "localIpAddressCurrent": "192.168.32.1"   
      },
      {
        "id": "5",
        "name": "GWf9c737",
        "xaxis": "2902",
        "xaxis": "2397",
        "lastComm": "2020-10-19T04:44:04.853Z",
        "commStatus": "out",
        "macAddress": "0-B3-D6-63-C1-23", 
        "localIpAddressCurrent": "192.168.32.1"  
      }
   ]
}

Community

Connect and Collaborate with Industrial Professionals and Join the Community!

Click to load comments