Completed webGetRoutesDetailsAndStops, webRouteDetails, webRoutesForStop

gph03n1x · Jul 13, 2016 · e045d88 · e045d88
1 parent 2fb0b7b
commit e045d88
Show file tree

Hide file tree

Showing 4 changed files with 98 additions and 1 deletion.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -9,6 +9,10 @@ Welcome to OASA Telematics API's documentation!
 The api has the following form ::
    http://telematics.oasa.gr/api/?act=action&p1=parameter1&p2=parameter2
 
+Μέσα από το `script`_ το οποίο χρησιμοποιούν στο http://telematics.oasa.gr/
+τα requests που έχω τεκμηριώσει ως τώρα είναι **POST** requests τα οποία περνάνε
+τις παραμέτρους στο url .
+
 
 Actions:
 
@@ -33,7 +37,7 @@ Actions:
    getStopNameAndXY
    getSchedLines
 
-
+.. _script: http://telematics.oasa.gr/js/script.js
 
 Indices and tables
 ==================

diff --git a/docs/source/webGetRoutesDetailsAndStops.rst b/docs/source/webGetRoutesDetailsAndStops.rst
@@ -1,2 +1,35 @@
 webGetRoutesDetailsAndStops
 ===========================
+
+Επιστρέφει τις λεπτομέρειες της διαδρομής (Δεν είμαι σίγουρος σε τι χρησιμεύει αυτό) και τις στάσεις.
+Χρειαζόμαστε και μια παράμετρο που είναι το *routecode* δηλαδή ο κώδικας μιας διαδρομής.
+Στο παράδειγμα εμφανίζονται τα απότελέσματα του webGetRoutesDetailsAndStops της διαδρομής ΠΕΙΡΑΙΑΣ-ΒΟΥΛΑ (routecode=2045)
+
+**Api Endpoint:**
+
+``http://telematics.oasa.gr/api/?act=webGetRoutesDetailsAndStops&p1=routecode``
+
+**Response:**
+
+.. code-block:: python
+
+   {
+   "details": [
+      {"routed_x":"23.63272","routed_y":"37.93851","routed_order":"1"},
+      {"routed_x":"23.6326","routed_y":"37.93851","routed_order":"2"},
+      ....
+   ],
+   "stops": [
+      {
+      "StopCode":"10183","StopID":"25","StopDescr":"\u03a0\u0395\u0399\u03a1\u0391\u0399\u0391\u03a3",
+      "StopDescrEng":"PEIRAIAS","StopStreet":null,"StopStreetEng":null,"StopHeading":"93","StopLat":"37.938246",
+      "StopLng":"23.6320605","RouteStopOrder":"1","StopType":"0","StopAmea":"0"
+      },
+      {
+      "StopCode":"400191","StopID":"400191","StopDescr":"\u039a\u039b\u0395\u0399\u03a3\u039f\u0392\u0397\u03a3",
+      "StopDescrEng":"KLEISOVIS","StopStreet":"\u039a\u039b\u0395\u0399\u03a3\u039f\u0392\u0397\u03a3",
+      "StopStreetEng":null,"StopHeading":"165","StopLat":"37.9361702","StopLng":"23.6328014",
+      "RouteStopOrder":"2","StopType":"0","StopAmea":"0"
+      },
+      ....
+   ]}
diff --git a/docs/source/webRouteDetails.rst b/docs/source/webRouteDetails.rst
@@ -1,2 +1,21 @@
 webRouteDetails
 ===============
+
+Επιστρέφει τις λεπτομέρειες της διαδρομής (Δεν είμαι σίγουρος σε τι χρησιμεύει αυτό).
+Χρειαζόμαστε και μια παράμετρο που είναι το *routecode* δηλαδή ο κώδικας μιας διαδρομής.
+Στο παράδειγμα εμφανίζονται τα απότελέσματα του webRouteDetails της διαδρομής ΠΕΙΡΑΙΑΣ-ΒΟΥΛΑ (routecode=2045)
+
+**Api Endpoint:**
+
+``http://telematics.oasa.gr/api/?act=webRouteDetails&p1=routecode``
+
+**Response:**
+
+.. code-block:: python
+
+   [
+   {"routed_x":"23.63272","routed_y":"37.93851","routed_order":"1"},
+   {"routed_x":"23.6326","routed_y":"37.93851","routed_order":"2"},
+   {"routed_x":"23.63233","routed_y":"37.93833","routed_order":"3"},
+   ....
+   ]
diff --git a/docs/source/webRoutesForStop.rst b/docs/source/webRoutesForStop.rst
@@ -1,2 +1,43 @@
 webRoutesForStop
 ================
+
+Επιστρέφει πληροφορίες σχετικά με μια στάση.
+Χρειαζόμαστε και μια παράμετρο που είναι το *stopcode* δηλαδή ο κώδικας μιας στάσης.
+Για να τον βρούμε μπορούμε να χρησιμοποιήσουμε την webGetStops.
+Στο παράδειγμα εμφανίζονται τα απότελέσματα του webRoutesForStop της στάσης ΗΣΑΠ Ν.ΦΑΛΗΡΟΥ (stopcode=400075)
+
+**Api Endpoint:**
+
+``http://telematics.oasa.gr/api/?act=webRoutesForStop&p1=stopcode``
+
+**Response:**
+
+.. code-block:: python
+
+   [
+   {
+   "RouteCode":"1867",
+   "LineCode":"851",
+   "RouteDescr":"\u03a0\u0395\u0399\u03a1\u0391\u0399\u0391\u03a3 - \u039d. \u03a3\u039c\u03a5\u03a1\u039d\u0397",
+   "RouteDescrEng":"PEIRAIAS - NEA SMYRNI",
+   "RouteType":"1",
+   "RouteDistance":"22205.03",
+   "LineID":"130",
+   "LineDescr":"\u03a0\u0395\u0399\u03a1\u0391\u0399\u0391\u03a3 - \u039d. \u03a3\u039c\u03a5\u03a1\u039d\u0397 (\u039a\u03a5\u039a\u039b\u0399\u039a\u0397)",
+   "LineDescrEng":"PEIRAIAS - NEA SMIRNI",
+   "MasterLineCode":"202"
+   },
+   {
+   "RouteCode":"1881",
+   "LineCode":"871",
+   "RouteDescr":"\u03a0\u0395\u0399\u03a1\u0391\u0399\u0391\u03a3 - \u0391\u039d\u03a9 \u0393\u039b\u03a5\u03a6\u0391\u0394\u0391",
+   "RouteDescrEng":"PEIRAIAS - ANO GLYFADA",
+   "RouteType":"1",
+   "RouteDistance":"21369.72",
+   "LineID":"\u03921",
+   "LineDescr":"\u03a0\u0395\u0399\u03a1\u0391\u0399\u0391\u03a3 - \u0391\u039d\u03a9 \u0393\u039b\u03a5\u03a6\u0391\u0394\u0391",
+   "LineDescrEng":"PEIRAIAS - ANO GLYFADA",
+   "MasterLineCode":"59"
+   },
+   ....
+   ]