Differences

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

--- api-trucks-for-you [2018/08/01 11:49]
hari [Response if fields are missing or invalid]
+++ api-trucks-for-you [2018/08/06 10:13]
111.125.228.102
@@ Line 1: / Line 1: @@
 ======== Trucks for You API ========
-<hidden>
 ====== Creation and registration ======
@@ Line 651: / Line 651: @@
 </code>
-</hidden>
 ====== Administration ======
 ===== Admin: List of trip requests =====
@@ Line 913: / Line 912: @@
 API call
 <code>
-POST https://tfy.tech101.in/api/v1/trips
+POST https://tfy.tech101.in/api/v1/bookings
 </code>
@@ Line 935: / Line 934: @@
 <code>
 HTTP/1.1 200 OK
+Content-Type: application/json
 </code>
 Body
 <code>
+{
+  "id": "uuid-of-booking",
+  "hirer": {
+    "id": "uuid-of-hirer",
+    "name": "name-of-hirer",
+    "phone": "phone-number-of-hirer"
+  },
+  "truck": {
+    "id": "uuid-of-truck",
+    "registration": "registration-number-of-truck",
+    "type": {
+      "id": "uuid-of-truck-type",
+      "name": "name-of-truck-type"
+    }
+    , "capacity": capacity-in-tonnes
+  },
+  "driver": {
+    "id": "uuid-of-driver",
+    "name": "name-of-driver",
+    "phone": "phone-number-of-driver"
+  },
+  "plan": {
+    "load": {
+      "date": "YYYY-MM-DD, date of loading",
+      "city": {
+        "id": "uuid-of-city",
+        "name": "name-of-city"
+      },
+      "address": "full-address-of-loading-point"
+    },
+    "delivery": {
+      "date": "YYYY-MM-DD, date of delivery",
+      "city": {
+        "id": "uuid-of-city",
+        "name": "name-of-city"
+      },
+      "address": "full-address-of-delivery-point"
+    }
+  },
+  "tariff": tariff-in-rupees
+}
 </code>
@@ Line 976: / Line 1018: @@
 HTTP/1.1 404 <object-type>-NOT-FOUND
 </code>
+where <object-type> can be one of
+  * HIRE-REQUEST
+  * TRUCK
 ==== Response for any other error ====
@@ Line 989: / Line 1034: @@
 Sample error message
 </code>
+===== 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 ====
+API call
+<code>
+POST https://tfy.tech101.in/api/v1/trips
+</code>
+Headers
+<code>
+Authorization: Bearer user-token
+Content-Type: application/json
+</code>
+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>
+==== 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-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 token is invalid ====
+Headers
+<code>
+HTTP/1.1 401 INVALID-TOKEN
+</code>
+==== Response if forbidden ====
+Headers
+<code>
+HTTP/1.1 403 FORBIDDEN
+</code>
+==== Response if fields are missing or invalid ====
+Headers
+<code>
+HTTP/1.1 400 INVALID-<field-name>
+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 ====
+Headers
+<code>
+HTTP/1.1 500 ERROR
+Content-Type: text/plain
+</code>
+Body
+<code>
+Sample error message
+</code>

DokuWiki

Site Tools

Differences

Page Tools