{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/pickup_estimate.json","auth":"never","basic_auth":false,"method":"post","params":[{"name":"api_key","type":"string","default":"","desc":"This is a 25 alphanumeric hash code provided to you by the fleet.","required":true,"in":"body","ref":"","_id":"543f11d315d056080050282e"},{"name":"lat","type":"double","default":"","desc":"Latitude of the pick-up location in Decimal Degrees only. Do not use commas as decimals. For example: 51.507323","required":false,"in":"body","ref":"","_id":"543f11d315d056080050282d"},{"name":"long","type":"double","default":"","desc":"Longitude of the pick-up location in Decimal Degrees only. Do not use commas as decimals. For example: -0.127754","required":false,"in":"body","ref":"","_id":"543f11d315d056080050282c"}],"results":{"codes":[]},"try":true},"next":{"description":"","pages":[]},"title":"pickup_estimate","type":"endpoint","slug":"pickup_estimate","excerpt":"This allows you to get an accurate pickup estimate for a certain latitude and longitude location.","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]","updates":[],"order":16,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"543f11d315d056080050282b","editedParams":true,"project":"543005c87d487022005b3fa8","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["543005c87d487022005b3fac","54345156edce04080040964e","543ee0c055bb1008000955b6","54c82a78ab706219009e0656","57390d0e1f4b740e00b06cb2","5741d5ab28f5fb0e0063ed36","5d1e4140522cd702b31b544b","5e321f8b5517b00012831b6a"],"_id":"543005c87d487022005b3fab","__v":8,"createdAt":"2014-10-04T14:35:52.362Z","releaseDate":"2014-10-04T14:35:52.362Z","project":"543005c87d487022005b3fa8"},"__v":0,"createdAt":"2014-10-16T00:31:15.470Z","is_link":false,"parentDoc":null,"user":"543005a67d487022005b3fa7","category":{"sync":{"isSync":false,"url":""},"pages":["543ee1d615d0560800502749","543ee5c015d0560800502758","543ee87715d0560800502763","543ee9e315d056080050276c","543f003c55bb100800095624","543f030555bb10080009563f","543f0b3e15d05608005027ee","543f0d0755bb10080009566d","543f0e8415d056080050281b","543f0f8f55bb10080009567e","543f109055bb100800095689","543f11d315d056080050282b","543f15c615d0560800502845","544aec7fa761f90800c41d32","545a7fae1d018b1400227eff","545e9dc97e32310e00f400ca","5603c5dde416560d00fa63ad","564ed2eb9209cf0d001d6917","56cb2acb245b841300806ea4","56e05f414685db1700d9480b","56e063e4f97d422900d639bf"],"title":"Gazoop Internal API","slug":"iwebcab-api-tools","order":1,"from_sync":false,"reference":false,"_id":"543ee0c055bb1008000955b6","__v":21,"createdAt":"2014-10-15T21:01:52.185Z","project":"543005c87d487022005b3fa8","version":"543005c87d487022005b3fab"},"editedParams2":true}

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

api_key:
required
string
This is a 25 alphanumeric hash code provided to you by the fleet.
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 }}