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 10:57]
hari [Response if request is successful]
@@ Line 1043: / Line 1043: @@
 API call
 <code>
+GET https://tfy.tech101.in/api/v1/trips
 </code>
@@ Line 1048: / Line 1049: @@
 <code>
 Authorization: Bearer user-token
-Content-Type: application/json
-</code>
-Body
-<code>
 </code>
@@ Line 1064: / Line 1060: @@
 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 if token is invalid ====
+==== Response when request is successful, but there are no trips ====
 Headers
 <code>
-HTTP/1.1 401 INVALID-TOKEN
+HTTP/1.1 204 DONE
 </code>
-==== Response if forbidden ====
+==== Response if token is invalid ====
 Headers
 <code>
-HTTP/1.1 403 FORBIDDEN
+HTTP/1.1 401 INVALID-TOKEN
 </code>
-==== Response if fields are missing or invalid ====
+==== Response if forbidden ====
 Headers
 <code>
-HTTP/1.1 400 INVALID-<field-name>
+HTTP/1.1 403 FORBIDDEN
-Content-Type: text/plain
 </code>
-Body
-<code>
-Validation error specific to the error in the field
-</code>
-==== Response if underlying objects don't exist ====
-Headers
-<code>
-HTTP/1.1 404 <object-type>-NOT-FOUND
-</code>
 ==== Response for any other error ====

DokuWiki

Site Tools

Differences

Page Tools