Statistics API
기본 정보
BaseURL
Phase |
KIC |
AIC |
EIC |
Description |
---|---|---|---|---|
OP |
- |
- |
운영 |
|
QA |
- |
- |
개발 및 테스트 |
API List
API |
Method |
End-point |
Response Format |
Summary |
---|---|---|---|---|
[전체 기기] 통계 조회 |
GET |
{{BASE_URL}}/statistics |
JSON |
전체 기기에 대해, 여러 유형의 통계를 한 번에 조회합니다. |
[다중 기기] 통계 조회 |
GET |
{{BASE_URL}}/statistics/device |
JSON |
여러 기기에 대해, 여러 유형의 통계를 한 번에 조회합니다. |
[전체기기] 코스 사용 횟수 조회 |
GET |
{{BASE_URL}}/statistics/course |
JSON |
전체 기기에 대해, 코스 사용 횟수를 조회합니다. |
[기기] 코스 사용 횟수 조회 |
GET |
{{BASE_URL}}/statistics/course/device/<device-id> |
JSON |
요청한 기기에 대해, 코스 사용 횟수를 조회합니다. |
[전체 기기] 동작 횟수 조회 |
GET |
{{BASE_URL}}/statistics/cycle |
JSON |
전체 기기에 대해, 동작 횟수를 조회합니다. |
[기기] 동작 횟수 조회 |
GET |
{{BASE_URL}}/statistics/cycle/device/<device-id> |
JSON |
요청한 기기에 대해, 동작 횟수를 조회합니다. |
[전체 기기] 예약 횟수 조회 |
GET |
{{BASE_URL}}/statistics/reserve |
JSON |
전체 기기에 대해, 예약 횟수를 조회합니다. |
[기기] 예약 횟수 조회 |
GET |
{{BASE_URL}}/statistics/reserve/device/<device-id> |
JSON |
요청한 기기에 대해, 예약 횟수를 조회합니다. |
[전체 기기] 통계 조회
GET {{BASE_URL}}/statistics
전체 기기에 대해, 여러 유형의 통계를 한 번에 조회합니다.
요청
Parameter
startDate
부터 endDate
까지 기간에 대해, periodType
에 따라 일/주/월/년 단위로 통계를 낸 데이터를 조회합니다.
Location |
Name |
Required |
Type |
Description |
Example |
---|---|---|---|---|---|
Header |
Common Header |
Mandatory |
- | - | - |
Query |
startDate |
Mandatory |
string |
시작일 |
2019-10-11 |
endDate |
Mandatory |
string |
종료일 |
2019-10-20 |
|
periodType |
Mandatory |
string |
기간 단위 |
day, week, month, year |
|
timezone |
Mandatory |
string |
타임존 |
Asia/Seoul, UTC |
|
type |
Mandatory |
string |
조회할 통계 유형 ','로 구분하여 여러 개 입력 가능 |
course, cycle, reserve |
응답
성공
성공 시, resultCode가 정상 코드 (0000
)로 리턴됩니다. 결과 데이터는 응답 메시지의 result에서 확인할 수 있습니다.
Name |
Type |
Required |
Description |
Example |
|||||
---|---|---|---|---|---|---|---|---|---|
resultCode |
string |
Mandatory |
결과 코드 |
||||||
result |
list |
Optional |
결과 데이터 |
||||||
└ |
course |
dict |
Optional |
코스 사용 횟수 관련 통계 |
|||||
└ |
{date} |
dict |
Optional |
날짜 (요청한 날짜와 기간 타입에 따라 달라짐) |
2020-06, 2020-06-01 |
||||
└ |
total |
number |
Optional |
조회 기간 내 코스 사용 횟수의 총합 |
1 |
||||
└ |
washer |
dict |
Optional |
- | - | ||||
└ |
30 |
number |
Optional |
30 °C |
0 |
||||
└ |
40 |
number |
Optional |
40 °C |
0 |
||||
└ |
60 |
number |
Optional |
60 °C |
0 |
||||
└ |
75 |
number |
Optional |
75 °C |
0 |
||||
└ |
90 |
number |
Optional |
90 °C |
0 |
||||
└ |
TubClean_Heater |
number |
Optional |
통세척 |
0 |
||||
└ |
TubClean_NonHeater |
number |
Optional |
통세척 |
0 |
||||
└ |
Hot |
number |
Optional |
강력 |
0 |
||||
└ |
Warm |
number |
Optional |
표준 |
0 |
||||
└ |
Cold |
number |
Optional |
합섬 |
0 |
||||
└ |
Delicate |
number |
Optional |
울 |
0 |
||||
└ |
SpinOnly |
number |
Optional |
탈수 단독 |
0 |
||||
└ |
Initial_TubClean |
number |
Optional |
통세척 |
0 |
||||
└ |
Dryer |
dict |
Optional |
- | |||||
└ |
HI_TEMP |
number |
Optional |
강력 |
0 |
||||
└ |
MED_TEMP |
number |
Optional |
표준 |
0 |
||||
└ |
LOW_TEMP |
number |
Optional |
약 |
0 |
||||
└ |
COOLING |
number |
Optional |
송풍 |
0 |
||||
└ |
cycle |
dict |
Optional |
동작 회수 관련 통계 |
|||||
└ |
{date} |
dict |
Optional |
날짜 (요청한 날짜와 기간 타입에 따라 달라짐) |
2020-06, 2020-06-01 |
||||
└ |
total |
number |
Optional |
세탁기, 건조기 동작 횟수 총합 |
1 |
||||
└ |
washer |
dict |
Optional |
- | - | ||||
└ |
cycle |
number |
Optional |
모든 동작 횟수 |
0 |
||||
└ |
regular |
number |
Optional |
동작 중 비용을 지불하고 동작한 횟수 |
0 |
||||
└ |
courtesy |
number |
Optional |
동작 중 비용을 지불하지 않고 동작한 횟수 |
0 |
||||
└ |
dryer |
dict |
Optional |
- | - | ||||
└ |
cycle |
number |
Optional |
모든 동작 횟수 |
0 |
||||
└ |
regular |
number |
Optional |
동작 중 비용을 지불하고 동작한 횟수 |
0 |
||||
└ |
courtesy |
number |
Optional |
동작 중 비용을 지불하지 않고 동작한 횟수 |
0 |
||||
└ |
reserve |
dict |
Optional |
예약 횟수 관련 통계 |
|||||
└ |
{date} |
dict |
Optional |
날짜 (요청한 날짜와 기간 타입에 따라 달라짐) |
2020-06, 2020-06-01 |
||||
└ |
total |
number |
Optional |
세탁기, 건조기 예약 횟수 총합 |
1 |
||||
└ |
washer |
number |
Optional |
세탁기 예약 횟수 |
0 |
||||
└ |
dryer |
number |
Optional |
건조기 예약 횟수 |
1 |
실패
실패 시, resultCode가 에러 코드 값으로 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.
Example
Request
[GET] {{BASE_URL}}/statistics?startDate=2021-01-01&endDate=2021-01-31&periodType=month&timezone=Asia/Seoul&type=course, cycle, reserve
Response
{ "resultCode": "0000", "result": { "course": { "2021-01": { "total": 0, "washer": { "90": 0, "75": 0, "60": 0, "40": 0, "30": 0, "TubClean_Heater": 0, "TubClean_NonHeater": 0, "Hot": 0, "Warm": 0, "Cold": 0, "Delicate": 0, "SpinOnly": 0, "Initial_TubClean": 0 }, "dryer": { "HI_TEMP": 0, "MED_TEMP": 0, "LOW_TEMP": 0, "COOLING": 0 } } }, "cycle": { "2021-01": { "total": 0, "washer": { "cycle": 0, "regular": 0, "courtesy": 0 }, "dryer": { "cycle": 0, "regular": 0, "courtesy": 0 } } }, "reserve": { "2021-01": 0 } } }
[다중 기기] 통계 조회
GET {{BASE_URL}}/statistics/device
여러 개의 기기에 대해, 여러 유형의 통계를 한 번에 조회합니다.
요청
Parameter
startDate
부터 endDate
까지 기간에 대해, periodType
에 따라 일/주/월/년 단위로 통계를 낸 데이터를 조회합니다.
Location |
Name |
Required |
Type |
Description |
Example |
---|---|---|---|---|---|
Header |
Common Header |
Mandatory |
- | - | - |
Query |
startDate |
Mandatory |
string |
시작일 |
2019-10-11 |
endDate |
Mandatory |
string |
종료일 |
2019-10-20 |
|
periodType |
Mandatory |
string |
기간 단위 |
day, week, month, year |
|
timezone |
Mandatory |
string |
타임존 |
Asia/Seoul, UTC |
|
type |
Mandatory |
string |
조회할 통계 유형 ','로 구분하여 여러 개 입력 가능 |
course, cycle, reserve |
|
ids |
Mandatory |
string |
조회할 device id 리스트 (최대 100개) |
1, 2, 3, 4 |
응답
성공
성공 시, resultCode가 정상 코드 (0000
)로 리턴됩니다. 결과 데이터는 응답 메시지의 result에서 확인할 수 있습니다.
Name |
Type |
Required |
Description |
Example |
|||||
---|---|---|---|---|---|---|---|---|---|
resultCode |
string |
Mandatory |
결과 코드 |
||||||
result |
list |
Optional |
결과 데이터 |
||||||
└ |
deviceId |
string |
Optional |
디바이스 ID |
|||||
└ |
errCode |
string |
Optional |
에러 코드 |
|||||
└ |
errDescription |
string |
Optional |
에러 정보 |
|||||
└ |
course |
dict |
Optional |
코스 관련 통계 |
|||||
└ |
{date} |
dict |
Optional |
날짜 (요청한 날짜와 기간 타입에 따라 달라짐) |
2020-06, 2020-06-01 |
||||
└ |
total |
number |
Optional |
조회 기간 내 코스 사용 횟수의 총합 |
1 |
||||
└ |
washer |
dict |
Optional |
- | - | ||||
└ |
30 |
number |
Optional |
30 °C |
0 |
||||
└ |
40 |
number |
Optional |
40 °C |
0 |
||||
└ |
60 |
number |
Optional |
60 °C |
0 |
||||
└ |
75 |
number |
Optional |
75 °C |
0 |
||||
└ |
90 |
number |
Optional |
90 °C |
0 |
||||
└ |
TubClean_Heater |
number |
Optional |
통세척 |
0 |
||||
└ |
TubClean_NonHeater |
number |
Optional |
통세척 |
0 |
||||
└ |
Hot |
number |
Optional |
강력 |
0 |
||||
└ |
Warm |
number |
Optional |
표준 |
0 |
||||
└ |
Cold |
number |
Optional |
합섬 |
0 |
||||
└ |
Delicate |
number |
Optional |
울 |
0 |
||||
└ |
SpinOnly |
number |
Optional |
탈수 단독 |
0 |
||||
└ |
Initial_TubClean |
number |
Optional |
통세척 |
0 |
||||
└ |
Dryer |
dict |
Optional |
- | |||||
└ |
HI_TEMP |
number |
Optional |
강력 |
0 |
||||
└ |
MED_TEMP |
number |
Optional |
표준 |
0 |
||||
└ |
LOW_TEMP |
number |
Optional |
약 |
0 |
||||
└ |
COOLING |
number |
Optional |
송풍 |
0 |
||||
└ |
cycle |
dict |
Optional |
동작 횟수 관련 통계 |
|||||
└ |
{date} |
dict |
Optional |
날짜 (요청한 날짜와 기간 타입에 따라 달라짐) |
2020-06, 2020-06-01 |
||||
└ |
total |
number |
Optional |
세탁기, 건조기 동작 횟수 총합 |
1 |
||||
└ |
washer |
dict |
Optional |
- | - | ||||
└ |
cycle |
number |
Optional |
모든 동작 횟수 |
0 |
||||
└ |
regular |
number |
Optional |
동작 중 비용을 지불하고 동작한 횟수 |
0 |
||||
└ |
courtesy |
number |
Optional |
동작 중 비용을 지불하지 않고 동작한 횟수 |
0 |
||||
└ |
dryer |
dict |
Optional |
- | - | ||||
└ |
cycle |
number |
Optional |
모든 동작 횟수 |
0 |
||||
└ |
regular |
number |
Optional |
동작 중 비용을 지불하고 동작한 횟수 |
0 |
||||
└ |
courtesy |
number |
Optional |
동작 중 비용을 지불하지 않고 동작한 횟수 |
0 |
||||
└ |
reserve |
dict |
Optional |
예약 횟수 관련 통계 |
|||||
└ |
{date} |
dict |
Optional |
날짜 (요청한 날짜와 기간 타입에 따라 달라짐) |
2020-06, 2020-06-01 |
||||
└ |
total |
number |
Optional |
세탁기, 건조기 예약 횟수 총합 |
1 |
||||
└ |
washer |
number |
Optional |
세탁기 예약 횟수 |
0 |
||||
└ |
dryer |
number |
Optional |
건조기 예약 횟수 |
1 |
실패
실패 시, resultCode가 에러 코드 값으로 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.
Example
Request
[GET] {{BASE_URL}}/statistics/device?startDate=2021-01-01&endDate=2021-01-31&periodType=month&timezone=Asia/Seoul&type=course, cycle, reserve&ids=4138737e7eb621c26138f89f60b646671b03cf30817a7f55a7eb1e0af4aa501e, 1111
Response
{ "resultCode": "0000", "result": [{ "deviceId": "4138737e7eb621c26138f89f60b646671b03cf30817a7f55a7eb1e0af4aa501e", "course": { "2021-01": { "total": 0, "course": { "90": 0, "75": 0, "60": 0, "40": 0, "30": 0, "TubClean_Heater": 0, "TubClean_NonHeater": 0, "Hot": 0, "Warm": 0, "Cold": 0, "Delicate": 0, "SpinOnly": 0, "Initial_TubClean": 0 } } }, "cycle": { "2021-01": { "cycle": 0, "regular": 0, "courtesy": 0 } }, "reserve": { "2021-01": 0 } }, { "deviceId": "1111", "errCode": "0100", "errDescription": "" } ] }
[전체 기기] 코스 사용 횟수 조회
GET {{BASE_URL}}/statistics/course
전체 기기에 대해, 요청한 기간 동안의 코스 사용 횟수를 조회합니다.
요청
Parameter
startDate
부터 endDate
까지 기간에 대해, periodType
에 따라 일/주/월/년 단위로 통계를 낸 데이터를 조회합니다.
Location |
Name |
Required |
Type |
Description |
Example |
---|---|---|---|---|---|
Header |
Common Header |
Mandatory |
- | - | - |
Query |
startDate |
Mandatory |
string |
시작일 |
2019-10-11 |
endDate |
Mandatory |
string |
종료일 |
2019-10-20 |
|
periodType |
Mandatory |
string |
기간 단위 |
day, week, month, year |
|
timezone |
Mandatory |
string |
타임존 |
Asia/Seoul, UTC |
응답
성공
성공 시, resultCode가 정상 코드 (0000
)로 리턴됩니다. 결과 데이터는 응답 메시지의 result에서 확인할 수 있습니다.
Name |
Type |
Required |
Description |
Example |
||||
---|---|---|---|---|---|---|---|---|
resultCode |
string |
Mandatory |
결과 코드 |
|||||
result |
list |
Mandatory |
결과 데이터 |
|||||
└ |
{date} |
dict |
Mandatory |
날짜 (요청한 날짜와 기간 타입에 따라 달라짐) |
2020-06, 2020-06-01 |
|||
└ |
total |
number |
Mandatory |
조회 기간 내 코스 사용 횟수의 총합 |
1 |
|||
└ |
washer |
dict |
Optional |
- | - | |||
└ |
30 |
number |
Optional |
30 °C |
0 |
|||
└ |
40 |
number |
Optional |
40 °C |
0 |
|||
└ |
60 |
number |
Optional |
60 °C |
0 |
|||
└ |
75 |
number |
Optional |
75 °C |
0 |
|||
└ |
90 |
number |
Optional |
90 °C |
0 |
|||
└ |
TubClean_Heater |
number |
Optional |
통세척 |
0 |
|||
└ |
TubClean_NonHeater |
number |
Optional |
통세척 |
0 |
|||
└ |
Hot |
number |
Optional |
강력 |
0 |
|||
└ |
Warm |
number |
Optional |
표준 |
0 |
|||
└ |
Cold |
number |
Optional |
합섬 |
0 |
|||
└ |
Delicate |
number |
Optional |
울 |
0 |
|||
└ |
SpinOnly |
number |
Optional |
탈수 단독 |
0 |
|||
└ |
Initial_TubClean |
number |
Optional |
통세척 |
0 |
|||
└ |
Dryer |
dict |
Optional |
- | ||||
└ |
HI_TEMP |
number |
Optional |
강력 |
0 |
|||
└ |
MED_TEMP |
number |
Optional |
표준 |
0 |
|||
└ |
LOW_TEMP |
number |
Optional |
약 |
0 |
|||
└ |
COOLING |
number |
Optional |
송풍 |
0 |
실패
실패 시, resultCode가 에러 코드 값으로 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.
Example
Request
[GET] {{BASE_URL}}/statistics/course?startDate=2020-06-01&endDate=2020-06-30&periodType=month&timezone=Asia/Seoul
Response
{ "resultCode": "0000", "result": { "2020-06": { "total": 0, "washer": { "90": 0, "75": 0, "60": 0, "40": 0, "30": 0, "TubClean_Heater": 0, "TubClean_NonHeater": 0, "Hot": 0, "Warm": 0, "Cold": 0, "Delicate": 0, "SpinOnly": 0, "Initial_TubClean": 0 }, "dryer": { "HI_TEMP": 0, "MED_TEMP": 0, "LOW_TEMP": 0, "COOLING": 0 } } } }
[기기] 코스 사용 횟수 조회
GET {{BASE_URL}}/statistics/course/device/<device-id>
요청하는 기기에 대해, 요청한 기간 동안의 코스 사용 횟수를 조회합니다.
요청
Parameter
startDate
부터 endDate
까지 기간에 대해, periodType
에 따라 일/주/월/년 단위로 통계를 낸 데이터를 조회합니다.
Location |
Name |
Required |
Type |
Description |
Example |
---|---|---|---|---|---|
Header |
Common Header |
Mandatory |
- | - | - |
Path |
device-id |
Mandatory |
string |
기기 ID |
07dcf5b1-fd14-104d-8d6a-203dbdb9b139 |
Query |
startDate |
Mandatory |
string |
시작일 |
2019-10-11 |
endDate |
Mandatory |
string |
종료일 |
2019-10-20 |
|
periodType |
Mandatory |
string |
기간 단위 |
day, week, month, year |
|
timezone |
Mandatory |
string |
타임존 |
Asia/Seoul, UTC |
응답
성공
성공 시, resultCode가 정상 코드 (0000
)로 리턴됩니다. 결과 데이터는 응답 메시지의 result에서 확인할 수 있습니다.
Name |
Type |
Required |
Description |
Example |
||||
---|---|---|---|---|---|---|---|---|
resultCode |
string |
Mandatory |
결과 코드 |
|||||
result |
list |
Mandatory |
결과 데이터 |
|||||
└ |
{date} |
dict |
Mandatory |
날짜 (요청한 날짜와 기간 타입에 따라 달라짐) |
2020-06, 2020-06-01 |
|||
└ |
total |
number |
Mandatory |
조회 기간 내 코스 사용 횟수의 총합 |
1 |
|||
└ |
washer |
dict |
Optional |
- | - | |||
└ |
30 |
number |
Optional |
30 °C |
0 |
|||
└ |
40 |
number |
Optional |
40 °C |
0 |
|||
└ |
60 |
number |
Optional |
60 °C |
0 |
|||
└ |
75 |
number |
Optional |
75 °C |
0 |
|||
└ |
90 |
number |
Optional |
90 °C |
0 |
|||
└ |
TubClean_Heater |
number |
Optional |
통세척 |
0 |
|||
└ |
TubClean_NonHeater |
number |
Optional |
통세척 |
0 |
|||
└ |
Hot |
number |
Optional |
강력 |
0 |
|||
└ |
Warm |
number |
Optional |
표준 |
0 |
|||
└ |
Cold |
number |
Optional |
합섬 |
0 |
|||
└ |
Delicate |
number |
Optional |
울 |
0 |
|||
└ |
SpinOnly |
number |
Optional |
탈수 단독 |
0 |
|||
└ |
Initial_TubClean |
number |
Optional |
통세척 |
0 |
|||
└ |
Dryer |
dict |
Optional |
- | ||||
└ |
HI_TEMP |
number |
Optional |
강력 |
0 |
|||
└ |
MED_TEMP |
number |
Optional |
표준 |
0 |
|||
└ |
LOW_TEMP |
number |
Optional |
약 |
0 |
|||
└ |
COOLING |
number |
Optional |
송풍 |
0 |
실패
실패 시, resultCode가 에러 코드 값으로 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.
Example
Request
[GET] {{BASE_URL}}/statistics/course/device/<device-id>?startDate=2020-06-01&endDate=2020-06-30&periodType=month
Response
{ "resultCode": "0000", "result": { "2020-06": { "total": 0, "washer": { "90": 0, "75": 0, "60": 0, "40": 0, "30": 0, "TubClean_Heater": 0, "TubClean_NonHeater": 0, "Hot": 0, "Warm": 0, "Cold": 0, "Delicate": 0, "SpinOnly": 0, "Initial_TubClean": 0 }, "dryer": { "HI_TEMP": 0, "MED_TEMP": 0, "LOW_TEMP": 0, "COOLING": 0 } } } }
[전체 기기] 동작 횟수 조회
GET {{BASE_URL}}/statistics/cycle
전체 기기에 대해, 요청한 기간 동안의 동작 횟수를 조회합니다.
요청
Parameter
startDate
부터 endDate
까지 기간에 대해, periodType
에 따라 일/주/월/년 단위로 통계를 낸 데이터를 조회합니다.
Location |
Name |
Required |
Type |
Description |
Example |
---|---|---|---|---|---|
Header |
Common Header |
Mandatory |
- | - | - |
Query |
startDate |
Mandatory |
string |
시작일 |
2019-10-11 |
endDate |
Mandatory |
string |
종료일 |
2019-10-20 |
|
periodType |
Mandatory |
string |
기간 단위 |
day, week, month, year |
|
timezone |
Mandatory |
string |
타임존 |
Asia/Seoul, UTC |
응답
성공
성공 시, resultCode가 정상 코드 (0000
)로 리턴됩니다. 결과 데이터는 응답 메시지의 result에서 확인할 수 있습니다.
Name |
Type |
Required |
Description |
Example |
||||
---|---|---|---|---|---|---|---|---|
resultCode |
string |
Mandatory |
결과 코드 |
"0000" |
||||
result |
list |
Optional |
결과 메시지 |
- | ||||
└ |
{date} |
dict |
Optional |
날짜 (요청한 날짜와 기간 타입에 따라 달라짐) |
2020-06, 2020-06-01 |
|||
└ |
total |
number |
Optional |
세탁기, 건조기 동작 횟수 총합 |
1 |
|||
└ |
washer |
dict |
Optional |
- | - | |||
└ |
cycle |
number |
Optional |
모든 동작 횟수 |
0 |
|||
└ |
regular |
number |
Optional |
동작 중 비용을 지불하고 동작한 횟수 |
0 |
|||
└ |
courtesy |
number |
Optional |
동작 중 비용을 지불하지 않고 동작한 횟수 |
0 |
|||
└ |
dryer |
dict |
Optional |
- | - | |||
└ |
cycle |
number |
Optional |
모든 동작 횟수 |
0 |
|||
└ |
regular |
number |
Optional |
동작 중 비용을 지불하고 동작한 횟수 |
0 |
|||
└ |
courtesy |
number |
Optional |
동작 중 비용을 지불하지 않고 동작한 횟수 |
0 |
실패
실패 시, resultCode가 에러 코드 값으로 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.
Example
Request
[GET] {{BASE_URL}}/statistics/cycle?startDate=2020-06-01&endDate=2020-06-30&periodType=month&timezone=Asia/Seoul
Response
{ "resultCode": "0000", "result": { "2020-06": { "total": 0, "washer": { "cycle": 0, "regular": 0, "courtesy": 0 }, "dryer": { "cycle": 0, "regular": 0, "courtesy": 0 } } } }
[기기] 동작 횟수 조회
GET {{BASE_URL}}/statistics/cycle/<device-id>
요청한 기기에 대해, 요청한 기간 동안의 동작 횟수를 조회합니다.
요청
Parameter
startDate
부터 endDate
까지 기간에 대해, periodType
에 따라 일/주/월/년 단위로 통계를 낸 데이터를 조회합니다.
Location |
Name |
Required |
Type |
Description |
Example |
---|---|---|---|---|---|
Header |
Common Header |
Mandatory |
- | - | - |
Path |
device-id |
Mandatory |
string |
디바이스 ID |
07dcf5b1-fd14-104d-8d6a-203dbdb9b139 |
Query |
startDate |
Mandatory |
string |
시작일 |
2019-10-11 |
endDate |
Mandatory |
string |
종료일 |
2019-10-20 |
|
periodType |
Mandatory |
string |
기간 단위 |
day, week, month, year |
|
timezone |
Mandatory |
string |
타임존 |
Asia/Seoul, UTC |
응답
성공
성공 시, resultCode가 정상 코드 (0000
)로 리턴됩니다. 결과 데이터는 응답 메시지의 result에서 확인할 수 있습니다.
Name |
Type |
Required |
Description |
Example |
||||
---|---|---|---|---|---|---|---|---|
resultCode |
string |
Mandatory |
결과 코드 |
"0000" |
||||
result |
list |
Optional |
결과 메시지 |
- | ||||
└ |
{date} |
dict |
Optional |
날짜 (요청한 날짜와 기간 타입에 따라 달라짐) |
2020-06, 2020-06-01 |
|||
└ |
total |
number |
Optional |
조회 기간 내 세탁기, 건조기 동작 횟수 총합 |
1 |
|||
└ |
washer |
dict |
Optional |
- | - | |||
└ |
cycle |
number |
Optional |
모든 동작 횟수 |
0 |
|||
└ |
regular |
number |
Optional |
동작 중 비용을 지불하고 동작한 횟수 |
0 |
|||
└ |
courtesy |
number |
Optional |
동작 중 비용을 지불하지 않고 동작한 횟수 |
0 |
|||
└ |
dryer |
dict |
Optional |
- | - | |||
└ |
cycle |
number |
Optional |
모든 동작 횟수 |
0 |
|||
└ |
regular |
number |
Optional |
동작 중 비용을 지불하고 동작한 횟수 |
0 |
|||
└ |
courtesy |
number |
Optional |
동작 중 비용을 지불하지 않고 동작한 횟수 |
0 |
실패
실패 시, resultCode가 에러 코드 값으로 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.
Example
Request
[GET] {{BASE_URL}}/statistics/cycle/device/<device-id>?startDate=2020-06-01&endDate=2020-06-30&periodType=month&timezone=Asia/Seoul
Response
{ "resultCode": "0000", "result": { "2020-06": { "total": 0, "washer": { "cycle": 0, "regular": 0, "courtesy": 0 }, "dryer": { "cycle": 0, "regular": 0, "courtesy": 0 } } } }
[전체 기기] 예약 횟수 조회
GET {{BASE_URL}}/statistics/reserve
전체 기기에 대해, 요청한 기간 동안의 예약 횟수를 조회합니다.
요청
Parameter
startDate
부터 endDate
까지 기간에 대해, periodType
에 따라 일/주/월/년 단위로 통계를 낸 데이터를 조회합니다.
Location |
Name |
Required |
Type |
Description |
Example |
---|---|---|---|---|---|
Header |
Common Header |
Mandatory |
- | - | - |
Query |
startDate |
Mandatory |
string |
시작일 |
2019-10-11 |
endDate |
Mandatory |
string |
종료일 |
2019-10-20 |
|
periodType |
Mandatory |
string |
기간 단위 |
day, week, month, year |
|
timezone |
Mandatory |
string |
타임존 |
Asia/Seoul, UTC |
응답
성공
성공 시, resultCode가 정상 코드 (0000
)로 리턴됩니다. 결과 데이터는 응답 메시지의 result에서 확인할 수 있습니다.
Name |
Type |
Required |
Description |
Example |
||||
---|---|---|---|---|---|---|---|---|
resultCode |
string |
Mandatory |
결과 코드 |
"0000" |
||||
result |
list |
- |
결과 메시지 |
- | ||||
└ |
{date} |
dict |
Mandatory |
날짜 (요청한 날짜와 기간 타입에 따라 달라짐) |
2020-06, 2020-06-01 |
|||
└ |
total |
number |
Mandatory |
세탁기, 건조기 예약 횟수 총합 |
1 |
|||
└ |
washer |
number |
Mandatory |
세탁기 예약 횟수 |
0 |
|||
└ |
dryer |
number |
Mandatory |
건조기 예약 횟수 |
1 |
실패
실패 시, resultCode가 에러 코드 값으로 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.
Example
Request
[GET] {{BASE_URL}}/statistics/reserve?startDate=2020-06-01&endDate=2020-06-30&periodType=month
Response
{ "resultCode": "0000", "result": { "2020-06": { "total": 0, "washer": 0, "dryer": 0 } } }
[기기] 예약 횟수 조회
GET {{BASE_URL}}/statistics/reserve/device/<device-id>
요청한 기기에 대해, 요청한 기간 동안의 예약 횟수를 조회합니다.
요청
Parameter
startDate
부터 endDate
까지 기간에 대해, periodType
에 따라 일/주/월/년 단위로 통계를 낸 데이터를 조회합니다.
Location |
Name |
Required |
Type |
Description |
Example |
---|---|---|---|---|---|
Header |
Common Header |
Mandatory |
- | - | - |
Path |
device-id |
Mandatory |
string |
디바이스 ID |
07dcf5b1-fd14-104d-8d6a-203dbdb9b139 |
Query |
startDate |
Mandatory |
string |
시작일 |
2019-10-11 |
endDate |
Mandatory |
string |
종료일 |
2019-10-20 |
|
periodType |
Mandatory |
string |
기간 단위 |
day, week, month, year |
|
timezone |
Mandatory |
string |
타임존 |
Asia/Seoul, UTC |
응답
성공
성공 시, resultCode가 정상 코드 (0000
)로 리턴됩니다. 결과 데이터는 응답 메시지의 result에서 확인할 수 있습니다.
Name |
Type |
Required |
Description |
Example |
||||
---|---|---|---|---|---|---|---|---|
resultCode |
string |
Mandatory |
결과 코드 |
"0000" |
||||
result |
list |
- |
결과 데이터 |
- | ||||
└ |
{date} |
dict |
Mandatory |
날짜 (요청한 날짜와 기간 타입에 따라 달라짐) |
2020-06, 2020-06-01 |
|||
└ |
total |
number |
Mandatory |
세탁기, 건조기 예약 횟수 총합 |
1 |
|||
└ |
washer |
number |
Mandatory |
세탁기 예약 횟수 |
0 |
|||
└ |
dryer |
number |
Mandatory |
건조기 예약 횟수 |
1 |
실패
실패 시, resultCode가 에러 코드 값으로 리턴됩니다. 에러 코드에 대한 설명은 Common Response를 참조하십시오.
Example
Request
[GET] {{BASE_URL}}/statistics/reserve/device/<device-id>?startDate=2020-06-01&endDate=2020-06-30&periodType=month
Response
{ "resultCode": "0000", "result": { "2020-06": { "total": 0, "washer": 0, "dryer": 0 } } }