Devices
Get Devices
DR 서비스에 등록된 특정 사용자 또는 리소스의 디바이스 리스트를 조회합니다.
Endpoint
GET {{baseUrl}}/devices/{user-id} or {resource-id}
Request
Path Parameter
식별값을 전달하기 위해 user-id 또는 resource-id를 입력합니다.
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
user-id or resource-id |
string |
mandatory |
user-id: 사용자 고유 식별 값으로, LG EMP 서비스에 등록된 사용자 ID입니다. LG EMP 서비스가 제공하는 Get Profile API로 조회할 수 있습니다. resource-id: 리소스 고유 식별 값으로, LG DR 서비스에 등록된 리소스ID입니다. LG DR 서비스가 제공하는 Get Resource API로 조회할 수 있습니다. |
Request Header
요청 헤더에 JSON 포맷으로 다음 정보를 입력합니다.
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
x-service-id |
string |
mandatory |
요청을 보내는 서비스의 서비스 ID 값입니다. |
|
x-service-token |
string |
mandatory |
유효한 요청인지 확인하기 위한 서비스 Token 값입니다. 서비스 통합 전에 발행되어야 합니다. |
|
x-message-id |
string |
optional |
요청에 대한 처리를 추적하기 위한 값입니다. |
|
x-country-code |
string |
mandatory |
서비스를 제공할 국가 코드입니다. ISO 국가 코드를 사용합니다. (예: KR, US, TW, CN, ......) |
Request Body
N/A
Request Example
$ curl '{{baseUrl}}/devices/{user-id}' -i -X GET
-H 'Accept: application/json'
-H 'x-message-id: message-id'
-H 'x-service-id: 3rd-party-service-id'
-H 'x-service-token: 3rd-party-service-token'
-H 'x-country-code: us'
Response
Response Body
요청에 대한 응답으로, 응답 바디에 다음 정보가 JSON 포맷으로 반환됩니다.
|
Key |
Value |
||
|---|---|---|---|
|
code |
요청 처리에 대한 결과 코드 코드값에 대한 설명은 Common Response 페이지를 참조하십시오. |
||
|
data |
결과 코드에 해당하는 결과 데이터 |
||
|
id |
디바이스 ID LG ThinQ 계정(ThinQ App)에서 디바이스를 삭제하고 다시 등록 할 경우, ID 값이 변경 될 수 있습니다. |
||
|
mac |
디바이스의 암호화 된 MAC 주소 (에어컨에서만 사용 가능) |
||
|
resourceID |
리소스 ID |
||
|
userID |
사용자 ID |
||
|
status |
디바이스 상태
|
||
|
deviceInfo |
디바이스 정보를 담은 오브젝트 |
||
|
|
|
alias |
디바이스 alias 이름 |
|
|
|
deviceType |
디바이스 타입 |
|
|
|
modelName |
모델 이름 |
Response Example
{
"code": 2000,
"data": [
{
"id": "kkkkkkkk-1234-11d3-80ae-044eaf8f70cc",
"mac": "abcd1234",
"resourceID":"CE-TV",
"userID": "dr-test@dr.com",
"status": 1,
"deviceInfo": {
"alias": "air conditioner",
"deviceType": "DEVIE_AIR_CONDITIONER",
"modelName": "PAC_910604_US"
}
},
{
"id": "aaaaaaaa-1234-11d3-80ae-044eaf8f70cc",
"mac": "bcdef2345",
"resourceID":"CE-TV",
"userID": "dr-test@dr.com",
"status": 1,
"deviceInfo": {
"alias": "air conditioner",
"deviceType": "DEVIE_AIR_CONDITIONER",
"modelName": "PAC_910604_US"
}
}
]
}
Check Devices
ThinQ 플랫폼(ThinQ App)에 등록되어 있는 디바이스 중에 DR 서비스를 지원하는 디바이스 리스트를 조회합니다.
Endpoint
GET {{baseUrl}}/devices/check
Request
Path Parameter
N/A
Request Header
요청 헤더에 JSON 포맷으로 다음 정보를 입력합니다. 공통 헤더와 함께 accessToken을 입력하여 전달합니다.
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
x-service-id |
string |
mandatory |
요청을 보내는 서비스의 서비스 ID 값입니다. |
|
x-service-token |
string |
mandatory |
유효한 요청인지 확인하기 위한 서비스 Token 값입니다. 서비스 통합 전에 발행되어야 합니다. |
|
x-message-id |
string |
optional |
요청에 대한 처리를 추적하기 위한 값입니다. |
|
x-country-code |
string |
mandatory |
서비스를 제공할 국가 코드입니다. ISO 국가 코드를 사용합니다. (예: KR, US, TW, CN, ......) |
|
accessToken |
string |
mandatory |
LG EMP 서비스가 발행하는 |
Request Body
N/A
Request Example
$ curl '{{baseUrl}}/devices/check' -i -X GET
-H 'Accept: application/json'
-H 'x-message-id: message-id'
-H 'x-service-id: 3rd-party-service-id'
-H 'x-service-token: 3rd-party-service-token'
-H 'x-country-code: us'
-H 'accessToken: 17489c4d8d558a014340……e033d7c580f8e8e9712'
}'
Response
Response Body
요청에 대한 응답으로, 응답 바디에 다음 정보가 JSON 포맷으로 반환됩니다.
|
Key |
Value |
||
|---|---|---|---|
|
code |
요청 처리에 대한 결과 코드 코드값에 대한 설명은 Common Response 페이지를 참조하십시오. |
||
|
data |
결과 코드에 해당하는 결과 데이터 |
||
|
deviceId |
디바이스 ID LG ThinQ 계정(ThinQ App)에서 디바이스를 삭제하고 다시 등록 할 경우, ID 값이 변경 될 수 있습니다. |
||
|
macAddress |
디바이스의 암호화 된 MAC 주소 (에어컨에서만 사용 가능) |
||
|
deviceInfo |
디바이스 정보를 담은 오브젝트 |
||
|
|
|
alias |
디바이스 alias 이름 |
|
|
|
deviceType |
디바이스 타입 |
|
|
|
modelName |
모델 이름 |
Response Example
{
"code": 2000,
"data": [
{
"deviceId": "kkkkkkkk-1234-11d3-80ae-044eaf8f70cc",
"macAddress": "044eaf8f70cc",
"deviceInfo": {
"alias": "air conditioner",
"deviceType": "DEVICE_AIR_CONDITIONER",
"modelName": "PAC_910604_US"
}
},
{
"deviceId": "aaaaaaaa-1234-11d3-80ae-044eaf8f70bb",
"macAddress": "044eaf8f70bb",
"deviceInfo": {
"alias": "air conditioner",
"deviceType": "DEVICE_AIR_CONDITIONER",
"modelName": "PAC_910604_US"
}
}
]
}