{"_id":"5739147c9042980e00ad1a91","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"},"parentDoc":null,"__v":1,"editedParams":true,"editedParams2":true,"githubsync":"","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"},"project":"543005c87d487022005b3fa8","user":"543005a67d487022005b3fa7","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-16T00:29:48.669Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[{"language":"json","code":"{\n    \"result\": \"valid\"\n}","name":"Success"},{"language":"json","code":"{\n    \"result\": \"error\",\n\t  \"error\": \"Reason for error (EG: Already cancelled)\"\n}","name":"Failure"}]},"settings":"","auth":"never","params":[{"_id":"543f0d0755bb10080009566f","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":"543f0dbf15d0560800502814","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":"543f0dbf15d0560800502813","ref":"","in":"body","required":true,"desc":"This is the Job ID for the booking you wish to cancel.","default":"","type":"int","name":"job_id"},{"_id":"543f0dbf15d0560800502812","ref":"","in":"body","required":false,"desc":"This is a text-based reason for the cancellation. For example \"Customer requested cancellation\".","default":"","type":"string","name":"reason"}],"url":"/cancel_booking.json"},"isReference":false,"order":7,"body":"This chapter describes how to cancel a booking using the CANCEL_JOB command. This is an immediate tool that can be used to cancel a job in any STATUS except for Y or V. This should also be used when a modification is required to a job so that any driver that may be en-route to the location does not continue their journey to any incorrect destinations. Modification of less vital information is currently in development and not yet available.","excerpt":"This allows you to cancel an active or pending booking.","slug":"cancel_booking2","type":"endpoint","title":"cancel_booking"}

postcancel_booking

This allows you to cancel an active or pending booking.

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).
job_id:
required
integer
This is the Job ID for the booking you wish to cancel.
reason:
string
This is a text-based reason for the cancellation. For example "Customer requested cancellation".

Result Format


Documentation

This chapter describes how to cancel a booking using the CANCEL_JOB command. This is an immediate tool that can be used to cancel a job in any STATUS except for Y or V. This should also be used when a modification is required to a job so that any driver that may be en-route to the location does not continue their journey to any incorrect destinations. Modification of less vital information is currently in development and not yet available.

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