REST APIs

Introduction

Swagger Document

Smart[Fleet] Platform의 REST API는 Smart[Fleet] REST API Web Document 페이지에 정의합니다.

Entity Models

Basic Entities 에 명세된 각 엔티티에 대한 데이터 모델을 기술합니다. 좀 더 상세한 기술은 Smart[Fleet] REST API Web Document 을 참고하세요.

Sensor

Key	Type	Input M/O	Default	Description
id	String	N/A		단말 식별자 (as a child)
createdTime	Int	N/A		단말 등록 시점
companyId	String	N/A		단말을 소유한 회사 식별자
directorId	String	N/A		단말을 관리하는 관리자 식별자
vehicleId	String	N/A		단말이 연결된 차량 식별자
vendor	String	M		센서 제조사명
status	String	N/A	DEACTIVATED	단말의 현재 상태 (ACTIVATED, DEACTIVATED)
type	String	M	OBD	단말 타입 (OBD2, GPS, ADAS)
credentialsId	String	M		단말의 AccessToken
lastTripMsgType	String	N/A		최종적으로 수신한 운행 정보 타입 (MICROTRIP, TRIP)
vehicleNo	String	N/A		단말이 연결된 차량 번호
activationRequired	String	M	false	차량 센서의 활성화가 필요 여부 (true, false)
serialNo	String	M		단말의 시리얼 번호
addtionalInfo	String	O		단말에 필요한 추가 정보 (as a child)

Example Code :

{
    "id": {
            "id": "b15ae910-9909-11e7-b43d-f70583f25ef3"
    },
    "createdTime": 1505186633057,
    "companyId": {
        "id": "684936a4-f1f5-48ed-9378-ca9e31cf76a7"
    },
    "directorId": {
        "id": "e2ddf150-96e6-11e7-a017-0f265a86e047"
    },
    "vehicleId": {
        "id": "7cf095a0-9137-11e7-a1f6-29ccf972bd42"
    },
    "vendor": "sk",
    "status": "DEACTIVATED",
    "type": "OBD",
    "credentialsId": "A123456789C987654321",
    "lastTripMsgType": "MICROTRIP",
    "vehicleNo": "11가1234",
    "activationRequired": false,
    "serialNo": "XF4209LFEIM",
    "additionalInfo": ""
}

Vehicle

Key	Type	Input M/O	Default	Description
id	String	N/A		차량 식별자 (as a child)
createdTime	Int	N/A		차량 등록 시점
companyId	String	N/A		차량을 소유한 회사 식별자
directorId	String	N/A		차량을 관리하는 관리자 식별자
currentDriverId	String	N/A		차량을 현재 운전하는 운전자의 식별자
latestTripId	String	N/A		차량의 최신 운행(Trip) 정보
serviceType	String	N/A		차량이 속한 사업의 명칭
vehicleNo	String	M		차량 번호 (11테1111)
modelName	String	M		차량 모델 이름
modelCode	String	M		차량의 트림 또는 모델 코드 값
modelYear	String	M		차량의 제조 년도
vendor	String	M		차량 제조사명
missionType	String	M		차량 변속기 타입 (AUTO, MANUAL)
fuelType	String	M		차량 연료 타입 (DIESEL, GASOLINE, LPG)
category	String	M		차량 카테고리 (TRUCK, BUS, TAXI, PERSONAL, ETC)
usage	String	O		차량 사용 용도
mileage	String	M		차량 총 주행 거리
delegateUserCount	Int	N/A		차량 정보를 위임한 수
sensorCount	Int	N/A		차량에 연동된 센서 갯수
displacement	Int	O		차량 배기량 정보
status	String	O	DEACTIVATED	차량 상태 정보 (ACTIVATED, DEACTIVATED)
lastTripMsgType	String	N/A		차량에 매핑된 최신 운행 정보 타입 (TRIP, MICROTRIP)
addtionalInfo	String	O		단말에 필요한 추가 정보 (as a child)

Example Code :

{
    "id": {
        "id": "b13978f0-b706-11e7-842b-ed6c4a5c999b"
    },
    "createdTime": 1508662502894,
    "companyId": {
        "id": "35d0f860-b700-11e7-842b-ed6c4a5c999b"
    },
    "directorId": {
        "id": "13814000-1dd2-11b2-8080-808080808080"
    },
    "currentDriverId": {
        "id": "13814000-1dd2-11b2-8080-808080808080"
    },
    "latestTripId": {
        "id": "13814000-1dd2-11b2-8080-808080808080"
    },
    "serviceType": "getStarted_ex",
    "vehicleNo": "11테1111",
    "modelName": "그랜져",
    "modelCode": "HG001",
    "vendor": "현대",
    "sensorCount": 0,
    "status": "DEACTIVATED",
    "additionalInfo": null,
    "modelYear": 2017,
    "usage": null,
    "category": "ETC",
    "missionType": "AUTO",
    "fuelType": "DIESEL",
    "displacement": 0,
    "delegateUserCount": 0,
    "lastTripMsgType": null
}