{"_id":"573915d7d5b6db0e00729c58","editedParams2":true,"project":"543005c87d487022005b3fa8","__v":1,"user":"543005a67d487022005b3fa7","parentDoc":null,"version":{"_id":"543005c87d487022005b3fab","__v":6,"project":"543005c87d487022005b3fa8","createdAt":"2014-10-04T14:35:52.362Z","releaseDate":"2014-10-04T14:35:52.362Z","categories":["543005c87d487022005b3fac","54345156edce04080040964e","543ee0c055bb1008000955b6","54c82a78ab706219009e0656","57390d0e1f4b740e00b06cb2","5741d5ab28f5fb0e0063ed36"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"57390d0e1f4b740e00b06cb2","project":"543005c87d487022005b3fa8","__v":0,"version":"543005c87d487022005b3fab","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-05-15T23:58:06.028Z","from_sync":false,"order":9999,"slug":"iwebcab-customer-api","title":"Gazoop Customer API"},"editedParams":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-16T00:35:35.916Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"post","auth":"never","params":[{"_id":"543f11d315d056080050282e","ref":"","in":"body","required":true,"desc":"This is the username for the customer account (generally a phone number in international format, excluding the + or 00)","default":"","type":"string","name":"username"},{"_id":"5739160175724e0e00f206be","ref":"","in":"body","required":true,"desc":"This is the password for the customer account (generally a PIN number of a minimum 4 digit length, and up to 12 digits long).","default":"","type":"string","name":"password"},{"_id":"543f11d315d056080050282d","ref":"","in":"body","required":false,"desc":"Latitude of the pick-up location in Decimal Degrees only. Do not use commas as decimals. For example: 51.507323","default":"","type":"double","name":"lat"},{"_id":"543f11d315d056080050282c","ref":"","in":"body","required":false,"desc":"Longitude of the pick-up location in Decimal Degrees only. Do not use commas as decimals. For example: -0.127754","default":"","type":"double","name":"long"}],"url":"/pickup_estimate.json"},"isReference":false,"order":9,"body":"This chapter describes how to obtain the current ETA for this firm to pick-up a customer from a certain location using GPS co-ordinates using the PICKUP_ESTIMATE command.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Returned Data\"\n}\n[/block]\nBelow is details of the data that is returned in multiple array objects.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"This is the unique ID number for the driver.\",\n    \"0-0\": \"taxi_id\",\n    \"1-1\": \"Drivers First Name\",\n    \"2-1\": \"Drivers Last Name\",\n    \"1-0\": \"first_name\",\n    \"2-0\": \"last_name\",\n    \"3-0\": \"status\",\n    \"3-1\": \"This could be either AVAILABLE or BUSY, busy being that the driver is currently in a job but is the best driver to get to the pick-up location once they finish.\",\n    \"4-0\": \"lat\",\n    \"4-1\": \"Last Known Latitude of Driver (Decimal).\",\n    \"5-0\": \"long\",\n    \"5-1\": \"Last Known Longitude of Driver (Decimal).\",\n    \"6-1\": \"Distance from pick-up location, including distance to drop off, then on to pick-up if already in a job. Value is in miles.\",\n    \"6-0\": \"distance\",\n    \"7-0\": \"T2P\",\n    \"7-1\": \"Estimated time to Pick-up is in text format such as:\\n\\n  * 5 to 10 minutes\\n  * 10 to 20 minutes\\n  * up to 30 minutes\\n  * up to 45 minutes\\n  * up to 1 hour\\n  * over 1 hour\",\n    \"8-0\": \"T2PD\",\n    \"8-1\": \"Estimated time to pick-up in digit form in minutes. For example: 13\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]","excerpt":"This allows you to get an accurate pickup estimate for a certain latitude and longitude location.","slug":"pickup_estimate2","type":"endpoint","title":"pickup_estimate"}

postpickup_estimate

This allows you to get an accurate pickup estimate for a certain latitude and longitude location.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

username:
required
string
This is the username for the customer account (generally a phone number in international format, excluding the + or 00)
password:
required
string
This is the password for the customer account (generally a PIN number of a minimum 4 digit length, and up to 12 digits long).
lat:
double
Latitude of the pick-up location in Decimal Degrees only. Do not use commas as decimals. For example: 51.507323
long:
double
Longitude of the pick-up location in Decimal Degrees only. Do not use commas as decimals. For example: -0.127754

Documentation

This chapter describes how to obtain the current ETA for this firm to pick-up a customer from a certain location using GPS co-ordinates using the PICKUP_ESTIMATE command. [block:api-header] { "type": "basic", "title": "Returned Data" } [/block] Below is details of the data that is returned in multiple array objects. [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-1": "This is the unique ID number for the driver.", "0-0": "taxi_id", "1-1": "Drivers First Name", "2-1": "Drivers Last Name", "1-0": "first_name", "2-0": "last_name", "3-0": "status", "3-1": "This could be either AVAILABLE or BUSY, busy being that the driver is currently in a job but is the best driver to get to the pick-up location once they finish.", "4-0": "lat", "4-1": "Last Known Latitude of Driver (Decimal).", "5-0": "long", "5-1": "Last Known Longitude of Driver (Decimal).", "6-1": "Distance from pick-up location, including distance to drop off, then on to pick-up if already in a job. Value is in miles.", "6-0": "distance", "7-0": "T2P", "7-1": "Estimated time to Pick-up is in text format such as:\n\n * 5 to 10 minutes\n * 10 to 20 minutes\n * up to 30 minutes\n * up to 45 minutes\n * up to 1 hour\n * over 1 hour", "8-0": "T2PD", "8-1": "Estimated time to pick-up in digit form in minutes. For example: 13" }, "cols": 2, "rows": 9 } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}