Get Facility Status

Gets the status values of all facilities under a specific GW (gateway).


/tms/v1.0/connect/site/{site-code}/gw/{gw-id}/facilities/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
Query parameters
Name Description
facility_types
array[String]
The facility type
Body parameters

N/A

Responses

Status: 200 - Success

Status: 400 - Invalid facility type

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 Facility List

Gets the list of all facilities at a specific site.


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

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

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 AHU Control History

Gets the control history of the AHU (Air Handling Unit).


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

Parameters

Path parameters
Name Description
facility-id*
String
The facility ID
Required
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
Query parameters
Name Description
yyyyMMdd*
String
Date to search (Input format: yyyyMMdd)
Required
Body parameters

N/A

Responses

Status: 200 - Success

Status: 400 - Invalid facility type

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 AIRCARE Control History

Gets the control history of the AIRCARE (commercial air purifier).


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

Parameters

Path parameters
Name Description
facility-id*
String
The facility ID
Required
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
Query parameters
Name Description
yyyyMMdd*
String
Date to search (Input format: yyyyMMdd)
Required
Body parameters

N/A

Responses

Status: 200 - Success

Status: 400 - Invalid facility type

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 AWHP Control History

Gets the control history of the AWHP (Air to Water Heat Pump).


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

Parameters

Path parameters
Name Description
facility-id*
String
The facility ID
Required
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
Query parameters
Name Description
yyyyMMdd*
String
Date to search (Input format: yyyyMMdd)
Required
Body parameters

N/A

Responses

Status: 200 - Success

Status: 400 - Invalid facility type

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 CHILLER Control History

Gets the control history of the CHILLER.


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

Parameters

Path parameters
Name Description
facility-id*
String
The facility ID
Required
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
Query parameters
Name Description
yyyyMMdd*
String
Date to search (Input format: yyyyMMdd)
Required
Body parameters

N/A

Responses

Status: 200 - Success

Status: 400 - Invalid facility type

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 IDU Control History

Gets the control history of an IDU (InDoor Unit) under a specific ODU (OutDoor Unit).


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

Parameters

Path parameters
Name Description
facility-id*
String
The facility ID
Required
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
Query parameters
Name Description
yyyyMMdd*
String
Date to search (Input format: yyyyMMdd)
Required
Body parameters

N/A

Responses

Status: 200 - Success

Status: 400 - Invalid facility type

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 ODU-AWHP Control History

Gets the control history of an AWHP (Air to Water Heat Pump) under a specific ODU (OutDoor Unit).


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

Parameters

Path parameters
Name Description
facility-id*
String
The facility ID
Required
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
Query parameters
Name Description
yyyyMMdd*
String
Date to search (Input format: yyyyMMdd)
Required
Body parameters

N/A

Responses

Status: 200 - Success

Status: 400 - Invalid facility type

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 ODU Control History

Gets the control history of the ODU (OutDoor Unit).


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

Parameters

Path parameters
Name Description
facility-id*
String
The facility ID
Required
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
Query parameters
Name Description
yyyyMMdd*
String
Date to search (Input format: yyyyMMdd)
Required
Body parameters

N/A

Responses

Status: 200 - Success

Status: 400 - Invalid facility type

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 VENT Control History

Gets the control history of the VENT (Ventilation device).


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

Parameters

Path parameters
Name Description
facility-id*
String
The facility ID
Required
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
Query parameters
Name Description
yyyyMMdd*
String
Date to search (Input format: yyyyMMdd)
Required
Body parameters

N/A

Responses

Status: 200 - Success

Status: 400 - Invalid facility type

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 AHU/CHILLER Cycle Data

Gets the cycle data of an AHU (Air Handling Unit)/CHILLER type facility.


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

Parameters

Path parameters
Name Description
facility-id*
String
The facility ID
Required
facility-type*
String
The facility type
Required
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
Query parameters
Name Description
fields*
String
Items to query
Required
yyyyMMddHH*
String
Date to search (Input format: yyyyMMddHH)
Required
Body parameters

N/A

Responses

Status: 200 - Success

Status: 400 - Invalid facility type

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 Information on Facilities

Gets information on the facilities at a site. Using this API, you can get information on the AHU, AIRCARE, AWHP, CHILLER, ODU, and VENT type facilities.


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

Parameters

Path parameters
Name Description
facility-id*
String
The facility ID
Required
facility-type*
String
The facility type
Required
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

Status: 400 - Invalid facility type

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 IDU/UNIT Cycle Data

Gets the cycle data of the IDU/UNIT type facilities under a specific ODU (OutDoor Unit).


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

Parameters

Path parameters
Name Description
facility-id*
String
The facility ID
Required
facility-type*
String
The facility type
Required
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
Query parameters
Name Description
fields*
String
Items to query
Required
yyyyMMddHH*
String
Date to search (Input format: yyyyMMddHH)
Required
Body parameters

N/A

Responses

Status: 200 - Success

Status: 400 - Invalid facility type

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 AHU Status

Gets the status value of the AHU (Air Handling Unit).


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

Parameters

Path parameters
Name Description
facility-id*
String
The facility ID
Required
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
Query parameters
Name Description
fields
array[String]
Items to query
Body parameters

N/A

Responses

Status: 200 - Success

Status: 400 - Invalid facility type

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 AIRCARE Status

Gets the status value of the AIRCARE (commercial air purifier).


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

Parameters

Path parameters
Name Description
facility-id*
String
The facility ID
Required
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
Query parameters
Name Description
fields
array[String]
Items to query
Body parameters

N/A

Responses

Status: 200 - Success

Status: 400 - Invalid facility type

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 ODU-AWHP Status

Gets the status of an AWHP (Air to Water Heat Pump) under a specific ODU (OutDoor Unit).


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

Parameters

Path parameters
Name Description
facility-id*
String
The facility ID
Required
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
Query parameters
Name Description
fields
array[String]
Items to query
Body parameters

N/A

Responses

Status: 200 - Success

Status: 400 - Invalid facility type

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 AWHP Status

Gets the status value of the AWHP (Air to Water Heat Pump).


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

Parameters

Path parameters
Name Description
facility-id*
String
The facility ID
Required
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
Query parameters
Name Description
fields
array[String]
Items to query
Body parameters

N/A

Responses

Status: 200 - Success

Status: 400 - Invalid facility type

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 CHILLER Status

Gets the status value of the CHILLER.


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

Parameters

Path parameters
Name Description
facility-id*
String
The facility ID
Required
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
Query parameters
Name Description
fields
array[String]
Items to query
Body parameters

N/A

Responses

Status: 200 - Success

Status: 400 - Invalid facility type

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 IDU Status

Gets the status value of an IDU (InDoor Unit) under a specific ODU (OutDoor Uunit).


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

Parameters

Path parameters
Name Description
facility-id*
String
The facility ID
Required
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
Query parameters
Name Description
fields
array[String]
Items to query
Body parameters

N/A

Responses

Status: 200 - Success

Status: 400 - Invalid facility type

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 ODU Status

Gets the status value of the ODU (OutDoor Unit).


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

Parameters

Path parameters
Name Description
facility-id*
String
The facility ID
Required
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
Query parameters
Name Description
fields
array[String]
Items to query
Body parameters

N/A

Responses

Status: 200 - Success

Status: 400 - Invalid facility type

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 UNIT Status

Gets the status value of an UNIT under a specific ODU (OutDoor Unit).


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

Parameters

Path parameters
Name Description
facility-id*
String
The facility ID
Required
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
Query parameters
Name Description
fields
array[String]
Items to query
Body parameters

N/A

Responses

Status: 200 - Success

Status: 400 - Invalid facility type

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 VENT Status

Gets the status value of the VENT (ventilation device).


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

Parameters

Path parameters
Name Description
facility-id*
String
The facility ID
Required
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
Query parameters
Name Description
fields
array[String]
Items to query
Body parameters

N/A

Responses

Status: 200 - Success

Status: 400 - Invalid facility type

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 Information on Facilities under the ODU

Gets information on facilities under a specific ODU. When getting facility information through this API, the facility must be of the AWHP, IDU, or UNIT type.


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

Parameters

Path parameters
Name Description
facility-id*
String
The facility ID
Required
facility-type*
String
The facility type
Required
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

N/A

Query parameters

N/A

Responses

Status: 200 - Success

Status: 400 - Invalid facility type

Status: 401 - Not authorized

Status: 403 - Access deny site

Status: 404 - Not found resource

Status: 412 - Missing request header

Status: 500 - Internal server error