Device API

Basic Information

BaseURL

Phase	KIC	AIC	EIC	Description
OP	https://kic-laundry-ext.lgthinq.com	https://aic-laundry-ext.lgthinq.com	https://eic-laundry-ext.lgthinq.com	Operation
QA	https://kic-laundry-ext-qa.lgthinq.com	https://aic-laundry-ext-qa.lgthinq.com	https://eic-laundry-ext-qa.lgthinq.com	Development & Test

API List

API	Method	End-point	Response Format	Summary
Get device list	GET	{{BASE_URL}}/devices	JSON	Retrieve the device list.
Locate device (Beep)	POST	{{BASE_URL}}/devices/<device-id>/find	JSON	Make a beep sound on the machine to help it to be found.
Prepare device for use (Courtesy)	POST	{{BASE_URL}}/devices/<device-id>/courtesy	JSON	Prepare the device for use without making a payment. (Courtesy)
Prepare device for use	POST	{{BASE_URL}}/devices/<device-id>/ready	JSON	Prepare the device for use after making a payment. (Paid)
Stop device operation	POST	{{BASE_URL}}/devices/<device-id>/reset	JSON	Stop the device operation.
Get device information	GET	{{BASE_URL}}/devices/<device-id>	JSON	Retrieve the device information.
Update device information	PUT	{{BASE_URL}}/devices/<device-id>	JSON	Update the device information.
[Multiple devices] Update device information	PUT	{{BASE_URL}}/devices/info	JSON	Update the information of multiple devices at once.
Get device settings	GET	{{BASE_URL}}/devices/<device-id>/settings	JSON	Retrieve the device settings.
Put device settings	PUT	{{BASE_URL}}/devices/<device-id>/settings	JSON	Update the device settings.
[Multiple devices] Update device settings	PUT	{{BASE_URL}}/devices/settings	JSON	Update the settings of multiple devices at once.
Get device usage history	GET	{{BASE_URL}}/devices/<device-id>/history	JSON	Retrieve the device usage history.
Get device errors	GET	{{BASE_URL}}/devices/<device-id>/diagnosis	JSON	Retrieve the device errors.
Reserve device	POST	{{BASE_URL}}/devices/<device-id>/reserve	JSON	Reserve the device.
Cancel device reservation	DELETE	{{BASE_URL}}/devices/<device-id>/reserve	JSON	Cancel the device reservation.

Get Device List

GET {{BASE_URL}}/devices

Retrieve the device list.

Request

Parameter

Location	Name	Required	Type	Description	Default	Example
Header	Common Header	Mandatory	-	-		-
Query	searchType	Optional	String	Specifies the type of information to be queried. If not entered: returns a list of all devices (Operates the same as the default) `info`: returns a list of all devices (default) `reserved`: Returns only the list of reserved devices `ready`: returns only the list of devices in the ready state	info	reserved , ready, info
	additionalInfo	Optional	String	Specifies additional information to be queried. Enter separated by ','. `detail`: Device details `history`: Device history data (last 10 times) `error`: Device error data (last 10 times) `settings`: Device setting values	None	detail, history, error, settings
	ids	Optional	String	The deviceId list to be queried If not entered, all devices are queried. Up to 100 devices are requested.	None	1, 2, 3, 4

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name			Type	Required	Description	Default	Example
resultCode			string	Mandatory	Result code		0000
result			list		Result message
└	deviceId		string	Mandatory	Device ID		87e9f680-7117-11d3-b015-0051edb754a8
└	deviceStatus		string	Mandatory	Device status		E
└	modelNm		string	Mandatory	Model name		FH069FD_T
└	deviceType		string	Mandatory	Device type		211
└	status		string	Optional	Reserved (`reserved`) or ready to use (`ready`)		reserved, ready
└	expirationTime		string	Optional	Used only when `reserved` Reservation expiration time (UTC), the time may vary depending on the server situation.		2021-02-25, 03:44:35
└	detail		dict	Optional
	└	alias	string	Optional	Device name
	└	online	boolean	Optional	Whether the device is connected to the server		true
	└	ssid	string	Optional	ssid with internet connection		test
	└	error	string	Optional	Error condition `ERROR_NO` means no error	ERRROR_NO	ERRROR_NO
	└	state	string	Optional	Operating state	POWEROFF	POWEROFF
	└	course	string	Optional	Operating course	NOT_SELECTED	NOT_SELECTED
	└	remain	number	Optional	Time remaining	0	0
	└	reservable	boolean	Optional	Whether the device can be booked or not		true, false
	└	payable	boolean	Optional	Whether the device can be paide or not		true, false
└	history		list	Optional
	└	event	string	Optional	The event that occurred		POWEROFF : 0
	└	date	string	Optional	Date of occurrence
	└	type	string	Optional	Type (general event or event)		S, E
	└	detail	string	Optional	Description
└	error		list	Optional
	└	todo	string	Optional	List of things that can be done to troubleshoot the error
	└	code	string	Optional	Error code
	└	date	string	Optional	Date of error occurrence
	└	detail	string	Optional	Error code explanation
└	settings		dict	Optional
	└	washingTime	list	Optional	Washing time by course 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	Water level by course 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	Rinse time by course The data range: 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	Number of rinses per course The data range: 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	Spinning MAX RPM for each course The data range: 500 ~ 1000, Max (100 units) 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	The UE occurs when the MAX Count for the number of stops by UB during dehydration is exceeded. The data range: 25~50	50	50
	└	twinSprary	string	Optional	Whether to use the Circulation Pump option ‘0’: Disable ‘1’: Enable	‘0’	‘0’
	└	price	list	Optional	Price by course The data range: 0 - 199 When set to 0, it is set the same as the defaultPrice price. defaultPrice: represents the price of all courses. Monetary price 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	The value of the minimum currency unit 1: Korea/Japan/China/Philippines 2: Europe 5: North America/Canada 20: Australia Minimum monetary price coin x RatingMoney	5	5
	└	addSuperWash	number	Optional	The price of Add Super Wash The data range: 0 - 199. Monetary price addSuperWash x RatingMoney	5	5
	└	dryCycleTime	list	Optional	Drying time by course The data range: 5~99 (1 unit) [course1 value, course2 value, course3 value, course4 value]	45	[45, 45, 45, 45]
	└	topOffTime	list	Optional	Topoff time by course The data range: 1 ~99 (1 unit) [course 1 value, course 2 value, course 3 value, course 4 value]	5	[5, 5, 5, 5]
	└	topOff	string	Optional	Whether to activate the function to add drying time during operation '0': Disable '1': Enable	‘0’
	└	sensingDry	string	Optional	Whether to activate the function to automatically adjust the drying time based on the humidity value '0': Disable '1': Enable
	└	regularPrice	list	Optional	Price by course The data range is 0 ~ 199 When set to 0, it is set the same as the defaultPrice price. defaultPrice: represents the price of all courses. Monetary price: regularPriceⅹRatingMoney [defaultPrice, course1 value, course2 value, course3 value, course4 value]		[20, 0, 0, 0, 0]
	└	topOffPrice	list	Optional	Price by course when topOff is set		[10, 10, 10, 10]
	└	coin1	number	Optional	The value of the minimum currency unit 1: Korea/Japan/China/Philippines 2: Europe 5: North America/Canada 20: Australia Minimum monetary price coin1x RatingMoney	5	5

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to 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
    }
  }]
}

Locate Device (Beep)

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

Make a beep sound on the machine so that users can find it.

Request

Parameter

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

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name			Type	Required	Description
resultCode			string	Mandatory	Result Code
result			dict	Mandatory	Result Message

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to Common Response.

Example

Request

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

Response

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

Prepare Device for Use (Courtesy)

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

Prepare the device for use without making a payment.

Request

Parameter

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

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name			Type	Required	Description
resultCode			string	Mandatory	Result Code
result			dict	Mandatory	Result Message

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to Common Response.

Example

Request

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

Response

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

Prepare Device for Use

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

Prepare the device for use after making a payment. (Paid)

Request

Parameter

Location	Name		Required	Type	Description	Example
Header	Common Header		Mandatory	-	-	-
Path	device-id		Mandatory	String	The ID of the target device	07dcf5b1-fd14-104d-8d6a-203dbdb9b139
Body	request
Body	└	paymentMoney	Mandatory	number	The amount paid

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name			Type	Required	Description
resultCode			string	Mandatory	Result Code
result			string	Mandatory	Result Message

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to Common Response.

Example

Request

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

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

Response

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

Stop Device Operation

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

Stop device operation.

When the device encounters a problem, you must first stop the operation with this API before using it again.

Request

Parameter

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

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name			Type	Required	Description
resultCode			string	Mandatory	Result code
result			dict	Mandatory	Result Message

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to Common Response.

Example

Request

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

Response

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

javascript:clickedButton = true;$('#ccm-form-submit-button').get(0).click()

Get Device Information

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

Retrieve the device information.

You can check the price needed for device payment when calling this API after course selection.

Request

Parameter

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

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name		Type	Required	Description	Example
resultCode		string	Mandatory	Result Code	0000
result		dict		Result Message
└	deviceId	string	Mandatory	Device ID	87e9f680-7117-11d3-b015-0051edb754a8
└	deviceStatus	string	Mandatory	Device status	E
└	modelNm	string	Mandatory	Model name	FH069FD_T
└	deviceType	string	Mandatory	Device type	211
└	status	string	Optional	Reserved (`reserved`) or ready to use (`ready`)	reserved, ready
└	expirationTime	string	Optional	Used only when `reserved` Reservation expiration time (UTC), the time may vary depending on the server situation.	2021-02-25, 03:44:35
└	detail	dict	Optional
└	alias	string	Optional	Device name
└	online	boolean	Optional	Whether the device is connected to the server	true
└	ssid	string	Optional	ssid with internet connection	test
└	error	string	Optional	Error condition `ERROR_NO` means no error	ERRROR_NO
└	state	string	Optional	Operating state	POWEROFF
└	course	string	Optional	Operating course	NOT_SELECTED
└	remain	number	Optional	Time remaining	0
└	reservable	boolean	Optional	Whether the device can be booked or not	true, false
└	payable	boolean	Optional	Whether the device can be paide or not	true, false

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to Common Response.

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"
  }

Update Device Information

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

Update the device information.

Request

Parameter

Location	Name		Required	Type	Description	Example
Header	Common Header		Mandatory	-	-	-
Path	device-id		Mandatory	String	The ID of the target device	07dcf5b1-fd14-104d-8d6a-203dbdb9b139
Body	request
Body	└	nickName	Optional	String	Nickname to change	-

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name				Type	Required	Description	Example
resultCode				string	Mandatory	Result code	0000
result				dict		Result message

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to Common Response.

Example

Request

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

{
  "request": {
    "nickNAme": "1111"
  }
}
 
{
  "request": {
    "ssid": "2222"
}

Response

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

[Multiple Devices] Update Device Information

PUT {{BASE_URL}}/devices/info

Update information of multiple devices at once. (up to 20 devices at a time)

Request

Parameter

Location	Name		Required	Type	Description	Example
Header	Common Header		Mandatory	-	-	-
Body	request
	└	deviceId		String	deviceId	-
	└	nickName	Optional	String	Nickname to change	-

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name		Type	Required	Description
resultCode		string	Mandatory	Result Code
result		dict	Mandatory	Result Message
└	success	list		List of `deviceId` for the successful devices
└	fail	list		List of `deviceId` and error information for the failed devices

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to Common Response.

Example

Request

[PUT] {{BASE_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 Device Settings

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

Retrieve the device settings.

Request

Parameter

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

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Settings for each course

For a washer, there are two types; heater model and nonheater model. The former provides 6 courses, while the latter provides 4 courses.

Use list as a factor to differentiate settings by course.

For example, NonHeater model has the setting value is [1, 1, 4, 4], it means as follows:

course1 settings = 1, course2 settings = 1, course3 settings = 4, course4 settings = 4

RatingMoney

When viewing price, RatingMoney in description is the value to mark the amount by country and has a fixed value by country (region).

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

When calculating monetary prices, refer to the RatingMoney value.

Name		Type	Required	Description	Default	Example
resultCode		string	Mandatory	Result Code	-	-
result		dic	Mandatory	Result Message	-	-
└	washingTime	list	Optional	Washing time by course Data values are delivered as a list for each course NontHeater model: [course1, course2, course3, course4] Heater model: [course1, course2, course3, course4, course5, course6]	8	NontHeater Model: [10, 11, 8, 7] Heater Model: [5, 5, 8, 7, 11, 11]
└	waterLevel	list	Optional	Water level by course Must be entered one of the following values: 1: Low 2: Middle 3: High Data values are delivered as a list for each course NontHeater model: [course1, course2, course3, course4] Heater model: [course1, course2, course3, course4, course5, course6]	1	NontHeater Model: [1, 1, 1, 1] Heater Model: [1, 1, 1, 1, 1, 1]
└	rinsingTime	list	Optional	Rinse time by course Data range: 8~16 Data values are delivered as a list for each course NontHeater model: [course1, course2, course3, course4] Heater model: [course1, course2, course3, course4, course5, course6]	8	NontHeater Model: [8, 8, 8, 8] Heater Model: [8, 8, 8, 8, 8, 8]
└	rinsingCount	list	Optional	Rinsing counts by course Data range: 1~5 Data values are delivered as a list for each course NontHeater model: [course1, course2, course3, course4] Heater model: [course1, course2, course3, course4, course5, course6]	2	NontHeater Model: [1, 1, 1, 1] Heater Model: [1, 1, 1, 1, 1, 1]
└	spinSpeed	list	Optional	Spinning MAX RPM for each course Data range: 500 ~ 1000 (100 units), Max Data values are delivered as a list for each course NontHeater model: [course1, course2, course3, course4] Heater model: [course1, course2, course3, course4, course5, course6]	Max	NontHeater Model: ['Max', 'Max', 'Max', 'Max'] Heater Model: ['Max', 'Max', 'Max', 'Max', 'Max', 'Max']
└	dropCount	number	Optional	UE occurs when the number of times set by MAX Count of the number of stops by UB is exceeded during spin-dry Data range: 25-50	50	50
└	twinSpray	string	Optional	Whether to use the Circulation Pump option, use the following values: '0' : Disable '1': Enable	'0'	'0'
└	price	list	Optional	Price by course Data range: 0 ~ 199 When set to 0, it means that all prices are set the same as defaultPrice defaultPrice: represents the price of all courses. The data value is delivered as a list for each course, and the first in the list is defulatPrice. NonHeater Model: [defaultPrice, course1, course2, course3, course4] Heater Model: [defaultPrice, course1, course2, course3, course4, , course5, course6] Monetary price = `price`ⅹRatingMoney	-	NonHeater: [20, 0, 0, 0, 30] Heater: [20, 0, 0, 0, 0, 0, 30]
└	coin	number	Optional	The value of the minimum currency unit Use the following values for each country or region: 1: Korea/Japan/China/Philippines 2: Europe 5: North America/Canada 20: Australia Minimum Monetary price = `coin`x RatingMoney	5	5
└	addSuperWash	number	Optional	The price of Add Super Wash Data range: 0 ~199 Monetary price = `addSuperWash`ⅹRatingMoney	5	5
└	dryCycleTime	list	Optional	Drying time by course Data values are delivered as a list for each course. [course1, course2, course3, course4]	45	[45, 45, 45, 45]
└	topOffTime	list	Optional	Topoff time by course Data range: 1~99 (1unit) Data values are delivered as a list for each course. [course1, course2, course3, course4]	5	[5, 5, 5, 5]
└	topOff	string	Optional	Whether to activate the additional drying time function during operation '0': Disable '1': Enable	'0'
└	sensingDry	string	Optional	Whether to activate the function to automatically adjust the drying time based on the humidity value '0': Disable '1': Enable	'0'
└	regularPrice	list	Optional	Price by course Data range: 0 ~ 199 When set to 0, it means that all prices are set the same as defaultPrice. defulatPrice: represents the price of all courses The data value is delivered as a list for each course, and the first in the list is defulatPrice. [defaultPrice, course1, course2, course3, course4] Monetary price = `regularPrice`ⅹRatingMoney	-	[20, 0, 0, 0, 0]
└	topOffPrice	list	Optional	topOff Price for each course	-	[10, 10, 10, 10]
└	coin1	number	Optional	The value of the minimum currency unit Use the following values for each country or region: 1: Korea/Japan/China/Philippines 2: Europe 5: North America/Canada 20: Australia	5	5

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to 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": 5,
    "addSuperWash": 0.25,
  }
}

{ // dryer
  "resultCode": "0000",
  "result": {
    "dryCycleTime": [45, 45, 45, 45],
    "topOffTime": [5, 5, 5, 5],
    "topOff": "1",
    "sensingDry": "0",
    "regularPrice": [30, 0, 0, 0, 40],
    "topOffPrice": [10, 10, 10, 10],
    "coin1": 5
  }
}

Update Device Settings

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

Update the device settings.

Request

Settings for each course

If you need set values for each course, use the list.

In the case of a washer, NonHeater models have four courses, and Heater models have six courses. Therefore, you can pass the set value for each course as follows.

For NonHeater models:
- [course1 settings, course2 settings, course3 settings, course4 settings]
For Heater model:
- [course1 settings, course2 settings, course3 settings, course4 settings, course5 settings, course6 settings]

For example, NonHeater model has the setting value is [1, 1, 4, 4], it means as follows:

course 1 settings = 1/ course 2 settings = 1/ course 3 settings = 4/ course 4 settings = 4

RatingMoney

This value is used to display the monetary amount by country and is fixed for each country or region as follows:

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

When calculating monetary prices, refer to the RatingMoney value.

Parameter (Washer)

Location	Name		Required	Type	Description	Default	Example
Header	Common Header		Mandatory	-	-		-
Path	device-id		Mandatory	String	The ID of the target device		07dcf5b1-fd14-104d-8d6a-203dbdb9b139
Body	request
	└	washingTime	Mandatory	list	Washing time by course Data values are delivered as a list for each course NontHeater model: [course1, course2, course3, course4] Heater model: [course1, course2, course3, course4, course5, course6] Data range NonHeater Model: 5 ~15 Heater Model: 0 ~ 30	NonHeater: 8 Heater: 20	NonHeater: [10, 11, 8, 7] Heater: [10, 11, 8, 7, 8, 7]
	└	waterLevel	Mandatory	list	Water level by course, Use one of the following values: 1: Low 2: Middle 3: High Data values are delivered as a list for each course NontHeater model: [course1, course2, course3, course4] Heater model: [course1, course2, course3, course4, course5, course6]	1	NonHeater: [1, 1, 1, 1] Heater: [1, 1, 1 ,1, 1, 1]
	└	rinsingTime	Mandatory	list	Rinse time by course Data range: 8~16 Data values are delivered as a list for each course NontHeater model: [course1, course2, course3, course4] Heater model: [course1, course2, course3, course4, course5, course6]	8	NonHeater: [8, 8, 8, 8] Heater: [8, 8, 8, 8, 8, 8]
	└	rinsingCount	Mandatory	list	Rinsing counts by course Data range: 1~5 Data values are delivered as a list for each course NontHeater model: [course1, course2, course3, course4] Heater model: [course1, course2, course3, course4, course5, course6]	2	NonHeater: [2, 2, 2, 2] Heater: [2, 2, 2, 2, 2, 2]
	└	spinSpeed	Mandatory	list	Spinning MAX RPM for each course Data range: 500 ~ 1000 (100 units), Max Data values are delivered as a list for each course NontHeater model: [course1, course2, course3, course4] Heater model: [course1, course2, course3, course4, course5, course6]	Max	NonHeater: ['Max', 'Max', 'Max', 'Max'] Heater: ['Max', 'Max', 'Max', 'Max', 1000, 1000]
	└	dropCount	Mandatory	number	UE occurs when the number of times set by MAX Count of the number of stops by UB is exceeded during spin-dry Data range: 25-50	50	50
	└	twinSpray	Mandatory	String	Whether to use the Circulation Pump option, use the following values: '0': Disable '1': Enable	'0'	'0'
	└	price	Mandatory	list	Price by course Data range: 0 ~ 199 When set to 0, it means that all prices are set the same as defaultPrice. defulatPrice: represents the price of all courses. The data value is delivered as a list for each course, and the first in the list is defulatPrice. NonHeater Model: [defaultPrice, course1, course2, course3, course4] Heater Model: [defaultPrice, course1, course2, course3, course4, course5, course6] Monetary price = `price`ⅹRatingMoney		[20, 25, 0, 0, 0]
	└	coin	Mandatory	number	The value of the minimum currency unit Use the following values for each country or region: 1: Korea/Japan/China/Philippines 2: Europe 5: North America/Canada 20: Australia Minimum monetary price = `coin`x RatingMoney	5	5
	└	addSuperWash	Mandatory	number	The price of Add Super Wash Data range: 0 - 199 Monetary price = `addSuperWash`ⅹRatingMoney	5	5

Parameter (Dryer)

Location	Name		Required	Type	Description	Default	Example
Header	Common Header		Mandatory	-	-		-
Path	device-id		Mandatory	String	The ID of the target device		07dcf5b1-fd14-104d-8d6a-203dbdb9b139
Body	request		Mandatory
	└	dryCycleTime	Mandatory	list	Drying time by course Data range: 5~99 (1 unit) Data values are delivered as a list for each course. [course1, course2, course3, course4]	45	[45, 45, 45, 45]
	└	topOffTime	Mandatory	list	Topoff time by course Data range: 1~99 (1unit) Data values are delivered as a list for each course. [course1, course2, course3, course4]	5	[5, 5, 5, 5]
	└	topOff	Mandatory	String	Whether to activate the additional drying time function during operation '0': Disable '1': Enable	'0'
	└	sensingDry	Mandatory	String	Whether to activate the function to automatically adjust the drying time based on the humidity value '0': Disable '1': Enable	'0'
	└	regularPrice	Mandatory	list	Price by course Data range: 0 ~ 199 When set to 0, it means that all prices are set the same as defaultPrice. defulatPrice: represents the price of all courses. The data value is delivered as a list for each course, and the first in the list is defulatPrice. [defaultPrice, course1, course2, course3, course4] Monetary price = `regularPrice`ⅹRatingMoney		[0, 20, 20, 20, 20]
	└	topOffPrice	Mandatory	number	topOff Price for each course Data range: 0 ~ 199 Monetary price = `topOffPrcie`ⅹRatingMoney		[10, 10, 10, 10]
	└	coin1	Mandatory	String	The value of the minimum currency unit Use the following values for each country or region: 1: Korea/Japan/China/Philippines 2: Europe 5: North America/Canada 20: Australia Minimum monetary price = `coin1`ⅹRatingMoney	5	5

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name			Type	Required	Description
resultCode			string	Mandatory	Result Code
result			dic	Mandatory	Result Message

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to 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": {}
}

[Multiple Devices] Update Device Settings

PUT {{BASE_URL}}/devices/settings

Update settings of multiple devices at once. (up to 20 devices at a time)

Request

Settings for each course

If you need set values for each course, use the list.

In the case of a washer, NonHeater models have four courses, and Heater models have six courses. Therefore, you can pass the set value for each course as follows.

For NonHeater models:
- [course1 settings, course2 settings, course3 settings, course4 settings]
For Heater model:
- [course1 settings, course2 settings, course3 settings, course4 settings, course5 settings, course6 settings]

For example, NonHeater model has the setting value is [1, 1, 4, 4], it means as follows:

course 1 settings = 1/ course 2 settings = 1/ course 3 settings = 4/ course 4 settings = 4

RatingMoney

This value is used to display the monetary amount by country and is fixed for each country or region as follows:

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

When calculating monetary prices, refer to the RatingMoney value.

Parameter (Washer)

Location	Name		Required	Type	Description	Default	Example
Header	Common Header		Mandatory	-	-		-
Path	device-id		Mandatory	String	The ID of the target device		07dcf5b1-fd14-104d-8d6a-203dbdb9b139
Body	request
	└	washingTime	Mandatory	list	Washing time by course Data range NonHeater Model: 5 ~15 Heater Model: 0 ~ 30 Data values are delivered as a list for each course NontHeater model: [course1, course2, course3, course4] Heater model: [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	Water level by course, Use one of the following values: 1: Low 2: Middle 3: High Data values are delivered as a list for each course NontHeater model: [course1, course2, course3, course4] Heater model: [course1, course2, course3, course4, course5, course6]	1	NonHeater: [1, 1, 1, 1] Heater: [1, 1, 1 ,1, 1, 1]
	└	rinsingTime	Mandatory	list	Rinse time by course Data range: 8~16 Data values are delivered as a list for each course NontHeater model: [course1, course2, course3, course4] Heater model: [course1, course2, course3, course4, course5, course6]	8	NonHeater: [8, 8, 8, 8] Heater: [8, 8, 8, 8, 8, 8]
	└	rinsingCount	Mandatory	list	Rinsing counts by course Data range: 1~5 Data values are delivered as a list for each course NontHeater model: [course1, course2, course3, course4] Heater model: [course1, course2, course3, course4, course5, course6]	2	NonHeater: [2, 2, 2, 2] Heater: [2, 2, 2, 2, 2, 2]
	└	spinSpeed	Mandatory	list	Spinning MAX RPM for each course Data range: 500 ~ 1000 (100 units), Max Data values are delivered as a list for each course NontHeater model: [course1, course2, course3, course4] Heater model: [course1, course2, course3, course4, course5, course6]	Max	NonHeater: ['Max', 'Max', 'Max', 'Max'] Heater: ['Max', 'Max', 'Max', 'Max', 1000, 1000]
	└	dropCount	Mandatory	number	UE occurs when the number of times set by MAX Count of the number of stops by UB is exceeded during spin-dry Data range: 25-50	50	50
	└	twinSpray	Mandatory	String	Whether to use the Circulation Pump option, use the following values: '0': Disable '1': Enable	'0'	'0'
	└	price	Mandatory	list	Price by course Data range: 0 ~ 199 When set to 0, it means that all prices are set the same as defaultPrice. defulatPrice: represents the price of all courses. The data value is delivered as a list for each course, and the first in the list is defulatPrice. NonHeater Model: [defaultPrice, course1, course2, course3, course4] Heater Model: [defaultPrice, course1, course2, course3, course4, course5, course6] Monetary price = `price`ⅹRatingMoney		[20, 25, 0, 0, 0]
	└	coin	Mandatory	number	The value of the minimum currency unit Use the following values for each country or region: 1: Korea/Japan/China/Philippines 2: Europe 5: North America/Canada 20: Australia Minimum monetary price = `coin`x RatingMoney	5	5
	└	addSuperWash	Mandatory	number	The price of Add Super Wash Data range: 0 - 199 Monetary price = `addSuperWash`ⅹRatingMoney	5	5

Parameter (Dryer)

Location	Name		Required	Type	Description	Default	Example
Header	Common Header		Mandatory	-	-		-
Path	device-id		Mandatory	String	The ID of the target device		07dcf5b1-fd14-104d-8d6a-203dbdb9b139
Body	request		Mandatory
	└	dryCycleTime	Mandatory	list	Drying time by course Data range: 5 ~ 99 (1 unit) Data values are delivered as a list for each course. [course1, course2, course3, course4]	45	[45, 45, 45, 45]
	└	topOffTime	Mandatory	list	Topoff time by course Data range: 1 ~ 99 (1unit) Data values are delivered as a list for each course. [course1, course2, course3, course4]	5	[5, 5, 5, 5]
	└	topOff	Mandatory	String	Whether to activate the additional drying time function during operation '0': Disable '1': Enable	'0'
	└	sensingDry	Mandatory	String	Whether to activate the function to automatically adjust the drying time based on the humidity value '0': Disable '1': Enable	'0'
	└	regularPrice	Mandatory	list	Price by course Data range: 0 ~ 199 When set to 0, it means that all prices are set the same as defaultPrice. defulatPrice: represents the price of all courses. The data value is delivered as a list for each course, and the first in the list is defulatPrice. [defaultPrice, course1, course2, course3, course4] Monetary price = `regularPrice`ⅹRatingMoney		[0, 20, 20, 20, 20]
	└	topOffPrice	Mandatory	number	topOff Price for each course Data range: 0 ~ 199 Monetary price = `topOffPrcie`ⅹRatingMoney		[10, 10, 10, 10]
	└	coin1	Mandatory	String	The value of the minimum currency unit Use the following values for each country or region: 1: Korea/Japan/China/Philippines 2: Europe 5: North America/Canada 20: Australia Minimum monetary price = `coin1`ⅹRatingMoney	5	5

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name			Type	Required	Description
resultCode			string	Mandatory	Result Code
result			dic	Mandatory	Result Message
└	success		list		List of `deviceId` for the successful devices
└	fail		dic		List of `deviceId` and error information for the failed devices
	└	deviceId	string
	└	errCode	string
	└	errDescription	string

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to Common Response.

Example

Request

[PUT] {{BASE_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 Device Usage history

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

Retrieve the device records.

Request

Parameter

Location	Name	Required	Type	Description	Default	Example
Header	Common Header	Mandatory	-	-		-
Path	device-id	Mandatory	String	The ID of the target device		07dcf5b1-fd14-104d-8d6a-203dbdb9b139
Query	startDate	Optional	String	If there are startDate and endDate, use prior to page and pageSize.		2021-06-25
	endDate	Optional	String	If there are startDate and endDate, use prior to page and pageSize.		2021-06-26
	timezone	Optional	String	Used only when viewing based on the date. If not entered or a wrong value is entered, used as UTC.	UTC	Asia/Seoul, UTC
	page	Optional	String	The page number
	pageSize	Optional	String	The size of data to be loaded at once.

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name			Type	Required	Description	Example
resultCode			string	Mandatory	Result Code
result			dict	Mandatory	Result Message
└	page		dict	Optional	Used only when viewing based on page.
	└	pageSize	number	Optional	Page size
	└	total	number	Optional	Total number of pages
	└	curPage	number	Optional	Current page
└	hitory		list		History list
	└	event	string		Occurred event	POWEROFF : 0
	└	date	string		The date of occurrence
	└	type	string		Type (general event or event)	S, E
	└	detail	string		History description

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to Common Response.

Example

Request

[GET] {{BASE_URL}}/devices/{device-id}/history?page=1&pageSize=10
[GET] {{BASE_URL}}/devices/{device-id}/history?startDate=2017-12-01&endDate=2017-12-31&timezone=Asia/Seoul

Response

 {{BASE_URL}}/devices/{device-id}/history?page=1&pageSize=10

{
  "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": ""
      }
    ]
  }
}


{{BASE_URL}}/devices/{device-id}/history?startDate=2017-12-01&endDate=2017-12-31&timezone=Asia/Seoul

{
  "resultCode": "0000",
  "result": {
    "history": [{
        "event": "{'2': 'Cooling'}",
        "date": "2017-12-09 01:43:54",
        "type": "S",
        "detail": ""
      },
      {
        "event": "{'4': 'End'}",
        "date": "2017-12-09 00:19:32",
        "type": "S",
        "detail": ""
      }
    ]
  }
}

Get Device Errors

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

Retrieve the device errors.

Request

Parameter

Location	Name	Required	Type	Description	Example
Header	Common Header	Mandatory	-	-	-
Path	device-id	Mandatory	String	The ID of the target device	07dcf5b1-fd14-104d-8d6a-203dbdb9b139
Query	startDate	Optional	String	Used if there are startDate and endDate.	2021-06-25
	endDate	Optional	String	Used if there are startDate and endDate.	2021-06-26
	timezone	Optional	String	If not entered or a wrong value is entered, used as UTC.	Asia/Seoul, UTC

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name		Type	Required	Description
resultCode		string	Mandatory	Result Code
result		list	Mandatory	Result Message
└	todo	string		List of actions to take to resolve the error
└	code	string		Error code
└	date	string		Date the error occurred

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to Common Response.

Example

Request

[GET] {{ENDPOINT_URL}}/devices/{device-id}/diagnosis
[GET] {{ENDPOINT_URL}}/devices/{device-id}/diagnosis?startDate=2017-08-24&endDate=2017-08-31&timezone=UTC

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"
    }
  ]
}

Reserve Device

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

Reserve a device to make it unavailable to other users.

Request

Parameter

Location	Name		Required	Type	Description	Example
Header	Common Header		Mandatory	-	-	-
Path	device-id		Mandatory	String	The ID of the target device	07dcf5b1-fd14-104d-8d6a-203dbdb9b139
Body	request
Body	└	time	Mandatory	number	Booked Time (Sec.)	30

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name			Type	Required	Description
resultCode			string	Mandatory	Result Code
result			dict	Mandatory	Result Message

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to Common Response.

Example

Request

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

Response

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

Cancel Device Reservation

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

Cancel the device reservation.

Request

Parameter

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

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name			Type	Required	Description
resultCode			string	Mandatory	Result Code
result			dict	Mandatory	Result Message

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to Common Response.

Example

Request

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

Response

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

[Action Required: Windows XP OS users] End of Support for 3DES Cipher

Device API

Basic Information

BaseURL

API List

Get Device List

Request

Parameter

Response

Success

Failure

Example

Request

Response

Locate Device (Beep)

Request

Parameter

Response

Success

Failure

Example

Request

Response

Prepare Device for Use (Courtesy)

Request

Parameter

Response

Success

Failure

Example

Request

Response

Prepare Device for Use

Request

Parameter

Response

Success

Failure

Example

Request

Response

Stop Device Operation

Request

Parameter

Response

Success

Failure

Example

Request

Response

Get Device Information

Request

Parameter

Response

Success

Failure

Example

Request

Response

Update Device Information

Request

Parameter

Response

Success

Failure

Example

Request

Response

[Multiple Devices] Update Device Information

Request

Parameter

Response

Success

Failure

Example

Request

Response

Get Device Settings

Request

Parameter