{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/live.json","auth":"never","basic_auth":false,"method":"post","settings":"","examples":{"codes":[]},"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":"543eb372fd81651c008e4d50"},{"name":"command","type":"string","default":"drivers","desc":"This is the command or tool you wish to access or execute. For example, in order to place a booking you would use “instant_booking”.","required":true,"in":"body","ref":"","_id":"543eb372fd81651c008e4d4f"},{"name":"uppercase","type":"boolean","default":"false","desc":"If TRUE, all keys are returned in uppercase.","required":false,"in":"body","ref":"","_id":"543eb372fd81651c008e4d4e"}],"results":{"codes":[{"name":"Failure","code":"{\n    \"error\": \"Invalid Hash ID\"\n}","language":"json"},{"code":"{\n  \"taxi_id\": \"134\",\n  \"lat\": \"43.066586\",\n  \"long\": \"-37.061775\",\n  \"first_name\": \"Mike\",\n  \"last_name\": \"Bloggs\",\n  \"status\": \"Busy\",\n  \"online\": \"Y\"\n},\n{\n  \"taxi_id\": \"543\",\n  \"lat\": \"43.102894\",\n  \"long\": \"-36.809235\",\n  \"first_name\": \"Adam\",\n  \"last_name\": \"Doe\",\n  \"status\": \"Away\",\n  \"online\": \"Y\"\n}","language":"json","name":"Success"}]},"try":true},"next":{"description":"","pages":[]},"title":"Basic API Transaction","type":"endpoint","slug":"basic-api-transaction","excerpt":"","body":"An API Request contains the following:\n\n  * Connection Parameters\n  * User Parameters\n  * Parameters specific to the type of transaction, such as a new booking or cancellation. \n\nCurrently our API only supports name-value pairs via the POST/GET method.","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"543eb293fd81651c008e4d4b","editedParams":true,"editedParams2":true,"project":"543005c87d487022005b3fa8","user":"543005a67d487022005b3fa7","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"},"githubsync":"","createdAt":"2014-10-15T17:44:51.747Z","is_link":false,"__v":2,"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"},"parentDoc":null}

postBasic API Transaction


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.
command:
required
stringdrivers
This is the command or tool you wish to access or execute. For example, in order to place a booking you would use “instant_booking”.
uppercase:
booleanfalse
If TRUE, all keys are returned in uppercase.

Result Format


Documentation

An API Request contains the following: * Connection Parameters * User Parameters * Parameters specific to the type of transaction, such as a new booking or cancellation. Currently our API only supports name-value pairs via the POST/GET method.

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 }}