Upozornění: Text přílohy byl získán strojově a nemusí přesně odpovídat originálu. Zejména u strojově nečitelných smluv, kde jsme použili OCR. originál smlouvy stáhnete odsud
API pro DPO APC
Verze 07102025
Tento dokument a API je určená jen pro použití v DPO a prostředí PowerBI, nikoliv pro poskytnutí
třetím stranám.
Popis API pro získání APC dat DP Ostrava.
API poskytuje požadované informace dle zadávací dokumentace o počítání cestujících pro každý vůz.
Pro autorizaci je API chráněna přístupovým jménem a heslem. Mechanizmus autorizace a autentifikace jsou
JWT strings. Popis endpointů pro JWT autorizaci a autentifikaci uživatelů je popsán v samostatném
dokumentu.
Dokumentace API je uvedena na příkladech, které nemusí odpovídat realitě
provozu a konfigurace vozů.
Archiv APC
Endpoint pro stahování APC dat z databáze, dle zadávací dokumentace. Tento endpoint je určen pouze pro DP
Ostrava, jelikož se jedná o rozhraní mezi APC systémem samotným a PowerBI prostředním v DP Ostrava.
Vzhledem k předpokládané velké zátěži při stahování záznamů, je přístup na API omezen na jednoho
aktivního uživatele.
Korektní přihlášení na daný JWT enpoint ( viz samostatný dokument ) je signalizováno vrácených HTTP 200 Ok
statusem a vygenerovanými přístupovými klíči.
Maximální frekvence dotazů na API je jeden dotaz za 2 secs na přihlášený session.
Pokud je tento limit překročen, je vracena chyba HTTP 403 Forbidden. V případě připojení velkého počtu
klientů a častých dotazů, bude tento interval prodloužen.
Maximální počet záznamů, které je možné při jednom čtení z endpointu vyčíst je 10000.
Strana 1 / 17
Archiv APC dat API
Endpoint poskytuje data spojená s vyhodnocením počtů cestujících.
Endpoint je chráněn JWT autorizací
Endpoint podporuje filtraci v URL
Omezení na 10000 vrácených záznamů
API pro APC archiv je REST API, HTTP GET request na daný endpoint vrací vždy JSON string. Pokud dojde k
chybě, je vrácen i HTTP error status.
Endpoint pro APC data DP Ostrava
https://dpostrava.buse.cz/apccustomers/api/publicapi/protected/apc/archive/
HTTP 200 OK response - pro příklad a obsáhlost odpovědi je uveden jen jeden konkrétní záznam
{
"data": [
{
"apc_record_id": "8540121320252823142846717",
"created_on": "2025-04-23T14:29:03.375",
"received_on": "2025-04-23T14:29:06.454216",
"from_archive": null,
"vehicle_name": "1213",
"vehicle_type": "ŠKODA LTM 10.08",
"line_name": "12V",
"line_no": 332,
"direction": 2280,
"drive_order": 12,
"course": "255",
"course_full":"012/255",
"station_number": 53801,
"station_node": 538,
"station_banister": 1,
"station_name": "Daliborova",
"station_order": 3,
"station_unhandled": null,
"terminal_station": null,
"station_on_request_only": null,
"destination_number": 1,
"destination_name": "Hlavní nádraží",
"last_station_number": 101,
"last_station_name": "Hlavní nádraží",
"scheduled_departure": "2025-04-23T14:28:00",
"arrival_tm": "2025-04-23T14:28:46",
"departure_tm": "2025-04-23T14:29:02",
"get_in": 0,
"get_out": 2,
"inside": 4,
Strana 2 / 17
"get_in_adults": 0,
"get_out_adults": 2,
"get_in_children": 0,
"get_out_children": 0,
"get_in_bike": 0,
"get_out_bike": 0,
"get_in_wheels": 0,
"get_out_wheels": 0,
"inside_adults": 4,
"inside_children": 0,
"inside_bike": 0,
"inside_wheels": 0,
"get_in_adults_door1": 0,
"get_out_adults_door1": 2,
"get_in_children_door1": 0,
"get_out_children_door1": 0,
"get_in_bike_door1": 0,
"get_out_bike_door1": 0,
"get_in_wheels_door1": 0,
"get_out_wheels_door1": 0,
"get_in_adults_door2": 0,
"get_out_adults_door2": 0,
"get_in_children_door2": 0,
"get_out_children_door2": 0,
"get_in_bike_door2": 0,
"get_out_bike_door2": 0,
"get_in_wheels_door2": 0,
"get_out_wheels_door2": 0,
"get_in_adults_door3": 0,
"get_out_adults_door3": 0,
"get_in_children_door3": 0,
"get_out_children_door3": 0,
"get_in_bike_door3": 0,
"get_out_bike_door3": 0,
"get_in_wheels_door3": 0,
"get_out_wheels_door3": 0,
"get_in_adults_door4": 0,
"get_out_adults_door4": 0,
"get_in_children_door4": 0,
"get_out_children_door4": 0,
"get_in_bike_door4": 0,
"get_out_bike_door4": 0,
"get_in_wheels_door4": 0,
"get_out_wheels_door4": 0,
"get_in_adults_door5": 0,
"get_out_adults_door5": 0,
"get_in_children_door5": 0,
"get_out_children_door5": 0,
"get_in_bike_door5": 0,
"get_out_bike_door5": 0,
"get_in_wheels_door5": 0,
"get_out_wheels_door5": 0,
"get_in_adults_door6": 0,
"get_out_adults_door6": 0,
Strana 3 / 17
"get_in_children_door6": 0,
"get_out_children_door6": 0,
"get_in_bike_door6": 0,
"get_out_bike_door6": 0,
"get_in_wheels_door6": 0,
"get_out_wheels_door6": 0,
"get_in_adults_door7": 0,
"get_out_adults_door7": 0,
"get_in_children_door7": 0,
"get_out_children_door7": 0,
"get_in_bike_door7": 0,
"get_out_bike_door7": 0,
"get_in_wheels_door7": 0,
"get_out_wheels_door7": 0,
"get_in_adults_door8": 0,
"get_out_adults_door8": 0,
"get_in_children_door8": 0,
"get_out_children_door8": 0,
"get_in_bike_door8": 0,
"get_out_bike_door8": 0,
"get_in_wheels_door8": 0,
"get_out_wheels_door8": 0
}
],
"status": "ok",
"detail": "",
"error": false
}
Popis properties z přijaté odpovědi APC archiv
Property Typ Default Popis
apc_record_id string ID záznamu, generovaného při založení záznamu ve
voze. Složení Číslo řidiče, číslo vozu, timestamp.
created_on timestamp null
received_on timestamp Zůstává unikátní i po přegenrování databáze APC
from_archive bool? záznamů.
vehicle_name string
vehicle_type string null Založení záznamu, start počítání
line_name string
line_no int null Přijetí záznamu na server
direction int
True == záznam byl vozu doposlán později, z
null
uloženého archivu ve voze
null Evidenční číslo vozu
null Typ vozu
null Označení linky z palubního počítače
0 Číslo linky z palubního počítače
0 Číslo směru z palubního počítače
Strana 4 / 17
Property Typ Default Popis
drive_order int null Pořadí jízdy z PP - statická linka
course string null Označení kurzu z palubního počítače
course_full string Označení kurzu spolu s pořadím jízdy ve tvaru xxx/yyy
null
dle DPO
station_number int 0 Celé číslo stanice k APC záznamu
station_node int 0 Uzel stanice k APC záznamu
station_banister int 0 Číslo sloupku stanice k APC záznamu
station_name string 0 Jméno stanice
station_order int 0 Pořadí stanice na jízdě, index 0 až n-1 , kde n = počet
stanic na jízdě dle PP
station_unhandled bool? True == na této stanici nebylo provedeno počítání,
null
dveře neotevřeny
terminal_station bool? True == Konečná stanice, po této stanici jsou countery
null
počtů nulovány
station_on_request_only bool? null True == Stanice je na vyžádání
destination_number int 0 Kód cíle
destination_name string null Název cíle
last_station_number int 0 Kód poslední stanice na trase
last_station_name string null Jméno poslední stanice na trase
scheduled_departure timestamp null Příjezd do stanice dle grafikonu
arrival_tm timestamp null Skutečný příjezd do stanice, případně otevření dveří
mimo stanici, při neodbaveni založení záznamu.
departure_tm timestamp null Ukončení počítání zavřením dveří, případně uzavření
záznamu pčři nevystupování cestujících.
get_in int 0 Celkový počet nástupů osob, tedy dospělí + děti
get_out int 0 Celkový počet výstupů osob, tedy dospělí + děti
inside int 0 Celkový počet osob ve voze, tedy dospělí + děti
get_in_adults int 0 Celkový počet nástupů dospělích
get_out_adults int 0 Celkový počet výstupů dospělích
get_in_children int 0 Celkový počet nástupů dětí
get_out_children int 0 Celkový počet výstupů dětí
get_in_bike int 0 Celkový počet nástupů kola a koloběžky
Strana 5 / 17
Property Typ Default Popis
get_out_bike
get_in_wheels int 0 Celkový počet výstupů kola a koloběžky
get_out_wheels
inside_adults int 0 Celkový počet nástupů kočárky a invalidní vozík
inside_children
inside_bike int 0 Celkový počet výstupů kočárky a invalidní vozík
inside_wheels
int 0 Celkový počet dospělích ve voze
int 0 Celkový počet dětí ve voze
int 0 Celkový počet kola a koloběžky ve voze
int 0 Celkový počet kočárky a kola ve voze
get_in_adults_door1 int 0 Počet nástupů dopělích prvními dveřmi
get_out_adults_door1 int 0 Počet výstupů dopělích prvními dveřmi
get_in_children_door1 int 0 Počet nástupů dětí prvními dveřmi
get_out_children_door1 int 0 Počet výstupů dětí prvními dveřmi
get_in_bike_door1 int 0 Počet nástupů kola a koloběžky prvními dveřmi
get_out_bike_door1 int 0 Počet výstupů kola a koloběžky prvními dveřmi
get_in_wheels_door1 int Počet nástupů kočárky a invalidní vozík prvními
0
dveřmi
get_out_wheels_door1 int 0 Počet výstupů kočárky a invalidní vozík prvními dveřmi
...
get_in_adults_door8 int 0 Počet nástupů dopělích osmími dveřmi
get_out_adults_door8 int 0 Počet výstupů dopělích osmími dveřmi
get_in_children_door8 int 0 Počet nástupů dětí osmími dveřmi
get_out_children_door8 int 0 Počet výstupů dětí osmími dveřmi
get_in_bike_door8 int 0 Počet nástupů kola a koloběžky osmími dveřmi
get_out_bike_door8 int 0 Počet výstupů kola a koloběžky osmími dveřmi
get_in_wheels_door8 int 0 Počet nástupů kočárky a invalidní vozík osmími dveřmi
get_out_wheels_door8 int 0 Počet výstupů kočárky a invalidní vozík osmími dveřmi
Properties
typu bool mohou nabávat hodnoty null
typu timestamp jsou ve formátu ISO 8601 jako local time bez uvedení timezone
Strana 6 / 17
Archiv dat sensorů API
Endpoint poskytuje data spojená s chybami a statusy sensorů ve vozech. Poskytuje všechny statusy
chyb sensorů.
Endpoint je chráněn JWT autorizací
Endpoint podporuje filtraci v URL
Omezení na 10000 vrácených záznamů
API pro sensor archiv je REST API, HTTP GET request na daný endpoint vrací vždy JSON string. Pokud dojde k
chybě, je vrácen i HTTP error status.
Endpoint pro sensor status data DP Ostrava
https://dpostrava.buse.cz/apccustomers/api/publicapi/protected/sensor/archive/
HTTP 200 OK response - pro příklad a obsáhlost odpovědi je uveden jen jeden konkrétní záznam
{
"data": [
{
"created_on": "2025-04-24T09:54:32.855",
"received_on": "2025-04-24T09:54:34.049061",
"from_archive": false,
"vehicle_name": "1213",
"vehicle_type": "ŠKODA LTM 10.08",
"vehicle_traction": "R",
"sensor_name": "1213-2",
"door_name": "DOOR 2",
"sensor_ip": "192.168.5.52",
"is_active": true,
"closing": false,
"error_code": "SENSOR_PING_UNREACHABLE",
"last_activated_on": "2025-04-24T09:54:32.852",
"last_deactivated_on": null,
"last_duration_text": "00.00:00:00",
"serial_no": "07_287742",
"mac": "0024EA05CD80",
"fw_version": "D6",
"sw_version": "2.1.519.30067",
"vehicle_uptime_text": "00.00:19:41"
}
],
"status": "ok",
"detail": "",
"error": false
}
Popis properties z přijaté odpovědi sensor archiv
Strana 7 / 17
Property Typ Default Popis
created_on timestamp null Založení záznamu, start počítání
received_on timestamp null Přijetí záznamu na server
True == záznam byl vozu doposlán později, z uloženého
from_archive bool? null archivu ve voze
Evidenční číslo vozu dle PP
vehicle_name string null Typ vozu
vehicle_type string null Trakce vozu dle PP
vehicle_traction string null Označení sensoru jako "číslo vozu"-"číslo dveří od kabiny
A"
sensor_name string null Jméno dveří, pořadí od kabiny A
IP adresa sensoru
door_name string null True == chyba je aktivní
sensor_ip string null True == chyba byla právě ukončena
is_active bool? null Kód chyby - vizy samostatné kódy chyb
closing bool? null Aktivace chyby
error_code string null Poslední deaktivace chyby
last_activated_on timestamp null Poslední trvání chyby
last_deactivated_on timestamp null Seriové číslo sensoru
last_duration_text string null MAC adresa sensoru
serial_no string null Verze FW sensoru
mac string null Verze SW sensoru
fw_version string null Uptime vozu
sw_version string null
vehicle_uptime_text string null
Properties
typu bool mohou nabávat hodnoty null
typu timestamp jsou ve formátu ISO 8601 jako local time bez uvedení timezone
Strana 8 / 17
Archiv dat vozů API
Endpoint poskytuje data spojená s chybami a statusy samotných vozů, bez ohledu na sensory ve
vozech.
Endpoint je chráněn JWT autorizací
Endpoint podporuje filtraci v URL
Omezení na 10000 vrácených záznamů
API pro archiv vozů je REST API, HTTP GET request na daný endpoint vrací vždy JSON string. Pokud dojde k
chybě, je vrácen i HTTP error status.
Endpoint pro vehicle status data DP Ostrava
https://dpostrava.buse.cz/apccustomers/api/publicapi/protected/vehicle/archive/
HTTP 200 OK response - pro příklad a obsáhlost odpovědi je uveden jen jeden konkrétní záznam
{
"data": [
{
"created_on": "2025-04-24T13:52:55.398",
"received_on": "2025-04-24T13:52:55.367106",
"from_archive": false,
"vehicle_name": "1213",
"vehicle_type": "ŠKODA LTM 10.08",
"vehicle_traction": "R",
"is_active": true,
"closing": true,
"error_code": "OBC_NO_PROTOCOL",
"last_activated_on": "2025-04-24T13:52:50.235",
"last_deactivated_on": "2025-04-24T13:52:55.396",
"last_duration_text": "00.00:00:05",
"vehicle_uptime_text": "00.00:16:17"
}
],
"status": "ok",
"detail": "",
"error": false
}
Popis properties z přijaté odpovědi vehicle archiv
Property Typ Default Popis
created_on timestamp null Založení záznamu, start počítání
received_on timestamp null Přijetí záznamu na server
Strana 9 / 17
Property Typ Default Popis
True == záznam byl vozu doposlán později, z uloženého
from_archive bool? null archivu ve voze
Evidenční číslo vozu dle PP
vehicle_name string null Typ vozu
vehicle_type string null Trakce vozu dle PP
vehicle_traction string null True == chyba je aktivní
is_active bool? null True == chyba byla právě ukončena
closing bool? null Kód chyby - vizy samostatné kódy chyb
error_code string null Aktivace chyby
last_activated_on timestamp null Poslední deaktivace chyby
last_deactivated_on timestamp null Poslední trvání chyby
last_duration_text string null Uptime vozu
vehicle_uptime_text string null
Properties
typu bool mohou nabávat hodnoty null
typu timestamp jsou ve formátu ISO 8601 jako local time bez uvedení timezone
Strana 10 / 17
Chybové kódy
Chybové kódy vozu
Kód Význam
GATE_PING_UNREACHABLE Nedostupný modem
NO_DOOR_COUNT Neznámý počet dveř
NO_SENSOR_CONFIG_JSON_STRING Nenačtena konfigurace ze serveru
NO_SENSOR_COUNT Neznámý počet sensorů
NO_VEHICLE_CONFIG Neznámá konfigurace vozu
NO_VEHICLE_TYPE Neznámý typ vozu
OBC_NO_PROTOCOL Není PP protokol
OBC_PING_UNREACHABLE Nedostupný PP
SERVER_MESSAGES_FAILED Nedoručeno na server
SERVER_PING_UNREACHABLE Nedostupný server
SLAVE_HAS_NO_MASTER Není komunikace z master device
Chybové kódy samotného sensoru
Kód Význam
SENSOR_MESSAGE_ERROR Komunikace sensoru
SENSOR_PING_UNREACHABLE Nedostupný sensor
SENSOR_SABOTAGE Sabotage
Strana 11 / 17
Archiv dat SLA API
Endpoint poskytuje data spojená s SLA vyhodnocením spolehlivosti
Endpoint je chráněn JWT autorizací
Endpoint podporuje filtraci v URL
Omezení na 1000 vrácených záznamů
API pro SLA je REST API, HTTP GET request na daný endpoint vrací vždy JSON string. Pokud dojde k chybě, je
vrácen i HTTP error status.
SLA zpráva je z vozidla odesílána každých 5 minut nebo při změně stavu, který SLA ovlivňuje ( chyby vozu,
chyby sensorů ).
Endpoint pro SLA data DP Ostrava
https://dpostrava.buse.cz/apccustomers/api/publicapi/protected/sla/state/
HTTP 200 OK response - pro příklad a obsáhlost odpovědi je uveden jen jeden konkrétní záznam
{
"data": [
{
"sla_date": "2025-04-25",
"vehicle_name": "3737",
"vehicle_type": "Škoda 26 Tr Solaris",
"vehicle_traction": "T",
"upload_kb": 0,
"download_kb": 0,
"message_count": 3,
"vehicle_error_count": 1,
"sensor_error_count": 0,
"sla_reliability_perc": "99.52",
"in_limit": false
}
],
"status": "ok",
"detail": "",
"error": false
}
Popis properties z přijaté odpovědi vehicle archiv
Property Typ Default Popis
sla_date string not null Den ke kterému je tento záznam vozu vztáhnut
vehicle_name timestamp null Evidenční číslo vozu z PP
Strana 12 / 17
Property Typ Default Popis
vehicle_type string null Typ vozu dle PP
vehicle_traction string null Trakce vozu
upload_kb int 0 Upload z vozu v kB
download_kb int 0 Download do vozu v kB
message_count int 0 Počet SLA zpráv odeslaných z vozidla
sla_reliability_perc decimal 0
Properties
typu bool mohou nabávat hodnoty null
typu timestamp jsou ve formátu ISO 8601 jako local time bez uvedení timezone
Strana 13 / 17
Filtrování na API
API podporuje základní filtrování dle jména properties. Parametry jsou zadávány jako parametry do URL
dotazu HTTP GET dotazu.
Pokud nastavenému filtrování nevyhovuje žádný záznam, je vráceno prázdné pole záznamů
{
"data": [],
"status": "ok",
"detail": "",
"error": false
}
V případě chyby je nastaven status error na true, případně není vrácen status HTTP 200 OK
{
"data": null,
"status": "error",
"detail": "pg_strtoint16_safe",
"error": true
}
Filtrační příkazy jsou demonstrovány na jednoduchých příkladech, jež nejlépe ilustrují syntaxi a práci s filtry.
Filtrační příkazy je možné kombinovat jako URL parametry spojené znakem &
Podporované filtrační příkazy WHERE Pro číselné property jsou podporovány operace
menší než .../publicapi/protected/apc/archive/?where=get_in<10
větší než .../publicapi/protected/apc/archive/?where=get_in>10
menší a rovno než .../publicapi/protected/apc/archive/?where=get_in:<10
větší a rovno než .../publicapi/protected/apc/archive/?where=get_in:>10
rovno .../publicapi/protected/apc/archive/?where=get_in:10
nerovno .../publicapi/protected/apc/archive/?where=get_in!:10
Pro textové property jsou podporovány operace
stejné .../publicapi/protected/apc/archive/?where=vehicle_name:3737
jiné .../publicapi/protected/apc/archive/?where=vehicle_name!:3737
Pro timestamp property jsou podporovány operace
identické .../publicapi/protected/apc/archive/?where=created_on:2025-04-23T14:29:03
mladší .../publicapi/protected/apc/archive/?where=created_on<2025-04-23T14:29:03
starší .../publicapi/protected/apc/archive/?where=created_on>2025-04-23T14:29:03
mladší od půlnoci .../publicapi/protected/apc/archive/?where=created_on<2025-04-23
Strana 14 / 17
starší od půlnoci .../publicapi/protected/apc/archive/?where=created_on>2025-04-23
v rozmezí 23.04.2025 .../publicapi/protected/apc/archive/?where=created_on>2025-04-
23,created_on<2025-04-24
Formát pro filtraci dle timestamp s časem je vždy ve formátu yyyy-MM-dd HH:mm:ss nebo yyyy-MM-
ddTHH:mm:ss. Formát pro filtraci dle timestamp s datem je vždy ve formátů yyyy-MM-dd.
Pro bool property jsou podporovány operace
rovná se .../publicapi/protected/apc/archive/?where=terminal_station:true
nerovná se .../publicapi/protected/apc/archive/?where=terminal_station!:true
zda je null .../publicapi/protected/apc/archive/?where=terminal_station:null
Pro více filtrovaných properties
Filtry jsou uvažovány jako spojení požadavků operací AND .../publicapi/protected/apc/archive/?
where=vehicle_name:3737,inside>5,inside<10
ORDER Pro textové, číselné, timestamp, nebo bool properties je syntaxe řazení stejná
nejmenší po největší .../publicapi/protected/apc/archive/?order=created_on
největší po nejmenší .../publicapi/protected/apc/archive/?order=!created_on
násobné řazení .../publicapi/protected/apc/archive/?order=vehicle_name,!created_on
LIMIT Vrací omezený počet záznamů, které jsou vráceny
maximální počet záznamů .../publicapi/protected/apc/archive/?limit=2
SKIP Jedná se o filtr přeskočení prvních X vrácených záznamů
Přeskoč první záznam .../publicapi/protected/apc/archive/?skip=1
COUNT Vrací se počet záznam, které vyhovují zadaným požadavkům
počet všeho .../publicapi/protected/apc/archive/?count
počet dle filtrů .../publicapi/protected/apc/archive/?where=created_on>2025-04-
23,created_on<2025-04-24&count
počet limitovaných .../publicapi/protected/apc/archive/?limit=12&count
Count jako jediný nevrací v odpovědi v elementu data pole, ale konkrétní počet
.../publicapi/protected/apc/archive/?limit=12&count
{
"data": 12,
"status": "ok",
"detail": "",
"error": false
}
Řetězené filtry
Strana 15 / 17
Filtry je možné skládat za sebou tak, aby byl vráce konrkétní výsledek. Uvedeno několik příkladů
Nejmladších 100 záznamů z vozu 3737
.../publicapi/protected/apc/archive/?where=vehicle_name:3737&limit=100&order=!created_on
Kolik stanic bylo na lince 107 obslouženo dne 2025-04-23
.../publicapi/protected/apc/archive/?where=line_name:107,created_on>2025-04-23,created_on<2025-
04-24&count
Strana 16 / 17
Changelog
Datum Zapsal Poznamka
22.04.2025 Horáček Založení dokumentace DP Ostrava endpointy a API
15.08.2025 Horáček Doplnění driver order a kurzu ve tvaru xxx/yyy
21.08.2025 Horáček Doplnění destination_name a destination_number jako cíl a jeho kód
Doplnění line_no čísla linky, last_station_name a last_station_number jako jméno
26.09.2025 Horáček a číslo poslední stanice
Doplnění pořadí stanice na jízdě station_order
07.10.2025 Horáček
Strana 17 / 17