AHU General Control

Sends general control commands to the AHU (Air Handling Unit).


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

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
Name Description
requestBody *
Query parameters

N/A

Responses

Status: 200 - Success 

{
  "code": "string",
  "msg": "string",
  "result": "string"
}

Status: 400 - Control fail

Status: 401 - Not authorized

Status: 403 - Access deny site

Status: 412 - Missing request header

Status: 500 - Internal server error

AIRCARE General Control

Sends general control commands to the AIRCARE (commercial air purifier).


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

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
Name Description
requestBody *
Query parameters

N/A

Responses

Status: 200 - Success 

{
  "code": "string",
  "msg": "string",
  "result": "string"
}

Status: 400 - Control fail

Status: 401 - Not authorized

Status: 403 - Access deny site

Status: 412 - Missing request header

Status: 500 - Internal server error

AWHP General Control

Sends general control commands to the AWHP (Air to Water Heat Pump).


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

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
Name Description
requestBody *
Query parameters

N/A

Responses

Status: 200 - Success 

{
  "code": "string",
  "msg": "string",
  "result": "string"
}

Status: 400 - Control fail

Status: 401 - Not authorized

Status: 403 - Access deny site

Status: 412 - Missing request header

Status: 500 - Internal server error

CHILLER General Control

Sends general control commands to the CHILLER.


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

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
Name Description
requestBody *
Query parameters

N/A

Responses

Status: 200 - Success 

{
  "code": "string",
  "msg": "string",
  "result": "string"
}

Status: 400 - Control fail

Status: 401 - Not authorized

Status: 403 - Access deny site

Status: 412 - Missing request header

Status: 500 - Internal server error

IDU General Control

Sends general control commands to the IDU (InDoor Unit).


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

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
Name Description
requestBody *
Query parameters

N/A

Responses

Status: 200 - Success 

{
  "code": "string",
  "msg": "string",
  "result": "string"
}

Status: 400 - Control fail

Status: 401 - Not authorized

Status: 403 - Access deny site

Status: 412 - Missing request header

Status: 500 - Internal server error

VENT General Control

Sends general control commands to the VENT (Ventilation device).


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

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
Name Description
requestBody *
Query parameters

N/A

Responses

Status: 200 - Success 

{
  "code": "string",
  "msg": "string",
  "result": "string"
}

Status: 400 - Control fail

Status: 401 - Not authorized

Status: 403 - Access deny site

Status: 412 - Missing request header

Status: 500 - Internal server error

ODU Cycle Control

Sends cycle control commands to the ODU (OutDoor Unit).


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

Parameters

Path parameters
Name Description
gw-id*
String
The gateway ID
Required
odu-id*
String
The ODU 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
Name Description
requestBody *
Query parameters

N/A

Responses

Status: 200 - Success 

{
  "code": "string",
  "msg": "string",
  "result": "string"
}

Status: 400 - Control fail

Status: 401 - Not authorized

Status: 403 - Access deny site

Status: 412 - Missing request header

Status: 500 - Internal server error