Differences

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

--- api-trucks-for-you [2018/08/02 11:01]
hari [Response for any other error]
+++ api-trucks-for-you [2018/08/13 11:53] (current)
103.226.237.56 [Response for a successful request]
@@ Line 1: / Line 1: @@
 ======== Trucks for You API ========
-<hidden>
 ====== Creation and registration ======
@@ Line 29: / Line 29: @@
 <code>
 HTTP/1.1 202 ACCEPTED
+</code>
+Body: none
+==== Response if phone parameter is missing ====
+Headers
+<code>
+HTTP/1.1 400 INVALID-PHONE
 </code>
@@ Line 651: / Line 660: @@
 </code>
-</hidden>
 ====== Administration ======
 ===== Admin: List of trip requests =====
@@ Line 1129: / Line 1137: @@
 API call
 <code>
+POST https://tfy.tech101.in/api/v1/trips
 </code>
@@ Line 1139: / Line 1148: @@
 Body
 <code>
+{
+  "truckId": "uuid-of-truck",
+  "source": {
+    "date": "YYYY-MM-DD, date when truck leaves source",
+    "cityId": "uuid-of-city-from-where-truck-leaves"
+  },
+  "destination": {
+    "date": "YYYY-MM-DD, date when truck reaches destination",
+    "cityId": "uuid-of-city-where-truck-reaches"
+  }
+}
 </code>
@@ Line 1150: / Line 1170: @@
 Body
 <code>
+{
+  "id": "uuid-of-trip",
+  "truck": {
+    "id": "uuid-of-truck",
+    "registration": "registration-number-of-truck"
+  },
+  "source": {
+    "date": "YYYY-MM-DD, date when truck leaves source",
+    "city": {
+      "id": "uuid-of-city",
+      "name": "name-of-city-from-where-truck-leaves"
+    }
+  },
+  "destination": {
+    "date": "YYYY-MM-DD, date when truck reaches destination",
+    "city": {
+      "id": "uuid-of-city",
+      "name": "name-of-city-where-truck-reaches"
+    }
+  }
+}
 </code>
-==== Response if request is successful, but there are no objects to return ====
-Headers
-<code>
-HTTP/1.1 204 DONE
-</code>
 ==== Response if token is invalid ====

DokuWiki

Site Tools

Differences

Page Tools