Event 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

Method	End-point	Response Format	Summary
PUT	{{BASE_URL}}/event/callback	JSON	Register the callback URL

 

Register Callback URL

PUT {{BASE_URL}}/event/callback

Register the callback URL for receiving messages of device status changes, device operation completion, etc.

Request

Parameter

Location	Name		Required	Type	Description	Example
Header	Common Header		Mandatory	-	-	-
Body	request
	└	url	Mandatory	string	Callback URL	https://test.com

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	Mandatory	Result data	-

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] {{ENDPOINT_URL}}/event/callback

{
  "request": {
    "callbackURL": "https://test.com"
  }
}

Response

{
  "resultCode": "0000",
  "result" {
    "callbackURL": "https://test.com"
  }
}