Differences

This shows you the differences between two versions of the page.

--- api-trucks-for-you [2018/08/02 10:38]
hari [Response for any other error]
+++ api-trucks-for-you [2018/08/02 11:01]
hari [Response if request is successful, but there are no objects to return]
@@ Line 1038: / Line 1038: @@
 ===== Admin: List all determined trips =====
+==== Request ====
+API call
+<code>
+GET https://tfy.tech101.in/api/v1/trips
+</code>
+Headers
+<code>
+Authorization: Bearer user-token
+</code>
+==== Response if request is successful ====
+Headers
+<code>
+HTTP/1.1 200 OK
+</code>
+Body
+<code>
+[
+  {
+    "id": "uuid-of-trip",
+    "truck": {
+      "id": "uuid-of-truck",
+      "registration": "registration-number"
+    },
+    "source":{
+      "date": "YYYY-MM-DD, date when truck leaves source",
+      "city": {
+        "id": "uuid-of-city",
+        "name": "name-of-city"
+      },
+    },
+    "destination": {
+      "date": "YYYY-MM-DD, date when truck reaches destination",
+      "city": {
+        "id": "uuid-of-city",
+        "name": "name-of-city"
+      }
+    }
+  },
+  { ... more trips ... }
+]
+</code>
+==== Response when request is successful, but there are no trips ====
+Headers
+<code>
+HTTP/1.1 204 DONE
+</code>
+==== Response if token is invalid ====
+Headers
+<code>
+HTTP/1.1 401 INVALID-TOKEN
+</code>
+==== Response if forbidden ====
+Headers
+<code>
+HTTP/1.1 403 FORBIDDEN
+</code>
+==== Response for any other error ====
+Headers
+<code>
+HTTP/1.1 500 ERROR
+Content-Type: text/plain
+</code>
+Body
+<code>
+Sample error message
+</code>
+===== Admin: Create a new trip =====
 ==== Request ====
@@ Line 1065: / Line 1151: @@
 <code>
 </code>
 ==== Response if token is invalid ====

DokuWiki

Site Tools

Differences

Page Tools