기기마감 API
1. 개요
키오스크에서 기기를 마감할 때 사용하는 API입니다.
2. API 기본 정보
| 항목 | 값 |
|---|---|
| 업무구분 | 기기마감 |
| URL | /api/v1/kioskCloseInfo |
| 프로토콜 | HTTP |
| 요청방식 | POST |
| 생성일 | 2020. 3. 10 |
3. 요청 정보
3.1 요청 헤더
| 필드ID | 필드명 | 데이터타입 | 필수 | 길이 | 설명 |
|---|---|---|---|---|---|
| msgSendYmd | 메시지 전송 일자 | String | M | 8 | 메시지 전송 일자 (YYYYMMDD, 예: 20170123) |
| msgSendHms | 메시지 전송 시각 | String | M | 6 | 메시지 전송 시각 (hhmmss, 예: 185612) |
| kioskBranchId | 키오스크 지점번호 | String | M | 1~8 | 키오스크 지점번호 |
| kioskDeviceId | 키오스크 기기번호 | String | M | 1~12 | 키오스크 기기번호 |
| loginSesKey | 세션 키 | String | M | 1~50 | 로그인 전문 응답에서 취득 |
3.2 요청 바디
| 필드ID | 필드명 | 데이터타입 | 필수 | 길이 | 설명 |
|---|---|---|---|---|---|
| closedYmd | 마감일자 | String | M | 8 | 마감일자 |
| closedHms | 마감시간 | String | M | 6 | 마감시간 |
| tranType | 현송구분 | String | M | 1 | 현송구분 |
3.3 요청 예시
{
"header": {
"msgSendYmd": "20170205",
"msgSendHms": "125701",
"kioskBranchId": "0001",
"kioskDeviceId": "A010",
"loginSesKey": "ABCDEF1234567890",
"langCd": "",
"respCd": "",
"respMsg": ""
},
"body": {
"closedYmd": "20170205",
"closedHms": "125700",
"tranType": "C"
}
}
4. 응답 정보
4.1 응답 헤더
| 필드ID | 필드명 | 데이터타입 | 필수 | 길이 | 설명 |
|---|---|---|---|---|---|
| msgSendYmd | 메시지 전송 일자 | String | M | 8 | 메시지 전송 일자 (YYYYMMDD, 예: 20170123) |
| msgSendHms | 메시지 전송 시각 | String | M | 6 | 메시지 전송 시각 (hhmmss, 예: 185612) |
| kioskBranchId | 키오스크 지점번호 | String | M | 1~8 | 키오스크 지점번호 |
| kioskDeviceId | 키오스크 기기번호 | String | M | 1~12 | 키오스크 기기번호 |
| loginSesKey | 세션 키 | String | M | 1~50 | 로그인 전문 응답에서 취득 |
| respCd | 응답코드 | String | M | 5 | 문자 5글자 (예: 00000) |
| respMsg | 응답메시지 | String | M | 0~250 | 응답 메시지 |
4.2 응답 바디
응답 바디 없음
4.3 응답 예시
{
"header": {
"msgSendYmd": "20170205",
"msgSendHms": "125701",
"kioskBranchId": "0001",
"kioskDeviceId": "A010",
"loginSesKey": "ABCDEF1234567890",
"langCd": "",
"respCd": "00000",
"respMsg": "정상"
},
"body": null
}