Get GW Information

Gets information of a specific gateway on a site.


/tms/v1.0/connect/site/{site-code}/gw/{gw-id}

Parameters

Path parameters
Name Description
gw-id*
String
The gateway ID
Required
site-code*
String
The site code
Required
Header parameters
Name Description
x-lgtms-service-id*
String
The service ID
Required
x-lgtms-service-key*
String
The service key
Required
x-lgtms-service-token*
String
The authentication token
Required
Body parameters

N/A

Query parameters

N/A

Responses

Status: 200 - Success 

{
  "code": "string",
  "msg": "string",
  "result": {
    "gw_id": "string",
    "gw_ip": "string",
    "gw_name": "string",
    "gw_type": "string",
    "mac": "string",
    "register_datetime": 0,
    "version": "string"
  }
}

Status: 401 - Not authorized

Status: 403 - Access deny site

Status: 404 - Not found resource

Status: 412 - Missing request header

Status: 500 - Internal server error

Get GW List

Gets the list of all gateways on a site.


/tms/v1.0/connect/site/{site-code}/gw

Parameters

Path parameters
Name Description
site-code*
String
The site code
Required
Header parameters
Name Description
x-lgtms-service-id*
String
The service ID
Required
x-lgtms-service-key*
String
The service key
Required
x-lgtms-service-token*
String
The authentication token
Required
Body parameters

N/A

Query parameters

N/A

Responses

Status: 200 - Success 

{
  "code": "string",
  "msg": "string",
  "result": [
    {
      "gw_id": "string",
      "gw_ip": "string",
      "gw_name": "string",
      "gw_type": "string",
      "mac": "string",
      "register_datetime": 0,
      "version": "string"
    }
  ]
}

Status: 401 - Not authorized

Status: 403 - Access deny site

Status: 404 - Not found resource

Status: 412 - Missing request header

Status: 500 - Internal server error

Get GW Status

Gets the status value of a specific gateway on a site.


/tms/v1.0/connect/site/{site-code}/gw/{gw-id}/state

Parameters

Path parameters
Name Description
gw-id*
String
The gateway ID
Required
site-code*
String
The site code
Required
Header parameters
Name Description
x-lgtms-service-id*
String
The service ID
Required
x-lgtms-service-key*
String
The service key
Required
x-lgtms-service-token*
String
The authentication token
Required
Body parameters

N/A

Query parameters

N/A

Responses

Status: 200 - Success 

{
  "code": "string",
  "msg": "string",
  "result": {
    "capacity_oper": "string",
    "cycle_select": "string",
    "cycle_status": "string",
    "demand_conn": "string",
    "demand_status": "string",
    "emergency_stop_status": "string",
    "energy_capacity": "string",
    "energy_capacity_set_rate": "string",
    "energy_end_time": "string",
    "energy_operation": "string",
    "energy_operation_mode": "string",
    "energy_operation_set_rate": "string",
    "energy_operation_sleep_time": "string",
    "energy_oversettemp": "string",
    "energy_set_time": "string",
    "energy_start_time": "string",
    "energy_timebase": "string",
    "energy_timebase_continue_time": "string",
    "energy_timebase_no_working_time_end": "string",
    "energy_timebase_no_working_time_start": "string",
    "energy_weather": "string",
    "log_status": "string",
    "operation_oper": "string",
    "operation_rate": "string",
    "pdi_status": "string",
    "sch_status": "string",
    "total_load_capa": "string"
  }
}

Status: 401 - Not authorized

Status: 403 - Access deny site

Status: 404 - Not found resource

Status: 412 - Missing request header

Status: 500 - Internal server error