Device API

기본 정보

BaseURL

Phase	KIC	AIC	EIC	Description
OP	https://kic-laundry-ext.lgthinq.com	-	-	운영
QA	https://kic-laundry-ext-qa.lgthinq.com	-	-	개발 및 테스트

API List

API	Method	End-point	Response Format	Summary
기기 목록 조회	GET	{{BASE_URL}}/devices	JSON	기기 목록을 조회합니다.
기기 찾기	POST	{{BASE_URL}}/devices/<device-id>/find	JSON	기기를 찾을 수 있도록 기기에서 beep 음을 발생시킵니다.
기기 사용 준비 (Courtesy)	POST	{{BASE_URL}}/devices/<device-id>/courtesy	JSON	결제 없이, 기기를 사용할 수 있도록 준비합니다. (Courtesy)
기기 사용 준비	POST	{{BASE_URL}}/devices/<device-id>/ready	JSON	결제 후, 기기를 사용할 수 있도록 준비합니다. (Paid)
기기 동작 정지	POST	{{BASE_URL}}/devices/<device-id>/reset	JSON	기기 동작을 정지합니다.
기기 정보 조회	GET	{{BASE_URL}}/devices/<device-id>	JSON	기기 정보를 조회합니다.
기기 정보 수정	PUT	{{BASE_URL}}/devices/<device-id>	JSON	기기 정보를 수정합니다.
[다중 기기] 기기 정보 수정	PUT	{{BASE_URL}}/devices/info	JSON	여러 기기의 정보를 한 번에 수정합니다.
기기 설정 조회	GET	{{BASE_URL}}/devices/<device-id>/settings	JSON	기기 설정을 조회합니다.
기기 설정 수정	PUT	{{BASE_URL}}/devices/<device-id>/settings	JSON	기기 설정을 수정합니다.
[다중 기기] 기기 설정 수정	PUT	{{BASE_URL}}/devices/settings	JSON	여러 기기의 설정 정보를 한 번에 수정합니다.
기기 기록 조회	GET	{{BASE_URL}}/devices/<device-id>/history	JSON	기기 기록을 조회합니다.
기기 에러 조회	GET	{{BASE_URL}}/devices/<device-id>/diagnosis	JSON	기기 에러를 조회합니다.
기기 예약	POST	{{BASE_URL}}/devices/<device-id>/reserve	JSON	기기를 예약합니다.
기기 예약 해제	DELETE	{{BASE_URL}}/devices/<device-id>/reserve	JSON	기기 예약을 해제합니다.

기기 목록 조회

GET {{BASE_URL}}/devices

사용자의 기기 목록을 리턴합니다. 

요청

Parameter

Location	Name	Required	Type	Description	Default	Example
Header	Common Header	Mandatory	-	-		-
Query	searchType	Optional	String	조회할 기기의 타입을 지정합니다.  입력하지 않는 경우: 전체 기기 목록을 리턴함 (디폴트와 동일하게 동작) info: 전체 기기 목록을 리턴함 (디폴트) reserved: 잠긴 상태의 기기 목록만 리턴함 ready: 준비된 상태의 기기 목록만 리턴함	info	reserved , ready, info
	additionalInfo	Optional	String	추가로 필요한 정보들을 지정합니다. ',' 로 구분하여 입력합니다. detail: 기기 상세 정보 history: 기기 이력 정보 (최근 10회) error: 기기 에러 정보 (최근 10회) settings: 기기 설정 정보	None	detail, history, error, settings
	ids	Optional	String	조회할 기기의 id 리스트를 입력합니다. 입력하지 않는 경우 전체 기기에 대해 조회합니다.  최대 100개까지 조회 가능가능합니다.	None	1, 2, 3, 4

응답

성공 

성공 시, resultCode가 정상 코드 (0000)로 리턴됩니다. 결과 데이터는 응답 메시지의 result를 참조하십시오.

Name				Type	Required	Description	Default	Example
resultCode				string	Mandatory	결과 코드		0000
result				list		결과 데이터
└	deviceId			string	Mandatory	기기 ID		87e9f680-7117-11d3-b015-0051edb754a8
└	deviceStatus			string	Mandatory	기기 상태		E
└	modelNm			string	Mandatory	모델명		FH069FD_T
└	deviceType			string	Mandatory	기기 타입		211
└	status			string	Optional	예약 상태 (reserved) 또는 사용 준비 (ready) 상태		reserved, ready
└	expirationTime			string	Optional	예약 상태 (reserved)일 때만 사용됨 예약 만료 시간 (UTC)으로 시간은 서버 상황에 따라 오차가 발생할 수 있음		2021-02-25, 03:44:35
└	detail			dict	Optional
	└		alias	string	Optional	기기 별명
	└		online	boolean	Optional	서버와 연결 여부		true
	└		ssid	string	Optional	인터넷이 연결된 ssid		test
	└		error	string	Optional	에러 상태 ERROR_NO 은 에러가 없는 상태	ERRROR_NO	ERRROR_NO
	└		state	string	Optional	동작 상태	POWEROFF	POWEROFF
	└		course	string	Optional	동작 코스	NOT_SELECTED	NOT_SELECTED
	└		remain	number	Optional	남은 시간	0	0
	└		reservable	boolean	Optional	기기 예약 가능 여부		true, false
	└		payable	boolean	Optional	기기 비용 지불 가능 여부		true, false
└	history			list	Optional
	└		event	string	Optional	발생한 이벤트		POWEROFF : 0
	└		date	string	Optional	발생 날짜
	└		type	string	Optional	타입 (일반 이벤트 or 이벤트)		S, E
	└		detail	string	Optional	설명
└	error			list	Optional
	└		todo	string	Optional	에러 해결을 위해 할 수 있는 리스트
	└		code	string	Optional	에러 코드
	└		date	string	Optional	에러 발생 날짜
	└		detail	string	Optional	에러 코드 설명
└	settings			dict	Optional
	└		washingTime	list	Optional	코스별 세탁 시간 NonHeater Model : [course1 value, course2 value, course3 value, course4 value] Heater Model: [course1 value, course2 value, course3 value, course4 value, course5 value, course6 value]	8	NonHeater : [10, 11, 8, 7] Heater : [5, 5, 8, 7, 11, 11]
	└		waterLevel	list	Optional	코스별 수위 1: Low 2: Middle 3: High NonHeater Model: [course1 value, course2 value, course3 value, course4 value] Heater Model: [course1 value, course2 value, course3 value, course4 value, course5 value, course6 value]	1	NonHeater : [1, 1, 1, 1] Heater : [1, 1, 1, 1, 1, 1]
	└		rinsingTime	list	Optional	코스별 헹굼 시간 범위: 8~16 NonHeater: [course1 value, course2 value, course3 value, course4 value] Heater: [course1 value, course2 value, course3 value, course4 value, course5 value, course6 value]	8	NonHeater : [8, 8, 8, 8] Heater: [8, 8, 8, 8, 8, 8]
	└		rinsingCount	list	Optional	코스별 헹굼 횟수 범위: 1~5 NonHeater: [course1 value, course2 value, course3 value, course4 value] Heater: [course1 value, course2 value, course3 value, course4 value, course5 value, course6 value]	2	NonHeater : [1, 1, 1, 1] Heater: [1, 1, 1, 1, 1, 1]
	└		spinSpeed	list	Optional	코스별 탈수 MAX RPM 범위: 500 ~ 1000, Max (100 단위) NonHeater: [course1 value, course2 value, course3 value, course4 value] Heater: [course1 value, course2 value, course3 value, course4 value, course5 value, course6 value]	Max	NonHeater : ['Max', 'Max', 'Max', 'Max'] Heater: ['Max', 'Max', 'Max', 'Max', 'Max', 'Max']
	└		dropCount	number	Optional	탈수 행정에서 탈수 중 UB에 의해 정지하는 횟수의 MAX Count로 설정된 횟수를 초과 하게되면 UE가 발생 데이터 범위: 25~50	50	50
	└		twinSprary	string	Optional	Circulation Pump 옵션 사용 여부 ‘0’: Disable ‘1’: Enable	‘0’	‘0’
	└		price	list	Optional	코스별 가격 범위: 0 ~ 199 0으로 설정시, defaultPrice의 가격과 동일하게 설정 됨 첫번째 값은 defaultPrice로 모든 코스의 가격을 대표하는 가격 화폐단위 가격 priceⅹRatingMoney NonHeater:   [defaultPrice, course1 value, course2 value, course3 value, course4 value]  Heater: [defaultPrice, course1 value, course2 value, course3 value, course4 value, course5 value, course6 value]		NonHeater : [20, 0, 0, 0, 30] Heater: [20, 0, 0, 0, 0, 0, 30]
	└		coin	number	Optional	최소 화폐 단위의 값 1: 한국, 일본, 중국, 필리핀  2: 유럽  5: 북미, 캐나다  20: 호주  최소 화폐 가격: coin x RatingMoney	5	5
	└		addSuperWash	number	Optional	Add Super wash의 가격 범위: 0 ~ 199 화폐 단위 가격: addSuperWash x RatingMoney	5	5
	└		dryCycleTime	list	Optional	코스별 건조 시간 범위: 5~99 (1 단위) course 1~4 데이터	45	[45, 45, 45, 45]
	└		topOffTime	list	Optional	코스별 topOff 시간 범위: 1~99 (1단위) [course 1 value, course 2 value, course 3 value, course 4 value]	5	[5, 5, 5, 5]
	└		topOff	string	Optional	동작 중 건조시간 추가기능 활성화 여부 ‘0’: Disable ‘1’: Enable	‘0’
	└		sensingDry	string	Optional	습도값을 보고 건조시간 자동 조절 하는 기능 활성화 여부 ‘0’: Disable ‘1’: Enable
	└		regularPrice	list	Optional	코스별 가격 범위: 0 ~ 199 0으로 설정시, defaultPrice의 가격과 동일하게 설정 됨 첫번째 값은 defaultPrice로 모든 코스의 가격을 대표하는 가격 화폐 단위 가격: regularPrice ⅹRatingMoney [defaultPrice, course1 value, course2 value, course3 value, course4 value]		[20, 0, 0, 0, 0]
	└		topOffPrice	list	Optional	topOff 설정시 코스별 가격		[10, 10, 10, 10]
	└		coin1	number	Optional	최소 화폐 단위의 값 1: 한국, 일본, 중국, 필리핀  2: 유럽  5: 북미, 캐나다  20: 호주  최소 화폐 가격 coin x RatingMoney	5	5

실패

실패 시, resultCode가 에러 코드 값으로 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.

Example

Request

 [GET] {{BASE_URL}}/devices

Response

{{BASE_URL}}/devices?searchType=reserved
{
 "resultCode": "0000",
 "result": [
    {
      "deviceId": "4138737e7eb621c26138f89f60b646671b03cf30817a7f55a7eb1e0af4aa501e",
      "deviceStatus": "T",
"modelNm": "FH069FD_T",
    "deviceType": "211",
    "status": "reserved"
    }
  ]
}
 
{{BASE_URL}}/devices?additionalInfo=detail
{
    "resultCode": "0000",
    "result": [
        {
            "deviceId": "4138737e7eb621c26138f89f60b646671b03cf30817a7f55a7eb1e0af4aa501e",
            "deviceStatus": "E",
            "modelNm": "FH069FD_T",
            "deviceType": "211",
            "status": "ready",
            "detail": {
                "alias": "Dryer_new",
                "online": true,
                "ssid": null,
                "error": "ERROR_NO",
                "state": "POWEROFF",
                "course": "Hot",
                "remain": 0
            }
        }
    ]
}
 
{{BASE_URL}}/devices?additionalInfo=history
 
{
    "resultCode": "0000",
    "result": [
        {
            "deviceId": "4138737e7eb621c26138f89f60b646671b03cf30817a7f55a7eb1e0af4aa501e",
            "deviceStatus": "E",
            "modelNm": "211",
            "deviceType": "211",
            "status": "ready",
            "history": [
                {
                    "date": "2020-12-17 02:57:11",
                    "event": "INITIAL",
                    "type": "S",
                    "detail": "NOT_SELECTED / Twin spray"
                },
                {
                    "date": "2020-12-17 02:56:58",
                    "event": "END",
                    "type": "S",
                    "detail": "NOT_SELECTED"
                },
                {
                    "date": "2020-12-17 02:47:11",
                    "event": "SPINNING",
                    "type": "S",
                    "detail": "Hot"
                },
                {
                    "date": "2020-12-17 02:29:32",
                    "event": "RINSING",
                    "type": "S",
                    "detail": "Hot"
                },
                {
                    "date": "2020-12-17 02:22:09",
                    "event": "WASHING",
                    "type": "S",
                    "detail": "Hot"
                },
                {
                    "date": "2020-12-16 11:35:39",
                    "event": "INITIAL",
                    "type": "S",
                    "detail": "NOT_SELECTED / Twin spray / Super wash"
                },
                {
                    "date": "2020-12-16 11:35:26",
                    "event": "END",
                    "type": "S",
                    "detail": "NOT_SELECTED"
                },
                {
                    "date": "2020-12-16 11:25:50",
                    "event": "SPINNING",
                    "type": "S",
                    "detail": "Hot"
                },
                {
                    "date": "2020-12-16 11:08:56",
                    "event": "RINSING",
                    "type": "S",
                    "detail": "Hot"
                },
                {
                    "date": "2020-12-16 11:01:45",
                    "event": "WASHING",
                    "type": "S",
                    "detail": "Hot"
                }
            ]
        }
    ]
}
 
 
 
{{BASE_URL}}/devices?additionalInfo=error
{
    "resultCode": "0000",
    "result": [
        {
            "deviceId": "4138737e7eb621c26138f89f60b646671b03cf30817a7f55a7eb1e0af4aa501e",
            "deviceStatus": "E",
            "modelNm": "211",
            "deviceType": "211",
            "status": "ready",
            "error": [
                {
                    "date": "2020-12-13 00:55:21",
                    "code": "ERROR_DE1",
                    "detail": "Door Open Error",
                    "todo": [
                        "Close the door completely.",
                        "If it will not open, call for service."
                    ]
                },
                {
                    "date": "2020-11-28 22:15:13",
                    "code": "ERROR_DE2",
                    "detail": "Door Lock Error",
                    "todo": [
                        "Check the door switch"
                    ]
                }
            ]
        }
    ]
}
 
{{BASE_URL}}/devices?additionalInfo=settings
 
{
    "resultCode": "0000",
    "result": [
        {
            "deviceId": "4138737e7eb621c26138f89f60b646671b03cf30817a7f55a7eb1e0af4aa501e",
            "deviceStatus": "E",
            "modelNm": "211",
            "deviceType": "211",
            "status": "ready",
            "settings": {
                "washingTime": [
                    10,
                    10,
                    10,
                    10
                ],
                "waterLevel": [
                    1,
                    1,
                    1,
                    1
                ],
                "rinsingTime": [
                    8,
                    8,
                    8,
                    8
                ],
                "rinsingCount": [
                    2,
                    2,
                    2,
                    2
                ],
                "dropCount": 50,
                "twinSpray": "0",
                "price": [
                    0,
                    20,
                    15,
                    10,
                    5
                ],
                "coin": 1,
                "addSuperWash": 5,
                "nonStopRinsing": false,
                "spinSpeed": [
                    "Max",
                    "Max",
                    "Max",
                    "Max"
                ]
            }
        }
    ]
}
 
{{BASE_URL}}/devices?additionalInfo=settings, history, error, detail
  
{
    "resultCode": "0000",
    "result": [
        {
            "deviceId": "4138737e7eb621c26138f89f60b646671b03cf30817a7f55a7eb1e0af4aa501e",
            "deviceStatus": "E",
            "modelNm": "211",
            "deviceType": "211",
            "status": "ready",
            "settings": {
                "washingTime": [
                    10,
                    10,
                    10,
                    10
                ],
                "waterLevel": [
                    1,
                    1,
                    1,
                    1
                ],
                "rinsingTime": [
                    8,
                    8,
                    8,
                    8
                ],
                "rinsingCount": [
                    2,
                    2,
                    2,
                    2
                ],
                "dropCount": 50,
                "twinSpray": "0",
                "price": [
                    0,
                    20,
                    15,
                    10,
                    5
                ],
                "coin": 1,
                "addSuperWash": 5,
                "nonStopRinsing": false,
                "spinSpeed": [
                    "Max",
                    "Max",
                    "Max",
                    "Max"
                ]
            },
            "history": [
                {
                    "date": "2020-12-17 02:57:11",
                    "event": "INITIAL",
                    "type": "S",
                    "detail": "NOT_SELECTED / Twin spray"
                },
                {
                    "date": "2020-12-17 02:56:58",
                    "event": "END",
                    "type": "S",
                    "detail": "NOT_SELECTED"
                },
                {
                    "date": "2020-12-17 02:47:11",
                    "event": "SPINNING",
                    "type": "S",
                    "detail": "Hot"
                },
                {
                    "date": "2020-12-17 02:29:32",
                    "event": "RINSING",
                    "type": "S",
                    "detail": "Hot"
                },
                {
                    "date": "2020-12-17 02:22:09",
                    "event": "WASHING",
                    "type": "S",
                    "detail": "Hot"
                },
                {
                    "date": "2020-12-16 11:35:39",
                    "event": "INITIAL",
                    "type": "S",
                    "detail": "NOT_SELECTED / Twin spray / Super wash"
                },
                {
                    "date": "2020-12-16 11:35:26",
                    "event": "END",
                    "type": "S",
                    "detail": "NOT_SELECTED"
                },
                {
                    "date": "2020-12-16 11:25:50",
                    "event": "SPINNING",
                    "type": "S",
                    "detail": "Hot"
                },
                {
                    "date": "2020-12-16 11:08:56",
                    "event": "RINSING",
                    "type": "S",
                    "detail": "Hot"
                },
                {
                    "date": "2020-12-16 11:01:45",
                    "event": "WASHING",
                    "type": "S",
                    "detail": "Hot"
                }
            ],
            "error": [
                {
                    "date": "2020-12-13 00:55:21",
                    "code": "ERROR_DE1",
                    "detail": "Door Open Error",
                    "todo": [
                        "Close the door completely.",
                        "If it will not open, call for service."
                    ]
                },
                {
                    "date": "2020-11-28 22:15:13",
                    "code": "ERROR_DE2",
                    "detail": "Door Lock Error",
                    "todo": [
                        "Check the door switch"
                    ]
                }
            ],
            "detail": {
                "alias": "Dryer_new",
                "online": false,
                "ssid": null,
                "error": "ERROR_NO",
                "state": "POWEROFF",
                "course": "Hot",
                "remain": 0
            }
        }
    ]
}

 

기기 찾기 (Beep)

POST {{BASE_URL}}/devices/<device-id>/find

기기를 찾을 수 있도록 기기에서 beep 음을 발생시킵니다.

요청

Parameter

Location	Name	Required	Type	Description	Example
Header	Common Header	Mandatory	-	-	-
Path	device-id	Mandatory	String	기기 ID	07dcf5b1-fd14-104d-8d6a-203dbdb9b139

응답

성공 

성공 시, resultCode가 정상 코드 (0000)로 리턴됩니다. 결과 데이터는 응답 메시지의 result에서 확인할 수 있습니다

Name			Type	Required	Description
resultCode			string	Mandatory	결과 코드
result			dict	Mandatory	결과 메시지

실패

실패 시, resultCode에 에러 코드 값이 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.

Example

Request

[POST] {{BASE_URL}}/devices/<device-id>/find

Response

{
  "resultCode": "0000",
  "result": {}
}

 

기기 사용 준비 (Courtesy)

POST {{BASE_URL}}/devices/<device-id>/courtesy

결제 없이, 기기를 사용 가능한 상태로 준비합니다. 

요청

Parameter

Location	Name	Required	Type	Description	Example
Header	Common Header	Mandatory	-	-	-
Path	device-id	Mandatory	String	기기 ID	07dcf5b1-fd14-104d-8d6a-203dbdb9b139

응답

성공 

성공 시, resultCode가 정상 코드 (0000)로 리턴됩니다. 결과 데이터는 응답 메시지의 result에서 확인할 수 있습니다.

Name			Type	Required	Description
resultCode			string	Mandatory	결과 코드
result			dict	Mandatory	결과 메시지

실패

실패 시, resultCode에 에러 코드 값이 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.

Example

Request

[POST] {{BASE_URL}}/devices/<device-id>/courtesy

Response

{
  "resultCode": "0000",
  "result": {}
}

 

기기 사용 준비

POST {{BASE_URL}}/devices/<device-id>/ready

기기를 사용 가능한 상태로 준비합니다.

요청

Parameter

Location	Name		Required	Type	Description	Default	Example
Header	Common Header		Mandatory	-	-		-
Path	device-id		Mandatory	String	기기 ID	-	07dcf5b1-fd14-104d-8d6a-203dbdb9b139
Body	request
	└	paymentMoney	Mandatory	number	지불한 금액	-

응답

성공 

성공 시, resultCode가 정상 코드 (0000)로 리턴됩니다. 결과 데이터는 응답 메시지의 result에서 확인할 수 있습니다.

Name			Type	Required	Description
resultCode			string	Mandatory	결과 코드
result			dict	Mandatory	결과 메시지

실패

실패 시, resultCode에 에러 코드 값이 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.

Example

Request

[POST] {{BASE_URL}}/devices/<device-id>/ready

{
  "request": {
    "paymentMoney": 1000,
  }
}

Response

{
  "resultCode": "0000",
  "result": {}
}

 

기기 동작 정지

POST {{BASE_URL}}/devices/<device-id>/reset

기기 동작을 정지시킵니다.

기기에 문제가 발생했을 때, 먼저 이 API로 동작을 정지시켜야 다시 사용할 수 있습니다.

요청

Parameter

Location	Name	Required	Type	Description	Example
Header	Common Header	Mandatory	-	-	-
Path	device-id	Mandatory	String	기기 ID	07dcf5b1-fd14-104d-8d6a-203dbdb9b139

응답

성공 

성공 시, resultCode가 정상 코드 (0000)로 리턴됩니다. 결과 데이터는 응답 메시지의 result에서 확인할 수 있습니다.

Name			Type	Required	Description
resultCode			string	Mandatory	결과 코드
result			dict	Mandatory	결과 메시지

실패

실패 시, resultCode에 에러 코드 값이 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.

Example

Request

[POST] {{BASE_URL}}/devices/<device-id>/reset

Response

{
  "resultCode": "0000",
  "result": {}
}

 

기기 정보 조회

GET {{BASE_URL}}/devices/<device-id>

기기 정보를 조회합니다. 

코스 선택 후 기기 정보 조회 시 기기 결제 필요 금액을 알 수 있습니다.

요청

Parameter

Location	Name	Required	Type	Description	Example
Header	Common Header	Mandatory	-	-	-
Path	device-id	Mandatory	String	조회하고자 하는 기기의 ID	07dcf5b1-fd14-104d-8d6a-203dbdb9b139

응답

성공 

성공 시, resultCode가 정상 코드 (0000)로 리턴됩니다. 결과 데이터는 응답 메시지의 result를 참조하십시오.

Name				Type	Required	Description	Example
resultCode				string	Mandatory	결과 코드	0000
result				dict		결과 데이터
└	deviceId			string	Mandatory	기기 ID	87e9f680-7117-11d3-b015-0051edb754a8
└	deviceStatus			string	Mandatory	기기 상태	E
└	modelNm			string	Mandatory	모델명	FH069FD_T
└	deviceType			string	Mandatory	기기 타입	211
└	status			string	Optional	reserved (예약 상태) 혹은 ready (사용 준비 상태)	reserved, ready
└	expirationTime			string	Optional	예약 만료시간(UTC) 예약상태일 때만 사용됨 시간은 서버 상황에 따라 오차가 발생 할 수 있음	2021-02-25, 03:44:35
└	detail			dict	Optional	-
└	alias			string	Optional	기기 이름
└	online			boolean	Optional	기기가 서버와 연결되었는지 여부	true
└	ssid			string	Optional	인터넷이 연결된 ssid	test
└	error			string	Optional	에러 상태 ERROR_NO 은 에러가 없는 상태를 의미함	ERRROR_NO
└	state			string	Optional	동작 상태	POWEROFF
└	course			string	Optional	동작 코스	NOT_SELECTED
└	remain			number	Optional	남은 시간	0
└	reservable			boolean	Optional	기기 예약 가능 여부	true, false
└	payable			boolean	Optional	기기 비용 지불 가능 여부	true, false

실패

실패 시, resultCode가 에러 코드 값으로 리턴됩니다. 각 에러 코드에 대한 설명은 Common Response > Result Code를 참조하십시오.

Example

Request

 [GET] {{BASE_URL}}/devices/<device-id>

Response

{
  "resultCode": "0000",
  "result": {
    "deviceId": "87e53b90-7117-11d3-91ef-203dbdb822c6",
    "alias": "Washer_new",
    "online": true,
    "ssid": null,
    "deviceType": "211",
    "modelNm": "FH069FD_M",
    "deviceStatus": null,
    "state": "INITIAL",
    "course": "NOT_SELECTED",
    "remain": 0,
    "error": "ERROR_NO",
    "reservable": true,
    "payable": false,
    "status": "reserved",
    "expirationTime": "2021-02-25, 03:44:35"
  }
}

 

기기 정보 수정

PUT {{BASE_URL}}/devices/<device-id>

기기 정보 수정을 요청합니다.

요청

Parameter

Location	Name		Required	Type	Description	Example
Header	Common Header		Mandatory	-	-	-
Path	device-id		Mandatory	String	기기 ID	07dcf5b1-fd14-104d-8d6a-203dbdb9b139
Body	request
	└	nickName	Optional	String	변경할 닉네임	-

응답

성공 

성공 시, resultCode가 정상 코드 (0000)로 리턴됩니다. 결과 데이터는 응답 메시지의 result에서 확인할 수 있습니다

Name			Type	Required	Description
resultCode			string	Mandatory	결과 코드
result			dict	Mandatory	결과 메시지

실패

실패 시, resultCode가 에러 코드 값으로 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.

Example

Request

[PUT] {{BASE_URL}}/devices/<device-id>

#nickName update
{
  "request": {
    "nickName": "1111"
  }
} 

Response

{
  "resultCode": "0000",
  "result": {}
}

 

[다중 기기] 기기 정보 수정 

PUT {{BASE_URL}}/devices/info

한 번에 여러 기기의 정보를 수정합니다. (최대 20개)

요청

Parameter

Location	Name		Required	Type	Description	Example
Header	Common Header		Mandatory	-	-	-
Body	request			list
	└	deviceId			디바이스 ID
	└	nickName	Optional	string	변경할 닉네임

응답

성공 

성공 시, resultCode가 정상 코드 (0000)로 리턴됩니다. 결과 데이터는 응답 메시지의 result에서 확인할 수 있습니다

Name				Type	Required	Description
resultCode				string	Mandatory	결과 코드
result				dict	Mandatory	결과 메시지
└			success	list		성공한  deviceId리스트
└			fail	list		실패한 디바이스에 대한  deviceId 및 에러 정보 리스트

실패

실패 시, resultCode가 에러 코드 값으로 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.

Example

Request

[PUT] {{ENDPOINT_URL}}/devices/info

{
  "request": [{
      "deviceId": "4138737e7eb621c26138f89f60b646671b03cf30817a7f55a7eb1e0af4aa501e",
      "nickName": "nick"
    },
    {
      "deviceId": "c7252179d34a3e61c706a559cc9d14ce799995ca310289b8523067721bca1a6d",
      "nickName": "nick2"
    }
  ]
}

Response

{
  "resultCode": "0000",
  "result": {
    "success": [
      "4138737e7eb621c26138f89f60b646671b03cf30817a7f55a7eb1e0af4aa501e"
    ],
    "fail": [{
      "deviceId": "c7252179d34a3e61c706a559cc9d14ce799995ca310289b8523067721bca1ad",
      "errCode": "0101",
      "errDescription": "not registered device"
    }]
  }
}

 

기기 설정 조회

GET {{BASE_URL}}/devices/<device-id>/settings

기기 설정 정보를 조회합니다. 

요청

Parameter

Location	Name	Required	Type	Description	Example
Header	Common Header	Mandatory	-	-	-
Path	device-id	Mandatory	String	기기 ID	07dcf5b1-fd14-104d-8d6a-203dbdb9b139

응답

성공 

성공 시, resultCode가 정상 코드 (0000)로 리턴됩니다. 결과 데이터는 응답 메시지의 result에서 확인할 수 있습니다. 

코스별 설정값

코스별 설정값이 필요한 경우에는 list를 사용합니다.  

세탁기의 경우 NonHeater 모델은 4개의 코스를 제공하고, Heater 모델은 6개의 코스를 제공합니다. 따라서, 다음과 같이 코스별로 설정값을 전달할 수 있습니다. 

• NonHeater 모델: 
  • [course1 설정값, course2 설정값, course3 설정값, course4 설정값] 
• Heater 모델: 
  • [course1 설정값, course2 설정값, course3 설정값, course4 설정값, course5 설정값, course6 설정값] 

예를 들어, NonHeater 모델의 경우 설정값이 [1, 1, 4, 4]라면, 다음을 의미합니다.

• 1번 코스 설정값=1/ 2번 코스 설정값=1/ 3번 코스 설정 값=4/ 4번 코스 설정 값=4

RatingMoney

국가별 금액을 표기하기 위해 사용되는 값으로, 국가 혹은 지역별로 다음과 같은 고정된 값을 가집니다.

• Europe: 5
• Australia: 5
• America: 5
• China: 1
• Korea: 100
• Japan: 100
• Philippines: 5

Name			Type	Required	Description	Default	Example
resultCode			string	Mandatory	결과 코드	-	-
result			dic	Mandatory	결과 데이터	-	-
└	washingTime		list	Optional	코스별 세탁 시간 데이터값은 list로 전달함 NontHeater 모델 : [course1, course2, course3, course4] Heater 모델 : [course1, course2, course3, course4, course5, course6]	8	NontHeater 모델: [10, 11, 8, 7] Heater 모델: [5, 5, 8, 7, 11, 11]
└	waterLevel		list	Optional	코스별 수위로, 다음 값 사용 1: Low 2: Middle 3: High 데이터값은 list로 전달함 NonHeater 모델: [course1, course2, course3, course4]  Heater 모델: [course1, course2, course3, course4, , course5, course6]	1	NontHeater 모델: [1, 1, 1, 1] Heater 모델: [1, 1, 1, 1, 1, 1]
└	rinsingTime		list	Optional	코스별 헹굼 시간 데이터 범위: 8~16  데이터값은 list로 전달함 NonHeater 모델: [course1, course2, course3, course4]  Heater 모델: [course1, course2, course3, course4, , course5, course6]	8	NontHeater 모델: [8, 8, 8, 8] Heater 모델: [8, 8, 8, 8, 8, 8]
└	rinsingCount		list	Optional	코스별 헹굼 횟수  데이터 범위: 1~5 데이터값은 list로 전달함 NonHeater 모델: [course1, course2, course3, course4]  Heater 모델: [course1, course2, course3, course4, course5, course6]	2	NontHeater 모델: [1, 1, 1, 1] Heater 모델: [1, 1, 1, 1, 1, 1]
└	spinSpeed		list	Optional	코스별 탈수 MAX RPM 데이터 범위:  500 ~ 1000 (100단위) , Max 데이터값은 list로 전달함 NonHeater 모델: [course1, course2, course3, course4]  Heater 모델: [course1, course2, course3, course4, , course5, course6]	Max	NontHeater 모델: ['Max', 'Max', 'Max', 'Max'] Heater 모델: ['Max', 'Max', 'Max', 'Max', 'Max', 'Max']
└	dropCount		number	Optional	탈수 행정에서 탈수 중 UB에 의해 정지하는 횟수의 MAX Count로 설정된 횟수를 초과 하게되면 UE가 발생함 데이터 범위: 25~50	50	50
└	twinSpray		string	Optional	Circulation Pump 옵션 사용 여부로, 다음 값을 사용함 '0': Disable '1':  Enable	'0'	'0'
└	price		list	Optional	코스별 가격 데이터 범위: 0 ~ 199 0으로 설정 시, defaultPrice의 가격과 동일하게 설정함을 의미함. defulatPrice: 모든 코스의 가격을 대표하는 가격을 의미함. 데이터 값은 코스별로 list로 전달하며, list의 첫 번째 가격은 defulatPrice임 NonHeater 모델: [defaultPrice, course1, course2, course3, course4]  Heater 모델: [defaultPrice, course1, course2, course3, course4, , course5, course6]   화폐 단위 가격 = priceⅹRatingMoney	-	NonHeater: [20, 0, 0, 0, 30] Heater: [20, 0, 0, 0, 0, 0, 30]
└	coin		number	Optional	최소 화폐 단위의 값으로, 국가 혹은 지역 별로 다음 값을 사용함 1: 한국/일본/중국/필리핀 2: 유렵 5: 북미/캐나다 20: 호주 최소 화폐 가격 = coinx RatingMoney	5	5
└	addSuperWash		number	Optional	Add Super wash의 가격 데이터 범위: 0 ~ 199 화폐 단위 가격 = addSuperWashⅹRatingMoney	5	5
└	dryCycleTime		list	Optional	코스별 건조 시간 범위: 5 ~ 99 (1단위) 데이터값은 list로 전달함 [course1, course2, course3, course4]	45	[45, 45, 45, 45]
└	topOffTime		list	Optional	코스별 topOff 시간 데이터 범위: 1~99 (1단위) 데이터값은 list로 전달함 [course1, course2, course3, course4]	5	[5, 5, 5, 5]
└	topOff		string	Optional	동작 중 건조 시간 추가 기능 활성화 여부 '0': Disable '1': Enable	'0'
└	sensingDry		string	Optional	습도값을 보고 건조시간 자동 조절 하는 기능 활성화 여부 '0': Disable '1': Enable	'0'
└	regularPrice		list	Optional	코스별 가격 데이터 범위: 0 ~ 199 0으로 설정 시, defaultPrice의 가격과 동일하게 설정됨 defaultPrice: 모든 코스의 가격을 대표하는 가격 데이터값은 list로 전달하며, list의 첫 번째 값은 defaultPrice임 [defaultPrice, course1, course2, course3, course4]  화폐 단위 가격 = regularPriceⅹRatingMoney	-	[20, 0, 0, 0, 0]
└	topOffPrice		list	Optional	topOff 설정 시 코스별 가격	-	[10, 10, 10, 10]
└	coin1		number	Optional	최소 화폐 단위의 값으로, 국가 혹은 지역 별로 다음 값을 사용함 1: 한국/일본/중국/필리핀 2: 유렵 5: 북미/캐나다 20: 호주	5	5

실패

실패 시, resultCode에 에러 코드 값이 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.

Example

Request

 [GET] {{BASE_URL}}/devices/<device-id>/settings

Response

#washer
{ 
  "resultCode": "0000",
  "result": {
    "washingTime": [8, 8, 8, 8],
    "waterLevel": [1, 1, 1, 1],
    "rinsingTime": [8, 8, 8, 8],
    "rinsingCount": [2, 2, 2, 2],
    "spinSpeed": ["Max", "Max", "Max", "Max"],
    "dropCount": 50,
    "twinSpray": "0",
    "price": [0, 0, 0, 0, 0],
    "coin": 0.25,
    "addSuperWash": 0.25,
    "nonStopRinsing": False
  }
}

#dryer
{ 
  "resultCode": "0000",
  "result": {
    "dryCycleTime": [45, 45, 45, 45],
    "topOffTime": [5, 5, 5, 5],
    "topOff": "1",
    "sensingDry": "0",
    "regularPrice": [0, 0, 0, 0, 0],
    "topOffPrice": [0.25, 0.25, 0.25, 0.25],
    "coin1": 0.25
  }
} 

 

기기 설정 수정

PUT {{BASE_URL}}/devices/<device-id>/settings

기기 설정 정보를 수정합니다. 

요청

코스별 설정값

코스별 설정값이 필요한 경우에는 list를 사용합니다.  

세탁기의 경우 NonHeater 모델은 4개의 코스를 제공하고, Heater 모델은 6개의 코스를 제공합니다. 따라서, 다음과 같이 코스별로 설정값을 전달할 수 있습니다. 

• NonHeater 모델: 
  • [course1 설정값, course2 설정값, course3 설정값, course4 설정값] 
• Heater 모델: 
  • [course1 설정값, course2 설정값, course3 설정값, course4 설정값, course5 설정값, course6 설정값] 

예를 들어, NonHeater 모델의 경우 설정값이 [1, 1, 4, 4]라면, 다음을 의미합니다.

• 1번 코스 설정값=1, 2번 코스 설정값=1, 3번 코스 설정 값=4, 4번 코스 설정 값=4

RatingMoney

국가별 금액을 표기하기 위해 사용되는 값으로, 국가 혹은 지역별로 다음과 같은 고정된 값을 가집니다.

• Europe: 5
• Australia: 5
• America: 5
• China: 1
• Korea: 100
• Japan: 100
• Philippines: 5

Parameter (Washer)

Location	Name		Required	Type	Description	Default	Example
Header	Common Header		Mandatory	-	-		-
Path	device-id		Mandatory	String	기기 ID		07dcf5b1-fd14-104d-8d6a-203dbdb9b139
Body	request
	└	washingTime	Mandatory	list	코스별 세탁 시간 데이터값은 list로 전달함 NontHeater 모델 : [course1, course2, course3, course4] Heater 모델 : [course1, course2, course3, course4, course5, course6]  데이터 범위 NonHeater 범위: 5 ~ 15 Heater 범위: 0 ~ 30	NonHeater: 8 Heater: 20	NonHeater : [10, 11, 8, 7] Heater : [10, 11, 8, 7, 8, 7]
	└	waterLevel	Mandatory	list	코스별 수위로, 다음 값 사용 1: Low 2: Middle 3: High 데이터값은 list로 전달함 NonHeater 모델: [course1, course2, course3, course4]  Heater 모델: [course1, course2, course3, course4, , course5, course6]	1	NonHeater :  [1, 1, 1, 1] Heater :  [1, 1, 1 ,1, 1, 1]
	└	rinsingTime	Mandatory	list	코스별 헹굼 시간 데이터 범위: 8~16  데이터값은 list로 전달함 NonHeater 모델: [course1, course2, course3, course4]  Heater 모델: [course1, course2, course3, course4, , course5, course6]	8	NonHeater:  [8, 8, 8, 8] Heater:  [8, 8, 8, 8, 8, 8]
	└	rinsingCount	Mandatory	list	코스별 헹굼 횟수  데이터 범위: 1~5 데이터값은 list로 전달함 NonHeater 모델: [course1, course2, course3, course4]  Heater 모델: [course1, course2, course3, course4, , course5, course6]	2	NonHeater: [2, 2, 2, 2] Heater: [2, 2, 2, 2, 2, 2]
	└	spinSpeed	Mandatory	list	코스별 탈수 MAX RPM 데이터 범위: 500 ~ 1000 (100단위) , Max 데이터값은 list로 전달함 NonHeater 모델: [course1, course2, course3, course4]  Heater 모델: [course1, course2, course3, course4, , course5, course6]	Max	NonHeater:  ['Max', 'Max', 'Max', 'Max'] Heater: ['Max', 'Max', 'Max', 'Max', 1000, 1000]
	└	dropCount	Mandatory	number	탈수 행정에서 탈수 중 UB에 의해 정지하는 횟수의 MAX Count로 설정된 횟수를 초과 하게되면 UE가 발생함 데이터 범위: 25~50	50	50
	└	twinSpray	Mandatory	String	Circulation Pump 옵션 사용 여부로, 다음 값을 사용함 '0': Disable '1': Enable	'0'	'0'
	└	price	Mandatory	list	코스별 가격 데이터 범위: 0 ~ 199 0으로 설정 시, defaultPrice의 가격과 동일하게 설정함을 의미함. defulatPrice: 모든 코스의 가격을 대표하는 가격을 의미함. 데이터값은 list로 전달하며, list의 첫 번째 가격은 defulatPrice임 NonHeater 모델: [defaultPrice, course1, course2, course3, course4]  Heater 모델: [defaultPrice, course1, course2, course3, course4, , course5, course6]   화폐 단위 가격 = priceⅹRatingMoney		[20, 25, 0, 0, 0]
	└	coin	Mandatory	number	최소 화폐 단위의 값으로, 국가 혹은 지역 별로 다음 값을 사용함 1: 한국/일본/중국/필리핀 2: 유렵 5: 북미/캐나다 20: 호주 최소 화폐 가격 = coinx RatingMoney	5	5
	└	addSuperWash	Mandatory	number	Add Super wash의 가격 데이터 범위: 0 ~ 199 화폐 단위 가격 = addSuperWashⅹRatingMoney	5	5

Parameter (Dryer)

Location	Name		Required	Type	Description	Default	Example
Header	Common Header		Mandatory	-	-		-
Path	device-id		Mandatory	String	기기 ID		07dcf5b1-fd14-104d-8d6a-203dbdb9b139
Body	request		Mandatory
	└	dryCycleTime	Mandatory	list	코스별 건조 시간 데이터 범위: 5~99 (1 단위) 데이터값은 list로 전달함 [course1, course2, course3, course4]	45	[45, 45, 45, 45]
	└	topOffTime	Mandatory	list	코스별 topOff 시간 데이터 범위: 1~99 (1단위) 데이터값은 list로 전달함 [course1, course2, course3, course4]	5	[5, 5, 5, 5]
	└	topOff	Mandatory	String	동작 중 건조 시간 추가 기능 활성화 여부 '0': Disable '1': Enable	'0'
	└	sensingDry	Mandatory	String	습도값을 보고 건조시간 자동 조절 하는 기능 활성화 여부 '0': Disable '1': Enable	'0'
	└	regularPrice	Mandatory	list	코스별 가격 데이터 범위: 0 ~ 199 0으로 설정시 defaultPrice의 가격과 동일하게 설정됨 defaultPrice: 모든 코스의 가격을 대표하는 가격 데이터값은 list로 전달하며, list의 첫 번째 값은 defaultPrice임 [defaultPrice, course1, course2, course3, course4]  화폐 단위 가격 = regularPriceⅹRatingMoney		[0, 20, 20, 20, 20]
	└	topOffPrice	Mandatory	number	topOff 설정시 코스별 가격 범위: 0 ~ 199 화폐 단위 가격 = topOffPrcieⅹRatingMoney		[10, 10, 10, 10]
	└	coin1	Mandatory	String	최소 화폐 단위의 값으로, 국가 혹은 지역 별로 다음 값을 사용함 1: 한국/일본/중국/필리핀 2: 유렵 5: 북미/캐나다 20: 호주 최소 화폐 가격 = coin1ⅹRatingMoney	5	5

응답

성공 

성공 시, resultCode가 정상 코드 (0000)로 리턴됩니다. 결과 데이터는 응답 메시지의 result에서 확인할 수 있습니다.

Name			Type	Required	Description
resultCode			string	Mandatory	결과 코드
result			dic	Mandatory	결과 메시지

실패

실패 시, resultCode에 에러 코드 값이 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.

Example

Request

[PUT] {{BASE_URL}}/devices/<device-id>/settings

#washer
{ 
  "request": {
    'washingTime': [10, 10, 10, 10],
    'waterLevel': [1, 1, 1, 1],
    'rinsingTime': [8, 8, 8, 8],
    'rinsingCount': [2, 2, 2, 2],
    'dropCount': 50,
    'twinSpray': '0',
    'price': [1, 1.5, 1.25, 1, 0.05],
    'coin': 0.25,
    'addSuperWash': 0.25,
    'nonStopRinsing': False,
    'spinSpeed': ['Max', 'Max', 'Max', 'Max']
  }
}

#dryer
{ 
  "request": {
    "dryCycleTime": [45, 45, 45, 45],
    "topOffTime": [5, 5, 5, 5],
    "topOff": "1",
    "sensingDry": "0",
    "regularPrice": [1, 0, 0, 0, 0],
    "topOffPrice": [0.25, 0.25, 0.25, 0.25],
    "coin1": 1.4
  }
}

Response

{
  "resultCode": "0000",
  "result": {}
}

 

[다중 기기] 기기 설정 수정

PUT {{BASE_URL}}/devices/settings

한 번에 여러 기기의 설정 정보를 수정합니다. (최대 20개) 

요청

코스별 설정값

코스별 설정값이 필요한 경우에는 list를 사용합니다.  

세탁기의 경우 NonHeater 모델은 4개의 코스를 제공하고, Heater 모델은 6개의 코스를 제공합니다. 따라서, 다음과 같이 코스별로 설정값을 전달할 수 있습니다. 

• NonHeater 모델: 
  • [course1 설정값, course2 설정값, course3 설정값, course4 설정값] 
• Heater 모델: 
  • [course1 설정값, course2 설정값, course3 설정값, course4 설정값, course5 설정값, course6 설정값] 

예를 들어, NonHeater 모델의 경우 설정값이 [1, 1, 4, 4]라면, 다음을 의미합니다.

• 1번 코스 설정값=1, 2번 코스 설정값=1, 3번 코스 설정 값=4, 4번 코스 설정 값=4

RatingMoney

국가별 금액을 표기하기 위해 사용되는 값으로, 국가 혹은 지역별로 다음과 같은 고정된 값을 가집니다.

• Europe: 5
• Australia: 5
• America: 5
• China: 1
• Korea: 100
• Japan: 100
• Philippines: 5

Parameter (Washer)

Location	Name		Required	Type	Description	Default	Example
Header	Common Header		Mandatory	-	-		-
Path	device-id		Mandatory	String	기기 ID		07dcf5b1-fd14-104d-8d6a-203dbdb9b139
Body	request		Mandatory	list
	└	washingTime	Mandatory	list	코스별 세탁 시간 데이터 범위 NonHeater 모델: 5 ~ 15 Heater 모델: 0 ~ 30 데이터값은 list로 전달함 NontHeater 모델 : [course1, course2, course3, course4] Heater 모델 : [course1, course2, course3, course4, course5, course6]	NonHeater: 8 Heater: 20	NonHeater : [10, 11, 8, 7] Heater : [10, 11, 8, 7, 8, 7]
	└	waterLevel	Mandatory	list	코스별 수위로, 다음 값 사용 1: Low 2: Middle 3: High 데이터값은 list로 전달함 NonHeater 모델: [course1, course2, course3, course4]  Heater 모델: [course1, course2, course3, course4, , course5, course6]	1	NonHeater :  [1, 1, 1, 1] Heater :  [1, 1, 1 ,1, 1, 1]
	└	rinsingTime	Mandatory	list	코스별 헹굼 시간 데이터 범위: 8~16  데이터값은 list로 전달함 NonHeater 모델: [course1, course2, course3, course4]  Heater 모델: [course1, course2, course3, course4, , course5, course6]	8	NonHeater:  [8, 8, 8, 8] Heater:  [8, 8, 8, 8, 8, 8]
	└	rinsingCount	Mandatory	list	코스별 헹굼 횟수  데이터 범위: 1~5 데이터값은 list로 전달함 NonHeater 모델: [course1, course2, course3, course4]  Heater 모델: [course1, course2, course3, course4, , course5, course6]	2	NonHeater: [2, 2, 2, 2] Heater: [2, 2, 2, 2, 2, 2]
	└	spinSpeed	Mandatory	list	코스별 탈수 MAX RPM 데이터 범위: 500 ~ 1000 (100단위) , Max 데이터값은 list로 전달함 NonHeater 모델: [course1, course2, course3, course4]  Heater 모델: [course1, course2, course3, course4, , course5, course6]	Max	NonHeater:  ['Max', 'Max', 'Max', 'Max'] Heater: ['Max', 'Max', 'Max', 'Max', 1000, 1000]
	└	dropCount	Mandatory	number	탈수 행정에서 탈수 중 UB에 의해 정지하는 횟수의 MAX Count로 설정된 횟수를 초과 하게되면 UE가 발생함 데이터 범위: 25~50	50	50
	└	twinSpray	Mandatory	String	Circulation Pump 옵션 사용 여부로, 다음 값을 사용함 '0': Disable '1': Enable	'0'	'0'
	└	price	Mandatory	list	코스별 가격 데이터 범위: 0 ~ 199 0으로 설정 시, defaultPrice의 가격과 동일하게 설정함을 의미함. defulatPrice: 모든 코스의 가격을 대표하는 가격을 의미함. 데이터값은 list로 전달하며, list의 첫 번째 가격은 defulatPrice임 NonHeater 모델: [defaultPrice, course1, course2, course3, course4]  Heater 모델: [defaultPrice, course1, course2, course3, course4, course5, course6]   화폐 단위 가격 = priceⅹRatingMoney		[20, 25, 0, 0, 0]
	└	coin	Mandatory	number	최소 화폐 단위의 값으로, 국가 혹은 지역 별로 다음 값을 사용함 1: 한국/일본/중국/필리핀 2: 유렵 5: 북미/캐나다 20: 호주 최소 화폐 가격 = coinx RatingMoney	5	5
	└	addSuperWash	Mandatory	number	Add Super wash의 가격 데이터 범위: 0 ~ 199 화폐 단위 가격 = addSuperWashⅹRatingMoney	5	5

Parameter (Dryer)

Location	Name		Required	Type	Description	Default	Example
Header	Common Header		Mandatory	-	-		-
Path	device-id		Mandatory	String	기기 ID		07dcf5b1-fd14-104d-8d6a-203dbdb9b139
Body	request		Mandatory
	└	dryCycleTime	Mandatory	list	코스별 건조 시간 데이터 범위: 5 ~ 99 (1 단위) 데이터값은 list로 전달함 [course1, course2, course3, course4]	45	[45, 45, 45, 45]
	└	topOffTime	Mandatory	list	코스별 topOff 시간 데이터 범위: 1 ~ 99 (1 단위) 데이터값은 list로 전달함 [course1, course2, course3, course4]	5	[5, 5, 5, 5]
	└	topOff	Mandatory	String	동작 중 건조 시간 추가 기능 활성화 여부 '0': Disable '1': Enable	'0'
	└	sensingDry	Mandatory	String	습도값을 보고 건조시간 자동 조절 하는 기능 활성화 여부 '0': Disable '1': Enable	'0'
	└	regularPrice	Mandatory	list	코스별 가격 데이터 범위: 0 ~ 199 0으로 설정시 defaultPrice의 가격과 동일하게 설정됨 defaultPrice: 모든 코스의 가격을 대표하는 가격 데이터값은 list로 전달하며, list의 첫 번째 값은 defaultPrice임 [defaultPrice, course1, course2, course3, course4]  화폐 단위 가격 = regularPriceⅹRatingMoney		[0, 20, 20, 20, 20]
	└	topOffPrice	Mandatory	number	topOff 설정시 코스별 가격 데이터 범위: 0 ~ 199 화폐 단위 가격 = topOffPrcieⅹRatingMoney		[10, 10, 10, 10]
	└	coin1	Mandatory	String	최소 화폐 단위의 값으로, 국가 혹은 지역 별로 다음 값을 사용함 1: 한국/일본/중국/필리핀 2: 유렵 5: 북미/캐나다 20: 호주 최소 화폐 가격 = coin1ⅹRatingMoney	5	5

응답

성공 

성공 시, resultCode가 정상 코드 (0000)로 리턴됩니다. 결과 데이터는 응답 메시지의 result에서 확인할 수 있습니다.

Name					Type	Required	Description
resultCode					string	Mandatory	결과 코드
result					dic	Mandatory	결과 메시지
└			success		list		성공한 deviceId리스트
└			fail		dic		실패한 디바이스에 대한 deviceId 및 에러 정보 리스트
			└	deviceId	string
			└	errCode	string
			└	errDescription	string

실패

실패 시, resultCode에 에러 코드 값이 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.

Example

Request

[PUT] {{ENDPOINT_URL}}/devices/settings
{
  "request": [{
      "deviceId": "4138737e7eb621c26138f89f60b646671b03cf30817a7f55a7eb1e0af4aa501e",
      "washingTime": [10, 10, 10, 10],
      "waterLevel": [1, 1, 1, 1],
      "rinsingTime": [8, 8, 8, 8],
      "rinsingCount": [2, 2, 2, 2],
      "dropCount": 50,
      "twinSpray": "0",
      "price": [0, 20, 15, 10, 5],
      "coin": 1,
      "addSuperWash": 5,
      "nonStopRinsing": false,
      "spinSpeed": ["Max", "Max", "Max", "Max"],
    },
    {
      "deviceId": "c7252179d34a3e61c706a559cc9d14ce799995ca310289b8523067721bca1a6d",
      "dryCycleTime": [45, 45, 45, 45],
      "topOffTime": [5, 5, 5, 5],
      "topOff": "1",
      "sensingDry": "0",
      "regularPrice": [20, 0, 0, 0, 0],
      "topOffPrice": [5, 5, 5, 5],
      "coin1": 5
    }
  ]
}

Response

{
    "resultCode": "0000",
    "result": {
        "success": [
            "4138737e7eb621c26138f89f60b646671b03cf30817a7f55a7eb1e0af4aa501e"
        ],
        "fail": [
            {
                "deviceId": "c7252179d34a3e61c706a559cc9d14ce799995ca310289b8523067721bca1ad",
                "errCode": "0101",
                "errDescription": "not registered device"
            }
        ]
    }
}

 

기기 기록 조회

GET {{BASE_URL}}/devices/<device-id>/history

기기 기록을 조회합니다.

요청

Parameter

Location	Name	Required	Type	Description	Example
Header	Common Header	Mandatory	-	-	-
Path	device-id	Mandatory	String	기기 ID	07dcf5b1-fd14-104d-8d6a-203dbdb9b139
Query	page	Mandatory	String	페이지 넘버
	pageSize	Mandatory	String	한 번에 불러올 데이터의 크기

응답

성공 

성공 시, resultCode가 정상 코드 (0000)로 리턴됩니다. 결과 데이터는 응답 메시지의 result에서 확인할 수 있습니다.

Name				Type	Required	Description	Example
resultCode				string	Mandatory	결과 코드
result				dict	Mandatory	결과 메시지
└	used			number		기기 사용 횟수
└	page			dic
	└		pageSize	number		페이지 사이즈
	└		total	number		총 페이지 수
	└		curPage	number		현재 페이지
└	hitory			list		이력 리스트
	└		event	string		발생한 이벤트	POWEROFF : 0
	└		date	string		발생한 날짜
	└		type	string		타입 (일반 이벤트 혹은 이벤트)	S, E
	└		detail	string		설명

실패

실패 시, resultCode에 에러 코드 값이 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.

Example

Request

[GET] {{BASE_URL}}/devices/<device-id>/history?page=1&pageSize=10

Response

{
  "resultCode": "0000",
  "result": {
    "page": {
      "pageSize": 15,
      "total": 2,
      "curPage": 2
    },
    "history": [{
        "event": "{'2': 'Cooling'}",
        "date": "2017-12-08 16:43:54",
        "type": "S",
        "detail": ""
      },
      {
        "event": "{'4': 'End'}",
        "date": "2017-12-08 15:19:32",
        "type": "S",
        "detail": ""
      }
    ]
  }
}

 

기기 에러 조회

GET {{BASE_URL}}/devices/<device-id>/diagnosis

기기 에러 정보를 조회합니다.

요청

Parameter

Location	Name	Required	Type	Description	Example
Header	Common Header	Mandatory	-	-	-
Path	device-id	Mandatory	String	기기 ID	07dcf5b1-fd14-104d-8d6a-203dbdb9b139

응답

성공 

성공 시, resultCode가 정상 코드 (0000)로 리턴됩니다. 결과 데이터는 응답 메시지의 result에서 확인할 수 있습니다.

Name			Type	Required	Description
resultCode			string	Mandatory	결과 코드
result			list	Mandatory	결과 메시지
└	todo		string		에러 해결을 위해 할 수 있는 일의 리스트
└	code		string		에러 코드
└	date		string		에러 발생 날짜

실패

실패 시, resultCode에 에러 코드 값이 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.

Example

Request

[GET] {{BASE_URL}}/devices/<device-id>/diagnosis 

Response

{
  "resultCode": "0000",
  "result": [{
      "todo": "",
      "code": "{'17': 'DE1:Door Open Error'}",
      "date": "2017-08-24 06:31:38"
    },
    {
      "todo": "",
      "code": "{'17': 'DE1:Door Open Error'}",
      "date": "2017-08-24 06:31:36"
    }
  ]
}

 

기기 예약

POST {{BASE_URL}}/devices/<device-id>/reserve

다른 사용자가 기기를 사용하지 못하도록 기기를 예약합니다.  

요청

Parameter

Location	Name		Required	Type	Description	Example
Header	Common Header		Mandatory	-	-	-
Path	device-id		Mandatory	String	기기 ID	07dcf5b1-fd14-104d-8d6a-203dbdb9b139
Body	request
	└	time	Mandatory	number	기기 예약 시간 (단위: sec)	30

응답

성공 

성공 시, resultCode가 정상 코드 (0000)로 리턴됩니다. 결과 데이터는 응답 메시지의 result에서 확인할 수 있습니다

Name			Type	Required	Description
resultCode			string	Mandatory	결과 코드
result			dict	Mandatory	결과 메시지

실패

실패 시, resultCode에 에러 코드 값이 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.

Example

Request

 [POST] {{BASE_URL}}/devices/<device-id>/reserve
{
  "request": {
    "time": 30,
  }
}

Response

 {
  "resultCode": "0000",
  "result": {}
}

 

기기 예약 해제

DELETE {{BASE_URL}}/devices/<device-id>/reserve

기기 예약을 해제합니다.

요청

Parameter

Location	Name	Required	Type	Description	Example
Header	Common Header	Mandatory	-	-	-
Path	device-id	Mandatory	String	기기 ID	07dcf5b1-fd14-104d-8d6a-203dbdb9b139

응답

성공 

성공 시, resultCode가 정상 코드 (0000)로 리턴됩니다. 결과 데이터는 응답 메시지의 result에서 확인할 수 있습니다.   

Name			Type	Required	Description
resultCode			string	Mandatory	결과 코드
result			dict	Mandatory	결과 메시지

실패

실패 시, resultCode에 에러 코드 값이 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.

Example

Request

 [DELETE] {{BASE_URL}}/devices/<device-id>/reserve

Response

{
  "resultCode": "0000",
  "result": {}
}