Flitways API V1.2.2

Booking Placement

The Booking Placement function provides a simple way to place a booking into FlitWays system from the search identifier returned by the Booking Rate and Response function.
Send a request via HTTP POST to book a ride.
Live Request - HTTP POST https://flitways.com/api/booking_placement_request
Demo Testing - HTTP POST http://demo.flitways.com/api/booking_placement_request
Request fields and values:
Name Description Example
key The Partner key NBOLq1aFq4G5mt88R5COtGiqIlrwoDG3kgLeCKfohJ0xJwAaOMua3H6ft7JI
pickup_address The formatted address of the pick-up point. 201 Marquette Ave NW, Albuquerque, NM 87102
destination_address The formatted address of the drop off point. West Mesa Airport, Albuquerque, NM
pickup_time The pick-up date and time 2017-07-27 02:34:51    i.e YYYY-MM-DD HH:MM:SS (GMT)
asap (optional) On-demand trips for pick-up within the next 5 mins. True/False. Set 1 for true or 0 for false
miles The estimated distance between the pick-up address and the destination address (Miles) 6.11
estimate_travel_time The estimated time to travel from the pick-up address and the destination address 0 hour(s) 14 mins
lat_from The latitude of the pick-up point. 35.0884616
long_from The longitude of the pickup point. -106.64930
lat_to The latitude of the drop off point. 35.086944
long_to The longitude of the drop off point. -106.7155559
is_pickup_airport Pick-up is from the airport or not ( 1/0 ) 1
no_of_passengers Numbers of passengers 3
additional_info Special note Special message to driver
flight_code Airline IATA Code AA
flight_info Airline flight number 10104
fare Total fare price 10.66
vehicle_fleet_id Fleet ID 232
request_id Request ID from the rate request response endpoint 4MF6ubQvU1ntcr0Jyfo8zQ7kZ
passenger_name Name of passenger Jane Smith
passenger_phone_country_code Passenger phone country area code 1
passenger_phone Passenger phone 3107896541
passenger_email Passenger email jane_smith@mail.com
allow_passenger_alerts Allow FlitWays email/sms to passenger. 1 for Yes. 0 for No. should 1 (optional)
partner_confirmation_no Your platform unique reference no S218930 (optional)
password Password to create FlitWays traveler's account At least 5 characters (optional)
card_type Credit card type visa, master_card, american_express, discover (optional)
card_number Credit card number 16 digits only e.g 4111111111111111 (optional)
card_name Credit Card Name Alphanumeric e.g Jane Smith (optional)
exp_date Credit card expiration Numeric e.g 122019 i.e MMYYYY (optional)
card_cvv Credit card CVV/CVC Max 4 digits e.g 123 or 1234 for Amex (optional)
card_zip_code Credit card zip code Numeric e.g. 90034 (optional)
save_card To save card details for future use Set false for No. Set true for Yes (optional)
Book Response fields and properties:
Name Description Example
status Status of the request true/false
request_id ID of the request 4821430
code Type of the response S001
request_time Time of search request 07/27/2017 02:34 am
key The Partner key NBOLq1aFq4G5mt88R5COtGiqIlrwoDG3kgLeCKfohJ0xJwAaOMua3H6ft7JI
message Confirmation of the booking Your booking was successful!
voucher_no FlitWays unique voucher number 2573769
rate_eta_seconds Driver ETA (in seconds) 400
JSON Booking Placement Response Example:

Booking Cancellation

The Booking Cancellation function provides a way to cancel a Booking that was placed into FlitWays system by the Booking Placement function.
Send a request via HTTP POST to cancel a booking.
Live Request - HTTP POST https://flitways.com/api/booking_cancellation_request
Demo Testing - HTTP POST http://demo.flitways.com/api/booking_cancellation_request
Request fields and values:
Name Description Example
key Partner unique keys NBOLq1aFq4G5mt88R5.....
voucher_no The voucher number 2573769
cancellation_time Date-time of the cancellation 2017-06-06T14:30:00 i.e YYYY-MM-DDThh:mm:ss (UTC Time)
Request Response fields and properties:
Name Description Example
status Status of the request true/false
request_id ID of the request 4821430
code Type of the response S001
key The Partner key NBOLq1aFq4G5mt88R5COtGiqIlrwoDG3kgLeCKfohJ0xJwAaOMua3H6ft7JI
message Message of the cancellation Booking cancelled successfully - Refund Pending
voucher_no The voucher number 2573769
cancellation_fee Cancellation Fee 0.00 or 5.00 or 20.00
cancellation_time Date-time of the cancellation 2017-06-06T14:30:00 i.e YYYY-MM-DDThh:mm:ss (UTC Time)
JSON Book Cancel Response Example:

Trip Status

The Trip Status function provides a way to check the status of a Booking that was placed into FlitWays system by the Booking Placement function.
Send a request via HTTP POST to check the status of a booking.
Live Request - HTTP POST https://flitways.com/api/booking_status_request
Demo Testing - HTTP POST http://demo.flitways.com/api/booking_status_request
Request fields and values:
Name Description Example
key Partner unique key NBOLq1aFq4G5mt88R5COtGiqIlrwoDG3kgLeCKfohJ0xJwAaOMua3H6ft7JI
voucher_no Trip voucher number 2573769
Request Response fields and properties:
Name Description Example
status Status of the request true/false
request_id ID of the request 4821430
code Response success or error code S001
request_time Request time stamp 07/27/2017 02:34 am
key Partner unique key NBOLq1aFq4G5mt88R5COtGiqIlrwoDG3kgLeCKfohJ0xJwAaOMua3H6ft7JI
message Response Success
voucher_no Trip voucher number 2573769
pickup_time Trip pick up time 07/27/2017 02:34 am
ride_status Current ride status accepted. See "Ride Status Types" doc for complete list.
canceled_by The person that canceled the trip driver, passenger, dispatcher
driver_name Driver name Jone Dow
driver_phone Driver's mobile phone +13107896541
driver_rating Driver's rating 4.5
driver_image_url Link to driver's image http://demo.flitways.com/drivers/driver_url.jpg
vehicle_make Vehicle make Toyota
vehicle_model Vehicle model Prius
vehicle_license_plate License plate number A99999
vehicle_color Vehicle color Black
vehicle_image_url Link to vehicle image http://demo.flitways.com/cars/FlitWays_Start.png
pickup_lat Pick up address latitude 34.008336
pickup_lng Pick up address longtitude -118.401311
pickup_address Pick up address 10844 Garfield Ave, Culver City, CA 90230, US
dropoff_lat Dropoff latitude 33.942501
dropoff_lng Dropoff longtitude -118.407997
dropoff_address Dropoff address Los Angeles International Airport
location_lat Driver's location latitude 34.008336
location_lng Driver's location longtitude -118.401311
location_address Driver's location address 10844 Garfield Ave, Culver City, CA 90230, US
location_bearing Driver's location bearing 2.51327412
destination_eta_seconds Driver & trip ETA in seconds 360
fare_price Trip fare price $13.42
payment_type Encrypted payment info. Credit Card xxx1111
cancelation_state To determine if cancelation is allowed or not allow, expire
JSON Booking Status Response Example:

Trip Rating

The Trip Rating endpoint provides a way to rate a trip and driver experience. Your application can send a numeric rating from 1 to 5 with a brief comments using the feedback parameter. Please note that you can only rate droppedOff trips within 30 days of completion.
Send a request via HTTP POST to rate a trip.
Live Request - HTTP POST https://flitways.com/api/trip_rating
Demo Testing - HTTP POST http://demo.flitways.com/api/trip_rating
Request fields and values:
Name Description Example
voucher_no Trip voucher number 1234567
rating Trip rating, from 1 t o 5 5
feedback (optional) Brief comments on the trip and driver experience (max. 255 characters) My driver was on time and very friendly
If the rating was processed successfully. The endpoint will return HTTP Status Code 204, without any content.
Response fields and properties:
Name Description Example
status Status of the request true/false
code Error Code E007
message Responded message The trip was rated before.
JSON Trip Rating Response Example:

Get Cities

The Get Cities function provides a way to get the available cities from the FlitWays system.
Send a request via HTTP POST/GET to retrieve the available cities from FlitWays.
Live Request - HTTP POST/GET https://flitways.com/api/get_cities
Demo Testing - HTTP POST/GET http://demo.flitways.com/api/get_cities
Response fields and properties:
Name Description Example
status Status of the request true/false
data Response of the request A json array
JSON Get Cities Response Example:

Get Airports

The Get Airports function provides a way to get the available airports from the FlitWays system.
Send a request via HTTP POST/GET to retrieve the available airports from FlitWays.
Live Request - HTTP POST/GET https://flitways.com/api/get_airports
Demo Testing - HTTP POST/GET http://demo.flitways.com/api/get_airports
Response fields and properties:
Name Description Example
status Status of the request true/false
data Response of the request A json array
airport_name Airport name Los Angeles International Airport
city_name Airport city Los Angeles
airport_iata_code Airport iata code LAX
airport_icao_code Airport icao code KLAX
latitude Airport latitude 33.9415889
longitude Airport longtitude -118.40852999999998
JSON Get Airports Response Example:

Vehicle Types Listing

The Vehicle Types Listing provides the list of all FlitWays vehicle categories.

FlitWays Category Description Example
FlitWays Start Economy sedan Toyota Prius, Toyota Camry
FlitWays Class Luxurious sedan Town Car, Mercedes E-Class
FlitWays Extenstion Large size vehicles. E.g. Minivan, Vans Toyota Sienna, Honda Odyssey
FlitWays Class Extenstion Luxurious large size vehicles. E.g. SUV, Minivan Cadillac Escalade, Mercedes Sprinter

Ride Status Types

The Ride Status Listing shows the list of all FlitWays ride status names and description.

Name Description
new A newly placed booking
pending The booking request is sent out to available drivers
accepted The driver is on the way to the pick up location
arrived The driver has arrived at the pick up location
pickedUp The passenger has been picked up and en-route to the destination
droppedOff The passenger has been dropped off at the destination
canceled The booking has been canceled
passenger_no_show The passenger wasn't available during the pick up
decline The booking was rejected by FlitWays

Get Price Estimate

The Get Price Estimate end point can be used to get price quotation for Airport Trips. E.g. Airport to City and City to Airport.
Send a request via HTTP POST/GET to retrieve the available price estimate from FlitWays.
Live Request - HTTP POST/GET https://flitways.com/api/get_price_estimates
Demo Testing - HTTP POST/GET http://demo.flitways.com/api/get_price_estimates
Response fields and properties:
Name Description Example
status Status of the request true/false
msg Response description String
data Response of the request A json array of price estimates
from_place Pick up location Los Angeles Airport, LAX
to_place Destination Los Angeles Downtown Area
from_airport_code Pick up airport code LAX
to_airport_code Destination airport code LAX
estimate_price Estimated price 45
currency Price currency USD
JSON Get Price Estimate Response Example:

Drivers Availability

The Drivers Availability function provides a way to get the available drivers for a place.
Send a request via HTTP POST/GET to retrieve the available drivers from FlitWays.
Live Request - HTTP POST/GET https://flitways.com/api/drivers_availability
Demo Testing - HTTP POST/GET http://demo.flitways.com/api/drivers_availability
Request fields and values:
Name Description Example
key Partner unique keys NBOLq1aFq4G5mt88R5COtGiqIlrwoDG3kgLeCKfohJ0xJwAaOMua3H6ft7JI
lat Latitude 34.030277
lng Longitude -118.41599889999998
Response fields and properties:
Name Description Example
status Status of the request true/false
data Response of the request A json array
lat Latitude of Driver location 34.116382
lng Longitude of Driver location -118.482286
driver_direction The dynamic radians of the driver's direction 1.6580627875
eta_seconds Driver ETA (in seconds) 445
JSON Drivers Availability Response Example:

API Errors

When error occurs for some reasons, the status property is set to error and the response property is replaced by the errors property which contains an array of error objects described below.
Fields fields and values:

Name Description Example
status Status of the request false/fail
request_id ID of the request 4821430
code Type of the response E001
message Error message The partner key does not exist!
JSON Response Example:

HTTP Status Codes

Partner api tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP status codes.
Fields fields and values:

Status code Usage
200 Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action.
201 The request has been fulfilled and resulted in a new resource being created.
204 The server successfully processed the request, but is not returning any content.
400 The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
401 The request has not been applied because it lacks valid authentication credentials for the target resource.
403 The server understood the request but refuses to authorize it.
404 The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible.
Contact Us
  • 24/7 Support:
    +1-855-710-0915    (US)
    +44 117 325 5593   (UK)
    +61 7 4839 7446     (Australia)
  • Investor Relations: Mon - Fri 9 A - 6 P PST
    +1-855-710-0915 ex. 5
  • Email: support@flitways.com
Say Hey
© 2016. FlitWays Technology Inc. | Privacy Policy | Terms and Conditions | SEC Filings All right reserved. FLITWAYS EVERYWHERE - Atlanta  •  Austin  •  Baltimore  •  Boston  •  Chicago  •  Charlotte  •  Charlotte  •  Dallas  •  Denver  •  Detroit  •  Fort Lauderdale  •  Franklin  •  Honolulu  •  Houston  •  Jacksonville  •  Jersey City  •  Indianapolis  •  Las Vegas  •  Los Angeles  •  Memphis  •  Miami  •  Minneapolis  •  Montreal  •  Nashville  •  New Orleans  •  New York  •  Orange County  •  Orlando  •  Philadelphia  •  Phoenix  •  Pittsburgh  •  Portland  •  Sacramento  •  San Diego  •  San Antonio  •  San Jose  •  San Francisco  •  Seattle  •  St Louis  •  Tampa  •  Toronto  •  Tucson  •  Vancouver  •  West Palm  •  Washington DC  •  CancĂșn  •  Berlin  •  Rio de Janeiro  •  London  •  Paris  •  Buenos Aires  •  Mexico City  •