API – linie

Informacje o liniach komunikacji miejskiej.

• Endpoint: GET https://www.zditm.szczecin.pl/api/v1/lines
• Typ danych: application/json
• Częstotliwość aktualizacji: w miarę potrzeb

Struktura danych

{
  "data": [
    {
      "id": 1,
      "number": "1",
      "type": "day",
      "subtype": "normal",
      "vehicle_type": "tram",
      "on_demand": false,
      "highlighted": false,
      "sort_order": 1,
      "updated_at": "2023-05-28T11:45:15.000000Z"
    },
    ...
  ]
}

• int id – identyfikator linii (niezmienny)
• string number – oznaczenie (numer) linii (może ulegać zmianom)
• string type – typ linii:
  • day – linia dzienna
  • night – linia nocna
• string subtype – podtyp linii:
  • normal – linia zwykła
  • semi-fast – linia przyspieszona
  • fast – linia pospieszna
  • replacement – linia zastępcza
  • additional – linia dodatkowa
  • special – linia specjalna
  • tourist – linia turystyczna
• string vehicle_type – rodzaj trakcji:
  • skm – pociąg SKM
  • tram – tramwaj
  • bus – autobus
• bool on_demand – wartość true, jeśli linia funkcjonuje w ramach systemu transportu na żądanie
• bool highlighted – wartość true, jeśli linia wyróżniona jest na materiałach informacji pasażerskiej pomarańczowym kolorem (kursuje na zmienionej trasie lub jest linią zastępczą)
• int sort_order – liczba porządkowa ułatwiająca prezentację linii w sposób posortowany (numeracja zwracana w tym polu nie musi mieć zachowanej ciągłości)
• string updated_at – moment ostatniej aktualizacji danych

Informacje ogólne

1. Dane udostępniane są bezpłatnie, do wykorzystania w dowolnym celu, a ich użycie nie wymaga wcześniejszego zgłoszenia.
2. Zarząd Dróg i Transportu Miejskiego w Szczecinie nie gwarantuje, że udostępniane dane są prawidłowe i kompletne. Nie ponosi również odpowiedzialności za szkody lub niewłaściwe decyzje podjęte na ich podstawie.
3. W produkcie korzystającym z danych (aplikacja, strona internetowa, publikacja itp.) zalecane jest podanie źródła danych, tj. Zarząd Dróg i Transportu Miejskiego w Szczecinie lub – w formie skróconej – ZDiTM Szczecin.
4. W produkcie korzystającym z danych (aplikacja, strona internetowa, publikacja itp.) zalecane jest – jeżeli jest to możliwe – umieszczenie odsyłacza do niniejszej strony lub do strony głównej.
5. Klient powinien rozpoznawać i honorować nagłówki HTTP Cache-Control i ETag.
6. Liczba żądań do API jest limitowana. Limit jest wspólny dla wszystkich endpointów i wynosi 6000 żądań na godzinę na adres IP. Nagłówek X-RateLimit-Remaining zawiera liczbę żądań pozostałych w ramach dostępnego limitu. Po wyczerpaniu limitu zwracany jest kod odpowiedzi HTTP 429. Nagłówek odpowiedzi X-RateLimit-Reset zawiera wówczas uniksowy timestamp równy czasowi zresetowania limitu, a nagłówek Retry-After zawiera liczbę sekund pozostałych do zresetowania limitu.
7. Jeżeli to możliwe, w nagłówku User-Agent żądania należy umieścić informację o podmiocie korzystającym z danych (np. nazwa aplikacji, strony internetowej, adres URL).
8. W przypadku nadmiernego obciążania serwera ZDiTM Szczecin zastrzega sobie prawo do częściowego lub całkowitego zablokowania dostępu do API.