경로 매트릭스
- REQUEST ( 경로 매트릭스 )
curl --request POST \
--url https://apis.openapi.sk.com/tmap/matrix \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '
{
"origins": [
{
"lon": "126.893489",
"lat": "37.503666",
"poiId": "123",
"rpFlag": "S"
},
{
"lon": "126.793489",
"lat": "37.603666"
}
],
"destinations": [
{
"lon": "126.893489",
"lat": "37.803666",
"poiId": "456",
"rpFlag": "G"
}
]
}
'
- RESPONSE ( 경로 매트릭스 )
| Name | Date Type | Mandatory | Example | Description |
|---|---|---|---|---|
| meta | Node | Y | meta 정보 | |
| status | String | Y | OK | 응답 상태 Ok : 성공, Http 200 ZeroResults : 결과 없음, Http 200 NoServiceArea : 서비스 지역 아님, Http 400 NoSegment : 도로를 찾을 수 없음, Http 400 BadRequest : 요청 데이터 오류, Http 400 Failure : 서버 내부 오류, Http 500 |
| message | String | Y | OK | 응답 메시지 |
| moduleVersion | String | Y | 0.8.1-SNAPSHOT | RP 서버 모듈 버전 |
| mapVersion | String | Y | 20210608 | RP 경로 탐색에 사용된 맵 버전, 포맷:yyyyMMdd |
| elapsedTime | Number | Y | 7 | RP 서버에서 측정한 경로탐색 수행 시간(응답 전송 시간 제외), 단위:milliseconds |
| realTimeTrafficDateTime | String | Y | 2021-07-12 10:20 | RP 경로 탐색에 사용된 실시간 교통정보 버전, 포맷:yyyy-MM-dd HH:mm |
| patternTrafficDate | String | Y | 2021-06-23 | RP 경로 탐색에 사용된 패턴 교통정보 버전, 포맷:yyyy-MM-dd |
| customizationDateTime | String | Y | 2021-07-12 10:20 | RP 경로 탐색에 사용된 customization 데이터 버전, 포맷:yyyy-MM-dd HH:mm |
| algorithm | String | Y | CCH_Dijkstra | RP 경로 탐색에 사용된 알고리즘 CCH_Dijkstra : AStar : Dijkstra : |
| metric | String | Y | Recommendation | RP 경로 탐색에 사용된 메트릭 Recommendation : Static : |
| requestId | String | Y | 1d840d68-acc7-4629-a18d-41cd92c82239 | 경로 탐색 요청 ID |
| gasStationPriceDateTime | String | N | 유가정보 버전 (matrix에서는 노출안됨), 포맷:yyyy-MM-dd HH:mm | |
| transportMode | String | Y | 유가정보 버전 (matrix에서는 노출안됨), 포맷:yyyy-MM-dd HH:mm | |
| origins | Node | Y | 출발지 목록(요청 데이터와 동일) | |
| link | Node | N | Link 정보(도로를 미리 선택한경우) | |
| linkId | String | N | 매칭된 링크의 ID | |
| direction | String | N | TwoWay | 방향성 - TwoWay(기본값) - Forward - Backward |
| poiId | String | N | 출발지 POI ID(POI 검색 결과로 얻은 값)입니다. | |
| name | String | N | ||
| coordinate | Node | Y | 출발지 좌표 | |
| latitude | Number | Y | 출발지 좌표 latitude | |
| longitude | Number | Y | 출발지 좌표 longitude | |
| rpFlag | String | N | 출발지의 RP Flag 정보입니다. 명칭(POI)통합 검색 사용시 결과로 리턴된 rpFlag를 사용하시면 됩니다. | |
| destinations | Node | Y | 목적지 목록(요청 데이터와 동일) | |
| link | Node | N | Link 정보(도로를 미리 선택한경우) | |
| linkId | String | N | 매칭된 링크의 ID | |
| direction | String | N | TwoWay | 방향성 - TwoWay(기본값) - Forward - Backward |
| poiId | String | N | 목적지 POI ID(POI 검색 결과로 얻은 값)입니다. | |
| name | String | N | ||
| coordinate | Node | Y | 목적지 좌표 | |
| latitude | Number | Y | 목적지 좌표 latitude | |
| longitude | Number | Y | 목적지 좌표 longitude | |
| rpFlag | String | N | 목적지의 RP Flag 정보입니다. 명칭(POI)통합 검색 사용시 결과로 리턴된 rpFlag를 사용하시면 됩니다. | |
| matrixRoutes | Node | Y | 경로 데이터 목록 | |
| status | String | Y | 해당 경로 탐색 결과 상태 | |
| originIndex | Number | Y | 출발지 Index | |
| destinationIndex | Number | Y | 목적지 Index | |
| cost | Number | Y | RP 에서 계산된 경로 총 Cost(RP 서버 디버깅 용도) | |
| duration | Number | Y | 경로 총 소요시간, 단위:seconds | |
| distance | Number | Y | 경로 총 거리, 단위:meter |
- 경로 매트릭스 RESPONSE ( type : json )
{
"meta": {
"status": "Ok",
"message": "Ok",
"moduleVersion": "1.7.1",
"mapVersion": "20211207",
"elapsedTime": 53,
"realTimeTrafficDateTime": "2021-12-22 16:05",
"patternTrafficDate": "2021-12-22",
"customizationDateTime": "2021-12-22 16:05",
"algorithm": "CCH_Dijkstra",
"metric": "Recommendation",
"requestId": "1d840d68-acc7-4629-a18d-41cd92c82239",
"gasStationPriceDateTime": "",
"transportMode": "Car"
},
"origins": [
{
"link": {
"linkId": "123",
"direction": "TwoWay"
},
"poiId": "123",
"name": "",
"coordinate": {
"latitude": 37.503666,
"longitude": 126.893489
},
"rpFlag": "S"
},
{
"link": {
"linkId": "0",
"direction": "TwoWay"
},
"poiId": "",
"name": "",
"coordinate": {
"latitude": 37.603666,
"longitude": 126.793489
},
"rpFlag": ""
}
],
"destinations": [
{
"link": {
"linkId": "999",
"direction": "Backward"
},
"poiId": "456",
"name": "",
"coordinate": {
"latitude": 37.803666,
"longitude": 126.893489
},
"rpFlag": "G"
}
],
"matrixRoutes": [
{
"status": "Ok",
"originIndex": 0,
"destinationIndex": 0,
"cost": 106031,
"duration": 4229,
"distance": 49095.9
},
{
"status": "Ok",
"originIndex": 1,
"destinationIndex": 0,
"cost": 88115,
"duration": 2882,
"distance": 41094.4
}
]
}
- 경로 매트릭스 RESPONSE ( type : javascript )
{
"meta": {
"status": "Ok",
"message": "Ok",
"moduleVersion": "1.7.1",
"mapVersion": "20211207",
"elapsedTime": 53,
"realTimeTrafficDateTime": "2021-12-22 16:05",
"patternTrafficDate": "2021-12-22",
"customizationDateTime": "2021-12-22 16:05",
"algorithm": "CCH_Dijkstra",
"metric": "Recommendation",
"requestId": "1d840d68-acc7-4629-a18d-41cd92c82239",
"gasStationPriceDateTime": "",
"transportMode": "Car"
},
"origins": [
{
"link": {
"linkId": "123",
"direction": "TwoWay"
},
"poiId": "123",
"name": "",
"coordinate": {
"latitude": 37.503666,
"longitude": 126.893489
},
"rpFlag": "S"
},
{
"link": {
"linkId": "0",
"direction": "TwoWay"
},
"poiId": "",
"name": "",
"coordinate": {
"latitude": 37.603666,
"longitude": 126.793489
},
"rpFlag": ""
}
],
"destinations": [
{
"link": {
"linkId": "999",
"direction": "Backward"
},
"poiId": "456",
"name": "",
"coordinate": {
"latitude": 37.803666,
"longitude": 126.893489
},
"rpFlag": "G"
}
],
"matrixRoutes": [
{
"status": "Ok",
"originIndex": 0,
"destinationIndex": 0,
"cost": 106031,
"duration": 4229,
"distance": 49095.9
},
{
"status": "Ok",
"originIndex": 1,
"destinationIndex": 0,
"cost": 88115,
"duration": 2882,
"distance": 41094.4
}
]
}
- Error code index
| 에러코드 목록은 Web service에서 Guide API의 console에서 확인 할 수 있습니다.