Skip to content

ptServer train

Jan Horacek edited this page Dec 23, 2020 · 2 revisions

PT server :: Soupravy

Endpointy

GET /trains

  • Endpoint vrací všechny jízdní cesty.
  • Parametry: žádné

GET /trains/id

  • Endpoint vrací soupravu id.
  • Parametry: žádné

PUT /trains/id

  • Změnit soupravu id.
  • V požadavku nemusí být všechny parametry soupravy.
  • Musí být vyplněno: name.
  • Endpoint vrací plnou specifikaci upravené soupravy (to stejné jako GET).
    • Hnací vozidla nemusí být vrácena upravená, jejich úprava chvíli trvá (je možné se po cca 1-3 s dotázat GET).

POST /trains/id

  • Vytvořit novou soupravu jména id
  • V požadavku je možné zqadat všechny parametry soupravy, nezadané jsou nahrazeny výchozími hodnotami.
  • Speciální položka: createPos = index pozice, kam soupravu na koleji vytvořit (defualt 0 = před všechny stávající soupravy = blíže začátku trati).
  • Endpoint vrací plnou specifikaci nové soupravy (to stejné jako GET).

DELETE /trains/id

  • Smazat soupravu id.

GET /trains/id/podj/blokid

  • Endpoint vrací předvídaný odjezd soupravy id na bloku blokid.
  • Parametry: žádné

PUT /trains/id/podj/blokid

  • Požadavek o přidání/změně/smazání předvídaného odjezdu vlaku id na bloku blokid.
  • Odpovědí je předvídaný odjezd.
  • Parametry: PODJ jako v GET odpovědi.
  • Blok musí být úsek a měl by být staniční kolej.