# Bus Route

| Method |                   Request URI                  | Response type |
| :----: | :--------------------------------------------: | :-----------: |
|   GET  | <https://api.fatos.biz/pubtrans/searchBusLane> |   json, xml   |

### Parameter

|   Parameter   | Required |                                                                                                             Description                                                                                                             |      Sample      |
| :-----------: | :------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------: |
|      key      |     Y    |                                                                                                            Your API Key.                                                                                                            |  key=xxxxxxxxxxx |
|      lang     |     N    | <p></p><p>Select Result Language </p><p>(Korean: 0, English: 1, Japanese: 2, Chinese (simplified): 3, Chinese (traditional): 4, Vietnamese: 5)</p><ul><li>For Vietnamese, only in the metropolitan area</li></ul><p>default = 0</p> |      lang=1      |
|     output    |     N    |                                                                                        <p>Output format (json, xml) </p><p>default = json</p>                                                                                       |    output=json   |
|     busNo     |     Y    |                                                                                                           Bus route number                                                                                                          |    busNo=6632    |
|      CID      |     N    |                                                                                                              City code                                                                                                              |     CID=1000     |
| stationListYn |     N    |                                                                                               <p>main station List<br>default = no</p>                                                                                              | stationListYn=no |
|   displayCnt  |     N    |                                                                                                         Return result count                                                                                                         |   displayCnt=10  |
|    startNO    |     N    |                                                                                                      Page number among results                                                                                                      |     startNO=1    |

### Response

|         NAME        |  Type  |                                                                                     Description                                                                                     |
| :-----------------: | :----: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|        result       |  node  |                                                                                       Top node                                                                                      |
|      totalCount     |   int  |                                                                                    search results                                                                                   |
|    totalCityList    |  node  |                                                                                    List of cities                                                                                   |
|     includeCity     |  node  |                                                                                    List of cities                                                                                   |
|         CID         |   int  |                                                                                      City code                                                                                      |
|       cityName      | string |                                                                                      City name                                                                                      |
|         lane        |  node  |                                                                            List of bus route information                                                                            |
|        busNo        | string |                                                                                      Bus number                                                                                     |
|        busID        |   int  |                                                                                     Bus route ID                                                                                    |
|      localBusID     | string | Local Bus Route ID Metropolitan area: busCityCode of 1000 Seoul and Gyeonggi Province Use Real-Time Ulsan City: Provide both up and down route ID on one route Ex) Up/Down ID type. |
|         type        |   int  |                                                     Type of bus route Refer to the bus route type at the bottom of the document                                                     |
|     busCityName     | string |                                                                      Transportation company approved city name                                                                      |
|     busCityCode     |   int  |                                                                      Transportation company approved city code                                                                      |
|    busStartPoint    | string |                                                                          the starting point of a bus route                                                                          |
|     busEndPoint     | string |                                                                            the last stop of the bus route                                                                           |
|     busFirstTime    | string |                                                                                    First bus time                                                                                   |
|     busLastTime     | string |                                                                                    Last bus time                                                                                    |
|     busInterval     | string |                                                                      Interval (minutes) or number of trips (#1)                                                                     |
|     mainBusStop     | string |                                                                                   a major bus stop                                                                                  |
|  bus\_Ep\_FirstTime | string |                                                                         The first bus based on the last stop                                                                        |
|  bus\_Ep\_LastTime  | string |                                                                           Last bus based on the last stop                                                                           |
| bus\_Interval\_Week | string |                                                                              Weekday dispatch interval                                                                              |
|  bus\_Interval\_Sat | string |                                                                              Saturday dispatch interval                                                                             |
|  bus\_Interval\_Sun | string |                                                                          Sunday (holiday) dispatch interval                                                                         |
|  busCompanyNameKor  | string |                                                                             Transportation company name                                                                             |
|     busCompanyID    | string |                                                                              Transportation company ID                                                                              |

### Response Sample

```javascript
{
	"result": {
		"totalCityList": {
			"includeCity": [
				{
					"cityName": "서울",
					"CID": 1000
				}
			]
		},
		"totalCount": 1,
		"lane": [
			{
				"busNo": "6632",
				"busID": 1499,
				"localBusID": "100100309",
				"type": 12,
				"busCityName": "서울",
				"busCityCode": 1000,
				"busStartPoint": "강서공영차고지",
				"busEndPoint": "당산역",
				"busFirstTime": "04:30",
				"busLastTime": "23:00",
				"busInterval": "10",
				"bus_Interval_Week": "10",
				"bus_Interval_Sat": "11",
				"bus_Interval_Sun": "14",
				"busCompanyNameKor": "공항버스",
				"busCompanyID": "80"
			}
		]
	}
}
```
