API 요청
Request Headers
| 헤더명 | 설명 | 필수여부 |
|---|---|---|
| Content-Type | API 요청에 대한 타입 | appliation/json |
| api-authorization-key | API 요청에 대한 키 | Y |
Request Parameters
| 요청 변수 | 설명 | 타입 | 필수여부 |
|---|---|---|---|
| prodcarKey | 완성차에 대한 고유 키 | number | N |
| prodcarModelId | 완성차에 대한 모델명 | string | N |
| createId | 최초등록자 | string | N |
Response: Success
| 필드 | 설명 | 타입 |
|---|---|---|
| DATA.RESULT | API 요청에 대한 결과 | boolean |
| DATA.DATA.PRODCAR_KEY | 완성차에 대한 고유 키 | number |
| DATA.DATA.PRODCAR_NM | 완성차 이름 | string |
| DATA.DATA.PRODCAR_MODEL_ID | 완성차 모델명 | string |
| DATA.DATA.PRODCAR_MANU_ID | 완성차 제조사 | string |
| DATA.DATA.PRODCAR_PRICE | 완성차 가격 | number |
| DATA.DATA.CREATE_ID | 최초등록자 | string |
| DATA.DATA.UPDATE_ID | 최종수정자 | string |
| DATA.DATA.CREATE_DT | 최초등록일시 | string |
| DATA.DATA.UPDATE_DT | 최종수정일시 | string |
| DATA.DATA.PRODCARINFO.PRODCAR_INFO_KEY | 완성차 장착 정보에 대한 고유 키 | number |
| DATA.DATA.PRODCARINFO.PRODCAR_KEY | 완성차에 대한 고유 키 | number |
| DATA.DATA.PRODCARINFO.PRODCAR_REF_TYPE | 완성차 장착 정보에 대한 유형 | string |
| DATA.DATA.PRODCARINFO.PRODCAR_REF_KEY | 완성차 장착 정보에 대한 키 | number |
| DATA.DATA.PRODCARINFO.PRODCAR_POS_X | 완성차 장착 정보에 대한 X 값 | number |
| DATA.DATA.PRODCARINFO.PRODCAR_POS_Y | 완성차 장착 정보에 대한 Y 값 | number |
| DATA.DATA.PRODCARINFO.PRODCAR_POS_Z | 완성차 장착 정보에 대한 Z 값 | number |
| DATA.DATA.PRODCARINFO.CREATE_ID | 최초등록자 | string |
| DATA.DATA.PRODCARINFO.UPDATE_ID | 최종수정자 | string |
| DATA.DATA.PRODCARINFO.CREATE_DT | 최초등록일시 | string |
| DATA.DATA.PRODCARINFO.UPDATE_DT | 최종수정일시 | string |
Response: Fail
| 필드 | 설명 | 타입 |
|---|---|---|
| DATA.RESULT | API 요청에 대한 결과 | boolean |
| DATA.MESSAGE | 요청 실패에 대한 원인 메시지 | string |
오류 메시지 설명
| HTTP 상태 코드 | 메시지 | 설명 |
|---|---|---|
| 401 | API AUTHORIZATION KEY IS EMPTY | API 키를 포함하지 않고 요청함 |
| 403 | NOT ALLOWED TYPE CURRENT API KEY | 신청 시 사용 범위에 포함되지 않은 API를 호출하려 함 |
| 403 | NOT AUTHORIZED TO ACCESS API | 승인되지 않았거나 API 키 정보가 없음 |
| 500 | API SERVICE OCCURED ERROR. PLEASE TRY AGAIN. | API 서비스에서 오류 발생. 일정시간 뒤 재시도 필요 |
| 400 | INVALID PARAMETER | 필수 파라미터가 존재하지 않음 |
| 200 | NOT FOUND DATA | 존재하지 않은 데이터를 수정, 삭제하려 함 |
| 403 | PERMISSION DENIED | 본인이 등록하지 않은 데이터를 수정, 삭제하려함 |
| 200 | ACCOUNT INFORAMTION IS INVALID | 로그인 정보가 올바르지 않음 |
| 200 | DISABLED ACCOUNT | 활성되지 않은 계정 |