Introduction
The API consists of a number of interfaces, all of which are called using normal HTTP GET requests to openbizkaibus.appspot.com/api/ and return a response in JSON format if successful. HTTP status codes are used for returning error information and parameters are passed using standard URL conventions.This API allow developers to bypass the Byzkaibus official SOAP interface. So openBizkaibus make easyer to integrate Bizkaubus related services with third party technologies.
API Functions
Consultar_FamiliasCentros
This function returns the actual list of towns available, where Bizkaibus service actually works on.
Request
http://openbizkaibus.appspot.com/api/Consultar_FamiliasCentros
Response
[
{
"DescripcionGrupo": Description,
"Registros":
[
{
"CodigoElemento": Id,
"DescripcionElemento": Name
},
...
...
..
{
"CodigoElemento": Id,
"DescripcionElemento": Name
}
],
"CodigoGrupo": Id
}
]
LineasMunicipio
This function returns a list of lines that pass through a given town.
Request
http://openbizkaibus.appspot.com/api/LineasMunicipio?codmunicipio=[muniId]&descmunicipio=[muniDesc]
| Param | Type | Description |
|---|---|---|
| muniId | Obligatory | The ID that identifies the Town |
| muniDesc | Optional | The text description that identifies the Town |
Response
[
{
"DenominacionLinea": Name,
"DenominacionRelativaLinea": RelativeName,
"CodigoLinea": LineId
},
...
...
...
{
"DenominacionLinea": Name,
"DenominacionRelativaLinea": RelativeName,
"CodigoLinea": LineId
},
]
ParadasLinea
This function returns the actual list of stops for each Line depending on journey direction.
Request
http://openbizkaibus.appspot.com/api/ParadasLinea?codLinea=[codLinea]&sentido=[direction]
| Param | Type | Description |
|---|---|---|
| codLinea | Obligatory | The ID that identifies the Line |
| direction | Obligatory | The direction of the journey. I for outward direction and V for way back |
Response
[
{
"Latitud": latitude,
"NombreParada": stopName,
"Municipio": townName,
"Longitud": longitude,
"CodigoLinea": lineCode
},
...
...
...
{
"Latitud": latitude,
"NombreParada": stopName,
"Municipio": townName,
"Longitud": longitude,
"CodigoLinea": lineCode
}
]
GetPasoParada
This function returns information about arrival time and distance for each bus that arrives this stop.
Request
http://openbizkaibus.appspot.com/api/GetPasoParada?codparada=[stopCode]
| Param | Type | Description |
|---|---|---|
| stopCode | Obligatory | The ID that identifies the Stop |
Response
[
{
"Tiempos": [
{
"minutos": elapsedTime,
"metros": elapsedDistance,
"tipo": type
},
{
"minutos": elapsedTime,
"metros": elapsedDistance,
"tipo": type
}
],
"Parada": stopCode,
"Ruta": ruteDescription,
"Linea": lineCode
},
...
...
...
{
"Tiempos": [
{
"minutos": elapsedTime,
"metros": elapsedDistance,
"tipo": type
},
{
"minutos": elapsedTime,
"metros": elapsedDistance,
"tipo": type
}
],
"Parada": stopCode,
"Ruta": ruteDescription,
"Linea": lineCode
}
]
LineasLineaWEB
This function returns extended infromation about the Line.
Request
http://openbizkaibus.appspot.com/api/LineasLineaWEB?codlinea=[lineCode]&desclinea=[lineDesc]
| Param | Type | Description |
|---|---|---|
| lineCode | Obligatory | The ID that identifies the Line |
| lineDesc | Optional | The text description that identifies the Line |
Response
{
"DenominacionLinea": Description,
"CodigoLinea": Lineid
}
Buscar_TextoHorarioLinea
This function returns the information of bus schedules for each Line.
Request
http://openbizkaibus.appspot.com/api/Buscar_TextoHorarioLinea?codlinea=[codLinea]&numruta=[numbRoute]
| Param | Type | Description |
|---|---|---|
| codLinea | Obligatory | The ID that identifies the Line |
| numbRoute | Optional | The ID that identifies the posible routes |
Response
{
"TextoVuelta": BackText,
"TextoIda": GoText,
"TipoHorario": Season
}