{"_id":"543f030555bb10080009563f","editedParams":true,"user":"543005a67d487022005b3fa7","is_link":false,"parentDoc":null,"__v":1,"category":{"_id":"543ee0c055bb1008000955b6","__v":21,"pages":["543ee1d615d0560800502749","543ee5c015d0560800502758","543ee87715d0560800502763","543ee9e315d056080050276c","543f003c55bb100800095624","543f030555bb10080009563f","543f0b3e15d05608005027ee","543f0d0755bb10080009566d","543f0e8415d056080050281b","543f0f8f55bb10080009567e","543f109055bb100800095689","543f11d315d056080050282b","543f15c615d0560800502845","544aec7fa761f90800c41d32","545a7fae1d018b1400227eff","545e9dc97e32310e00f400ca","5603c5dde416560d00fa63ad","564ed2eb9209cf0d001d6917","56cb2acb245b841300806ea4","56e05f414685db1700d9480b","56e063e4f97d422900d639bf"],"project":"543005c87d487022005b3fa8","version":"543005c87d487022005b3fab","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-15T21:01:52.185Z","from_sync":false,"order":1,"slug":"iwebcab-api-tools","title":"Gazoop Internal API"},"editedParams2":true,"project":"543005c87d487022005b3fa8","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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-15T23:28:05.765Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"language":"json","code":"{\n    \"jobdata\": {\n        \"result\": \"success\",\n        \"job_id\": \"12567\",\n        \"taxi_firm\": \"391\",\n        \"taxi_id\": \"0\",\n        \"soft_allocation\": \"0\",\n        \"hard_allocation\": \"5\",\n        \"taxi_approved\": \"N\",\n        \"customer_id\": \"1\",\n        \"call_id\": \"0\",\n        \"pickup_text\": \"London Heathrow Airport - Terminal 1\",\n        \"dropoff_text\": \"Dominos Pizza,Tolworth, UK\",\n        \"pickup_lat\": \"51.477501\",\n        \"pickup_long\": \"-0.461390\",\n        \"dropoff_lat\": \"51.381870\",\n        \"dropoff_long\": \"-0.284370\",\n        \"cost\": \"0.00\",\n        \"currency\": \"GBP\",\n        \"miles\": \"1\",\n        \"est_time_duration\": \"1\",\n        \"name\": \"James Morris\",\n        \"telephone\": \"448003102626\",\n        \"telephone_type\": \"mobile\",\n        \"email\": \"\",\n        \"pickup_time\": \"1390051920\",\n        \"pickup_time_delay\": \"0\",\n        \"status\": \"V\",\n        \"booking_type\": \"INSTANT\",\n        \"passengers\": \"1\",\n        \"cases\": \"1\",\n        \"vehicle_preference\": \"NA\",\n        \"wheelchair\": \"N\",\n        \"notes\": \"Booked via the Automated Telephone IVR\",\n        \"order_method\": \"IVR\",\n        \"time_created\": \"1390051920\",\n        \"time_lastupdate\": \"1392001121\",\n        \"time_queued\": \"1390051945\",\n        \"time_pickedup\": \"\",\n        \"time_completed\": \"\",\n      \t\"flight_tracking\":\"N\",\n        \"flight_airport_iata\": \"\",\n        \"flight_iata\": \"\",\n        \"flight_number\": \"0\",\n        \"flight_date\": \"\",\n        \"flight_id\": \"\",\n        \"fare_charge_method\": \"CASH\",\n        \"fare_table\": \"0\",\n        \"invoice_id\": \"0\",\n        \"recurring_job_id\": \"0\",\n        \"start_job_lat\": \"0.000000\",\n        \"start_job_long\": \"0.000000\",\n        \"start_job_eta\": \"0\",\n        \"feedback_score\": \"0\",\n      \t\"gpx\": \"\",\n      \t\"viapoints\": [],\n        \"pickup_time_text\": \"18th January at 13:32\",\n        \"currency_sign\": \"£\"\n    },\n    \"taxidata\": {\n        \"result\": \"error\",\n        \"error\": \"Not Allocated\"\n    }\n}","name":"Success"},{"language":"json","code":"{\n    \"result\": \"invalid\"\n}","name":"Failure"}]},"try":true,"basic_auth":false,"examples":{"codes":[]},"settings":"","auth":"never","params":[{"_id":"543f030555bb100800095644","ref":"","in":"body","required":true,"desc":"This is a 25 alphanumeric hash code provided to you by the fleet.","default":"","type":"string","name":"api_key"},{"_id":"543f030555bb100800095643","ref":"","in":"body","required":true,"desc":"This is the mobile number for the customer account.","default":"","type":"int","name":"phone_number"},{"_id":"543f030555bb100800095641","ref":"","in":"body","required":true,"desc":"You can also send the customers PIN number for verification, if this fails, the API command will fail. If left blank, no validation is done on the authenticity of the customer ID.","default":"","type":"int","name":"customer_pin"},{"_id":"543f030555bb100800095640","ref":"","in":"body","required":false,"desc":"The specific Job ID you are looking to obtain data for.","default":"","type":"int","name":"job_id"}],"url":"/check_live_bookings.json"},"isReference":false,"order":7,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Is the Job ID required?\",\n  \"body\": \"No, if you do not provide a Job ID the API will return the next live booking for the customer that is due. For example, if a booking is placed for 1 hours time and another for tomorrow, not providing a Job ID will return the booking in 1 hours time, and not the one for tomorrow. In addition, it will not return any cancelled bookings either. If the booking in 1 hour time was cancelled, then the booking returned would be the one for tomorrow.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Returned Data - Job Data\"\n}\n[/block]\nBelow is the returned data from the Job Data object.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"job_id\",\n    \"0-1\": \"Provides the booking reference for the selected booking, this will either be the same value as submitted to the API, otherwise the selected booking if a JOB_ID was not sent in the original API request.\",\n    \"1-0\": \"taxi_id\",\n    \"1-1\": \"This is the unique ID number for the driver who is assigned to this booking. This may not be the public reference for the driver to give to the customer which is generally found in the INTERNAL_REFERENCE parameter.\",\n    \"2-0\": \"pickup_text\",\n    \"2-1\": \"This is the provided pick-up address text.\",\n    \"3-0\": \"pickup_lat\",\n    \"4-0\": \"pickup_long\",\n    \"3-1\": \"This is the pick-up latitude in decimal.\",\n    \"4-1\": \"This is the pick-up longitude in decimal.\",\n    \"5-0\": \"dropoff_text\",\n    \"6-0\": \"dropoff_lat\",\n    \"7-0\": \"dropoff_long\",\n    \"5-1\": \"This is the provided drop-off address text.\",\n    \"6-1\": \"This is the drop-up latitude in decimal.\",\n    \"7-1\": \"This is the drop-up longitude in decimal.\",\n    \"8-0\": \"cost\",\n    \"8-1\": \"This is the default cost stored for this booking.\",\n    \"9-0\": \"currency\",\n    \"9-1\": \"This is the currency for this booking.\",\n    \"10-0\": \"miles\",\n    \"10-1\": \"This is the total miles for this journey.\",\n    \"11-1\": \"This is the estimated time duration whilst going from pick-up to the drop off.\",\n    \"11-0\": \"est_time_duration\",\n    \"12-0\": \"name\",\n    \"13-0\": \"telephone\",\n    \"14-0\": \"email\",\n    \"12-1\": \"Lead Passenger Name\",\n    \"13-1\": \"Lead Passenger Phone Number\",\n    \"14-1\": \"Lead Passenger Email\",\n    \"15-0\": \"pickup_time\",\n    \"16-0\": \"pickup_time_text\",\n    \"15-1\": \"Unix Timestamp of Pick-up Time\",\n    \"16-1\": \"Human readable version of PICKUP_TIME\",\n    \"17-0\": \"status\",\n    \"17-1\": \"This is the current status of the job, this can return as any of the following values:\\n\\n  * W = Pending Pre-book\\n  * Q = In Queue (waiting for driver)\\n  * P = Pending Driver Approval\\n  * 1 = Driver en-route to Pick-up\\n  * A = Driver Approaching Pick-up\\n  * 2 = En-route to Drop-off (POB)\\n  * V = Job Cancelled/Void\\n  * Y = Job Completed\",\n    \"18-0\": \"booking_type\",\n    \"18-1\": \"This is the type of booking and can return any of the following values:\\n\\n  * INSTANT\\n  * PREBOOK\\n  * AIRPORT\",\n    \"19-0\": \"passengers\",\n    \"19-1\": \"Total number of passengers.\",\n    \"20-0\": \"cases\",\n    \"20-1\": \"Total number of cases.\",\n    \"21-0\": \"vehicle_preference\",\n    \"21-1\": \"This is the vehicle preference specified when placing the booking. This can be any of the following values:\\n\\n  * NA = Not Applicable / No Preference\\n  * SALOON = Saloon Car\\n  * ESTATE = Estate Car\\n  * EXEC = Executive Car\\n  * MPV = MPV\\n  * MPVPLUS = MPV Plus\\n  * 8SEATER = 8 Seater Vehicle\\n  * MINIBUS = Mini Bus\\n  * LIMO = Limousine\\n  * BUS = Bus\\n  * COACH = Coach\",\n    \"22-0\": \"wheelchair\",\n    \"22-1\": \"Returns either TRUE or FALSE whether a wheelchair accessible vehicle is required for this booking.\",\n    \"23-1\": \"Notes provided at booking stage, and any supplementary notes added by the fleet operator internally.\",\n    \"23-0\": \"notes\",\n    \"24-0\": \"order_method\",\n    \"24-1\": \"This can be set to any of the following values:\\n\\n  * AGENT = iWebCab Telephone Agent\\n  * ADMIN = Fleet Dispatcher/Admin\\n  * API = API/Mobile Application\\n  * RECURRING = Auto Recurring Booking\\n  * IVR = Automated telephone System\\n  * SMS = Inbound SMS Message\",\n    \"25-0\": \"time_created\",\n    \"25-1\": \"Unix timestamp of created time.\",\n    \"26-0\": \"time_queued\",\n    \"26-1\": \"Unix timestamp of when job queued for a driver to accept.\",\n    \"27-0\": \"time_pickedup\",\n    \"27-1\": \"Unix timestamp of when job was marked as picked-up (POB).\",\n    \"28-0\": \"time_completed\",\n    \"28-1\": \"Unix timestamp of when job was marked as completed.\",\n    \"29-0\": \"recurring_job_id\",\n    \"29-1\": \"The original booking reference number. Only provided when ORDER_METHOD is set to RECURRING.\",\n    \"30-0\": \"start_job_lat\",\n    \"30-1\": \"This is the drivers latitude when they started this job.\",\n    \"31-0\": \"start_job_long\",\n    \"31-1\": \"This is the drivers longitude when they started this job.\",\n    \"32-0\": \"start_job_eta\",\n    \"32-1\": \"This is the ETA in minutes when the driver started the job.\",\n    \"35-0\": \"feedback_score\",\n    \"35-1\": \"If provided by the customer, this is the feedback score out of 5. A 0 result means no feedback was provided.\",\n    \"33-0\": \"gpx\",\n    \"33-1\": \"This is a link to the actual route driven by the driver for this ride. You must add data.kml or data.gpx depending on the file format you want to the end of this given URL.\",\n    \"34-0\": \"viapoints\",\n    \"34-1\": \"This is an array of via points in correct order of pickup. It contains the following items in each array element:\\n\\ntext = Address Text\\nlat = Latitude of Via Point\\nlong = Longitude of Via Point\"\n  },\n  \"cols\": 2,\n  \"rows\": 36\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Returned Data - Taxi Data\"\n}\n[/block]\nBelow is the returned data from the Taxi Data object.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"taxi_id\",\n    \"0-1\": \"This is the unique ID number for the driver who is assigned to this booking. This may not be the public reference for the driver to give to the customer which is generally found in the INTERNAL_REFERENCE parameter.\",\n    \"1-0\": \"internal_reference\",\n    \"1-1\": \"This is the internal reference for this driver. This should be the reference shown to the customer as this is generally linked to the medallion or reference number placed on the vehicle or license number of the driver.\",\n    \"2-0\": \"first_name\",\n    \"2-1\": \"Drivers First Name\",\n    \"3-0\": \"last_name\",\n    \"3-1\": \"Drivers Last Name\",\n    \"4-0\": \"mobile_number\",\n    \"4-1\": \"Drivers Mobile Number\",\n    \"5-0\": \"reg_plate\",\n    \"5-1\": \"Drivers Registration Plate Number\",\n    \"6-0\": \"car_make\",\n    \"6-1\": \"Vehicle Make\",\n    \"7-0\": \"car_colour\",\n    \"7-1\": \"Vehicle Color/Colour\",\n    \"8-0\": \"lat\",\n    \"8-1\": \"Last Known Latitude of Driver (Decimal).\",\n    \"9-0\": \"long\",\n    \"9-1\": \"Last Known Longitude of Driver (Decimal).\",\n    \"11-0\": \"url_driver_picture\",\n    \"11-1\": \"A URL served by HTTPS that displays a photograph of the driver.\",\n    \"10-0\": \"rating\",\n    \"10-1\": \"A 5 Star rating, in 2 decimal, of the drivers rating based on customer feedback.\"\n  },\n  \"cols\": 2,\n  \"rows\": 12\n}\n[/block]","excerpt":"This tool allows you to check bookings currently in the system against the customer account.","slug":"check_live_bookings","type":"endpoint","title":"check_live_bookings"}

postcheck_live_bookings

This tool allows you to check bookings currently in the system against the customer account.

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.
phone_number:
required
integer
This is the mobile number for the customer account.
customer_pin:
required
integer
You can also send the customers PIN number for verification, if this fails, the API command will fail. If left blank, no validation is done on the authenticity of the customer ID.
job_id:
integer
The specific Job ID you are looking to obtain data for.

Result Format


Documentation

[block:callout] { "type": "info", "title": "Is the Job ID required?", "body": "No, if you do not provide a Job ID the API will return the next live booking for the customer that is due. For example, if a booking is placed for 1 hours time and another for tomorrow, not providing a Job ID will return the booking in 1 hours time, and not the one for tomorrow. In addition, it will not return any cancelled bookings either. If the booking in 1 hour time was cancelled, then the booking returned would be the one for tomorrow." } [/block] [block:api-header] { "type": "basic", "title": "Returned Data - Job Data" } [/block] Below is the returned data from the Job Data object. [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "job_id", "0-1": "Provides the booking reference for the selected booking, this will either be the same value as submitted to the API, otherwise the selected booking if a JOB_ID was not sent in the original API request.", "1-0": "taxi_id", "1-1": "This is the unique ID number for the driver who is assigned to this booking. This may not be the public reference for the driver to give to the customer which is generally found in the INTERNAL_REFERENCE parameter.", "2-0": "pickup_text", "2-1": "This is the provided pick-up address text.", "3-0": "pickup_lat", "4-0": "pickup_long", "3-1": "This is the pick-up latitude in decimal.", "4-1": "This is the pick-up longitude in decimal.", "5-0": "dropoff_text", "6-0": "dropoff_lat", "7-0": "dropoff_long", "5-1": "This is the provided drop-off address text.", "6-1": "This is the drop-up latitude in decimal.", "7-1": "This is the drop-up longitude in decimal.", "8-0": "cost", "8-1": "This is the default cost stored for this booking.", "9-0": "currency", "9-1": "This is the currency for this booking.", "10-0": "miles", "10-1": "This is the total miles for this journey.", "11-1": "This is the estimated time duration whilst going from pick-up to the drop off.", "11-0": "est_time_duration", "12-0": "name", "13-0": "telephone", "14-0": "email", "12-1": "Lead Passenger Name", "13-1": "Lead Passenger Phone Number", "14-1": "Lead Passenger Email", "15-0": "pickup_time", "16-0": "pickup_time_text", "15-1": "Unix Timestamp of Pick-up Time", "16-1": "Human readable version of PICKUP_TIME", "17-0": "status", "17-1": "This is the current status of the job, this can return as any of the following values:\n\n * W = Pending Pre-book\n * Q = In Queue (waiting for driver)\n * P = Pending Driver Approval\n * 1 = Driver en-route to Pick-up\n * A = Driver Approaching Pick-up\n * 2 = En-route to Drop-off (POB)\n * V = Job Cancelled/Void\n * Y = Job Completed", "18-0": "booking_type", "18-1": "This is the type of booking and can return any of the following values:\n\n * INSTANT\n * PREBOOK\n * AIRPORT", "19-0": "passengers", "19-1": "Total number of passengers.", "20-0": "cases", "20-1": "Total number of cases.", "21-0": "vehicle_preference", "21-1": "This is the vehicle preference specified when placing the booking. This can be any of the following values:\n\n * NA = Not Applicable / No Preference\n * SALOON = Saloon Car\n * ESTATE = Estate Car\n * EXEC = Executive Car\n * MPV = MPV\n * MPVPLUS = MPV Plus\n * 8SEATER = 8 Seater Vehicle\n * MINIBUS = Mini Bus\n * LIMO = Limousine\n * BUS = Bus\n * COACH = Coach", "22-0": "wheelchair", "22-1": "Returns either TRUE or FALSE whether a wheelchair accessible vehicle is required for this booking.", "23-1": "Notes provided at booking stage, and any supplementary notes added by the fleet operator internally.", "23-0": "notes", "24-0": "order_method", "24-1": "This can be set to any of the following values:\n\n * AGENT = iWebCab Telephone Agent\n * ADMIN = Fleet Dispatcher/Admin\n * API = API/Mobile Application\n * RECURRING = Auto Recurring Booking\n * IVR = Automated telephone System\n * SMS = Inbound SMS Message", "25-0": "time_created", "25-1": "Unix timestamp of created time.", "26-0": "time_queued", "26-1": "Unix timestamp of when job queued for a driver to accept.", "27-0": "time_pickedup", "27-1": "Unix timestamp of when job was marked as picked-up (POB).", "28-0": "time_completed", "28-1": "Unix timestamp of when job was marked as completed.", "29-0": "recurring_job_id", "29-1": "The original booking reference number. Only provided when ORDER_METHOD is set to RECURRING.", "30-0": "start_job_lat", "30-1": "This is the drivers latitude when they started this job.", "31-0": "start_job_long", "31-1": "This is the drivers longitude when they started this job.", "32-0": "start_job_eta", "32-1": "This is the ETA in minutes when the driver started the job.", "35-0": "feedback_score", "35-1": "If provided by the customer, this is the feedback score out of 5. A 0 result means no feedback was provided.", "33-0": "gpx", "33-1": "This is a link to the actual route driven by the driver for this ride. You must add data.kml or data.gpx depending on the file format you want to the end of this given URL.", "34-0": "viapoints", "34-1": "This is an array of via points in correct order of pickup. It contains the following items in each array element:\n\ntext = Address Text\nlat = Latitude of Via Point\nlong = Longitude of Via Point" }, "cols": 2, "rows": 36 } [/block] [block:api-header] { "type": "basic", "title": "Returned Data - Taxi Data" } [/block] Below is the returned data from the Taxi Data object. [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "taxi_id", "0-1": "This is the unique ID number for the driver who is assigned to this booking. This may not be the public reference for the driver to give to the customer which is generally found in the INTERNAL_REFERENCE parameter.", "1-0": "internal_reference", "1-1": "This is the internal reference for this driver. This should be the reference shown to the customer as this is generally linked to the medallion or reference number placed on the vehicle or license number of the driver.", "2-0": "first_name", "2-1": "Drivers First Name", "3-0": "last_name", "3-1": "Drivers Last Name", "4-0": "mobile_number", "4-1": "Drivers Mobile Number", "5-0": "reg_plate", "5-1": "Drivers Registration Plate Number", "6-0": "car_make", "6-1": "Vehicle Make", "7-0": "car_colour", "7-1": "Vehicle Color/Colour", "8-0": "lat", "8-1": "Last Known Latitude of Driver (Decimal).", "9-0": "long", "9-1": "Last Known Longitude of Driver (Decimal).", "11-0": "url_driver_picture", "11-1": "A URL served by HTTPS that displays a photograph of the driver.", "10-0": "rating", "10-1": "A 5 Star rating, in 2 decimal, of the drivers rating based on customer feedback." }, "cols": 2, "rows": 12 } [/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 }}