Fleet Manager REST API

POST CUSTOMER REGISTRAION
/api/user-registration

New Custoemer's registration api

REQUEST BODY

user_name
STRING

REQUIRED

mobno
NUMERIC

REQUIRED, UNIQUE

emailid
STRING

REQUIRED, UNIQUE

password
STRING

REQUIRED

gender
INT

MALE = 1, FEMALE = 0

is_smconnected
INT

CONNECTED THROUGH FACEBOOK/GOOGLE+ = 1 , NORMAL REGISTRATION = 0

socialmedia_uid

REQUIRED IF IS_SMCONNECTED=1

profile_pic
FILE UPLOAD
fcm_id
INT
mode
INT

MODE : 1=ANDROID, 2=IOS

device_token
STRING
RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

You have Registered Successfully!

data.userinfo.user_id
INT

data.userinfo.api_token
STRING

data.userinfo.fcm_id
STRING

data.userinfo.device_token
STRING

data.userinfo.socialmedia_uid
STRING

data.userinfo.user_name
STRING

data.userinfo.mobno
NUMERIC

data.userinfo.phone_code
INT

data.userinfo.emailid
STRING

data.userinfo.gender
INT

0 = FEMALE, 1 = MALE

data.userinfo.password
STRING

data.userinfo.profile_pic
URL

data.userinfo.status
INT

1 = LOGGED IN, 0 = LOGGED OUT

data.userinfo.timestamp
DATETIME



POST Login without social media
/api/user-login

user's login without social media connect

REQUEST BODY

username
STRING

USERNAME MUST BE REGISTERED EMAIL-ID

password
STRING
fcm_id
STRING
is_smconnected
INT

CONNECTED = 1, NORMAL = 0

device_token
STRING
RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

You have Signed in Successfully!

data.userinfo.user_id
INT

data.userinfo.api_token
STRING

data.userinfo.fcm_id
STRING

data.userinfo.device_token
STRING

data.userinfo.socialmedia_uid
STRING

data.userinfo.user_name
STRING

data.userinfo.user_type
STRING

C = CUSTOMER, D = DRIVER

data.userinfo.mobno
NUMERIC

data.userinfo.phone_code
INT

data.userinfo.emailid
STRING

data.userinfo.gender
INT

0 = FEMALE, 1 = MALE

data.userinfo.password
STRING

data.userinfo.profile_pic
URL

data.userinfo.status
INT

1 = LOGGED IN, 0 = LOGGED OUT

data.userinfo.timestamp
DATETIME



POST Forgot password
/api/forgot-password

Forget password api to reset existing user's password

REQUEST BODY

email
STRING

REQUIRED, EMAIL-ID MUST BE REGISTERED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

Please, check your Emails for Login Credentials.



POST Edit User Profile
/api/edit-user-profile

edit user/customer/driver's profile api

REQUEST BODY

fcm_id
STRING
user_id
INT

HIDDEN, REQUIRED

user_name
STRING
mobno
NUMERIC

REQUIRED (MUST NOT BE NULL)

emailid
STRING

REQUIRED (MUST NOT BE NULL)

profile_pic
FILE UPLOAD
gender
INT
edit
INT
api_token
STRING

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

Profile has been Updated Successfully!

data.userinfo.user_id
INT

data.userinfo.user_type
STRING

C = CUSTOMER, D = DRIVER

data.userinfo.user_name
STRING

data.userinfo.mobno
NUMERIC

data.userinfo.phone_code
INT

data.userinfo.emailid
STRING

data.userinfo.gender
INT

0 = FEMALE, 1 = MALE

data.userinfo.profile_pic
URL

data.userinfo.status
INT

1 = LOGGED IN, 0 = LOGGED OUT

data.userinfo.timestamp
DATETIME



POST User login with social media
/api/user-login-sm

Customer login/register using social media.

REQUEST BODY

socialmedia_uid
INT

REQUIRED

user_name
STRING

REQUIRED

mobno
NUMERIC

REQUIRED, UNIQUE

emailid
STRING

REQUIRED, UNIQUE

gender
INT

REQUIRED

profile_pic
STRING (URL)
fcm_id
STRING
is_smconnected
INT

VALUE MUST BE 1

device_token
STRING
RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

You have Signed in Successfully!

data.userinfo.user_id
INT

data.userinfo.user_type
STRING

C = CUSTOMER, D = DRIVER

data.userinfo.fcm_id
STRING

data.userinfo.api_token
STRING

data.userinfo.device_token
STRING

data.userinfo.socialmedia_uid
STRING

data.userinfo.user_name
STRING

data.userinfo.mobno
NUMERIC

data.userinfo.phone_code
INT

data.userinfo.emailid
STRING

data.userinfo.gender
INT

0 = FEMALE, 1 = MALE

data.userinfo.password
STRING

data.userinfo.profile_pic
URL

data.userinfo.status
INT

1 = LOGGED IN, 0 = LOGGED OUT

data.userinfo.timestamp
DATETIME



POST Message Us
/api/message-us

Customers messages or feedback api.

REQUEST BODY

fcm_id
STRING
user_id
INT
message
TEXT

REQUIRED

api_token
STRING

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

Thank you ! We will get back to you Soon...



POST Share Review
/api/review

Driver review api.

REQUEST BODY

fcm_id
STRING
user_id
INT
booking_id
INT

REQUIRED

ratings
NUMERIC

REQUIRED|NUMERIC|MIN:1|MAX:5

review_text
STRING

REQUIRED

api_token
STRING

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

Thank you. Your Review helps us Improve our Services.

data.rideinfo.user_id
INT

data.rideinfo.booking_id
INT

data.rideinfo.ratings
NUMERIC

data.rideinfo.review_text
STRING



POST Change Password
/api/change-password

Change Password api to update new password

REQUEST BODY

fcm_id
STRING
user_id
INT
new_password
STRING

REQUIRED

api_token
STRING

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

Your Password has been Updated Successfully.



POST Book Now
/api4now

book now api to book ride on current time

REQUEST BODY

fcm_id
STRING
user_id
INT
source_address
STRING

REQUIRED

dest_address
STRING

REQUIRED

source_lat
STRING
source_long
STRING
dest_lat
STRING
dest_long
STRING
booking_type
INT

0= BOOK NOW, 1=BOOK LATER

api_token
STRING

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

Your Request has been Submitted Successfully.

data.booking_id
INT



POST Book Later
/api/book-later

book ride later api

REQUEST BODY

fcm_id
STRING
api_token
STRING

REQUIRED

user_id
INT
source_address
STRING

REQUIRED

dest_address
STRING

REQUIRED

source_lat
STRING
source_long
STRING
dest_lat
STRING
dest_long
STRING
booking_type
INT

1=BOOK LATER, 0=BOOK NOW

journey_date
STRING

YYYY-MM-DD

journey_time
STRING

00:00:00

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

Your Request has been Submitted Successfully.

data.booking_id
INT



POST Update Destination
/api/update-destination

update destination address api

REQUEST BODY

fcm_id
STRING
user_id
INT
dest_address
STRING

REQUIRED

dest_lat
STRING
dest_long
STRING
booking_id
INT
api_token
STRING

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

Your Destination has been Updated Successfully.

data.rideinfo.user_id
INT

data.rideinfo.booking_id
INT

data.rideinfo.dest_address
STRING

data.rideinfo.dest_lat
STRING

data.rideinfo.dest_long
STRING



POST Ride History
/api/ride-history

Ride history of particular customer

REQUEST BODY

customer_id
INT
api_token
STRING

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

Data Received.

data.rides.booking_id
INT

data.rides.user_id
INT

data.rides.book_date
DATE

data.rides.book_time
STRING

data.rides.source_address
STRING

data.rides.source_time
DATETIME

data.rides.dest_address
STRING

data.rides.dest_time
DATETIME

data.rides.driving_time
STRING

data.rides.total_kms
STRING

data.rides.amount
NUMERIC

data.rides.ride_status
STRING

COMPLETED/ UPCOMING/ CANCELLED



POST Change Driver Availability
/api/change-availability

Change driver's availability status : online/offline

REQUEST BODY

fcm_id
STRING
user_id
INT
availability
INT

0 = OFFLINE, 1= ONLINE

api_token
STRING

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

You are now Online/OFFLINE



POST User Logout
/api/user-logout

User's logout api

REQUEST BODY

user_id
INT
api_token
STRING

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

You have Logged out Successfully.



POST Ride Requests
/api/ride-requests

list of not accepted rides

REQUEST BODY

api_token
STRING

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

Data Received.

data.ride_requests.booking_id
INT

data.ride_requests.book_date
DATE

data.ride_requests.book_time
STRING

data.ride_requests.source_address
STRING

data.ride_requests.dest_address
STRING

data.ride_requests.journey_date
DATE

data.ride_requests.journey_time
STRING



POST Driver's Single-ride-request
/api/single-ride-request

Driver's single ride's detail

REQUEST BODY

fcm_id
STRING
booking_id
INT

REQUIRED

user_id
INT
api_token
STRING

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

Data Received.

data.riderequest_info.booking_id
INT

data.riderequest_info.source_address
STRING

data.riderequest_info.dest_address
STRING

data.riderequest_info.book_date
DATE

data.riderequest_info.book_time
STRING

data.riderequest_info.journey_date
DATE

data.riderequest_info.journey_time
STRING

data.riderequest_info.accept_status
INT

1 = ACCEPTED, 0 = NOT ACCEPTED

data.riderequest_info.approx_timetoreach
STRING

data.user_details.user_id
INT

data.user_details.user_name
STRING

data.user_details.mobno
NUMERIC

data.user_details.profile_pic
URL



POST User's single-ride-request
/api/user-single-ride

Customer's single ride info

REQUEST BODY

fcm_id
STRING
booking_id
INT

REQUIRED

user_id
INT
api_token
STRING

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

Data Received.

data.rideinfo.user_id
INT

data.rideinfo.booking_id
INT

data.rideinfo.source_address
STRING

data.rideinfo.dest_address
STRING

data.rideinfo.source_time
STRING

data.rideinfo.dest_time
STRING

data.rideinfo.book_date
DATE

data.rideinfo.book_time
STRING

data.rideinfo.driving_time
STRING

data.rideinfo.total_kms
STRING

data.rideinfo.amount
NUMERIC

data.rideinfo.ride_status
STRING

COMPLETED/ UPCOMING/ CANCELLED

data.driver_details.driver_id
INT

data.driver_details.driver_name
STRING

data.driver_details.profile_pic
URL

data.driver_details.ratings
NUMERIC

data.ride_review.profile_pic
URL

data.ride_review.user_id
INT

data.ride_review.booking_id
INT

data.ride_review.review_text
STRING

data.ride_review.date
DATE

data.fare_breakdown.base_fare
NUMERIC

data.fare_breakdown.ride_amount
NUMERIC

data.fare_breakdown.extra_charges
NUMERIC



POST Cancel Ride Request
/api/cancel-ride-request

driver can cancle ride using this api

REQUEST BODY

fcm_id
STRING
booking_id
INT

REQUIRED

user_id
INT
reason
STRING

REQUIRED

api_token
STRING

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

Your Ride has been Cancelled Successfully.

data.booking_id
INT



POST Reject Ride Request
/api/reject-ride-request

Driver reject ride

REQUEST BODY

fcm_id
STRING
booking_id
INT

REQUIRED

user_id
INT
api_token
STRING

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

You have Rejected a Ride Request.

data.booking_id
INT



POST Driver Reviews
/api/get-reviews

driver's review

REQUEST BODY

driver_id
INT

REQUIRED

api_token
STRING

REQUIRED

booking_id
INT

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

Data Received.

data.driver_reviews.user_id
INT

data.driver_reviews.user_name
STRING

data.driver_reviews.profile_pic
URL

data.driver_reviews.booking_id
INT

data.driver_reviews.ratings
NUMERIC

data.driver_reviews.review_text
STRING

data.driver_reviews.date
DATE



POST Start Ride
/api/start-ride

Start ride api

REQUEST BODY

fcm_id
STRING
user_id
INT
booking_id
INT

REQUIRED

start_address
STRING
start_lat
STRING
start_long
STRING
api_token
STRING

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

Ride Started

data.booking_id
INT



POST Destination Reached
/api/destination-reached

Destination reach api, call when ride completed

REQUEST BODY

fcm_id
STRING
user_id
INT
booking_id
INT

REQUIRED

end_address
STRING

REQUIRED

end_lat
STRING
end_long
STRING
ride_time
INT
driving_time
INT
total_kms
NUMERIC

REQUIRED

api_token
STRING

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

Ride Completed

data.rideinfo.booking_id
INT

data.rideinfo.source_address
STRING

data.rideinfo.dest_address
STRING

data.rideinfo.source_timestamp
DATETIME

data.rideinfo.dest_timestamp
DATETIME

data.rideinfo.book_timestamp
DATETIME

data.rideinfo.ridestart_timestamp
DATETIME

data.rideinfo.driving_time
STRING

data.rideinfo.total_kms
STRING

data.rideinfo.amount
NUMERIC

data.rideinfo.ride_status
STRING

COMPLETED/ UPCOMING/ CANCELLED

data.user_details.user_id
INT

data.user_details.user_name
STRING

data.user_details.profile_pic
URL

data.ride_review.user_id
INT

data.ride_review.ratings
NUMERIC

data.ride_review.review_text
STRING

data.ride_review.date
DATE

data.fare_breakdown.base_fare
NUMERIC

data.fare_breakdown.ride_amount
NUMERIC

data.fare_breakdown.extra_charges
NUMERIC



POST Confirm Payment
/api/confirm-payment

Payment confirmation api

REQUEST BODY

booking_id
INT

REQUIRED

api_token
STRING

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

Payment Received.

data.booking_id
INT

data.payment_status
INT

1 = PAYMENT COMPLETED, 0 = PAYMENT INCOMPLETE

data.payment_mode
STRING



POST Accept Ride Request
/api/accept-ride-request

Accept ride by driver

REQUEST BODY

approx_timetoreach
NUMERIC
booking_id
INT

REQUIRED

user_id
INT

REQUIRED

fcm_id
STRING
api_token
STRING

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

You have Accepted the Ride Request. Pick up the Customer on Time !

data.riderequest_info.booking_id
INT

data.riderequest_info.source_address
STRING

data.riderequest_info.dest_address
STRING

data.riderequest_info.book_date
DATE

data.riderequest_info.book_time
STRING

data.riderequest_info.journey_date
DATE

data.riderequest_info.journey_time
STRING

data.riderequest_info.accept_status
INT

1 = ACCEPTED, 0 = NOT ACCEPTED

data.riderequest_info.approx_timetoreach
STRING

data.user_details.user_id
INT

data.user_details.user_name
STRING

data.user_details.mobno
NUMERIC

data.user_details.profile_pic
URL



POST Driver Rides
/api/driver-rides

list of rides by particular driver

REQUEST BODY

driver_id
INT

REQUIRED

api_token
STRING

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

Data Received.

data.upcoming_rides.booking_id
INT

data.upcoming_rides.book_date
DATE

data.upcoming_rides.book_time
STRING

data.upcoming_rides.source_address
STRING

data.upcoming_rides.dest_address
STRING

data.upcoming_rides.journey_date
DATE

data.upcoming_rides.journey_time
STRING

data.upcoming_rides.ride_status
STRING

data.completed_rides.booking_id
INT

data.completed_rides.book_date
DATE

data.completed_rides.book_time
STRING

data.completed_rides.source_address
STRING

data.completed_rides.source_time
DATETIME

data.completed_rides.dest_address
STRING

data.completed_rides.dest_time
DATETIME

data.completed_rides.driving_time
STRING

data.completed_rides.total_kms
STRING

data.completed_rides.amount
NUMERIC

data.completed_rides.journey_date
DATE

data.completed_rides.journey_time
STRING

data.completed_rides.ride_status
STRING

data.cancelled_rides.booking_id
INT

data.cancelled_rides.book_date
DATE

data.cancelled_rides.book_time
STRING

data.cancelled_rides.source_address
STRING

data.cancelled_rides.dest_address
STRING

data.cancelled_rides.journey_date
DATE

data.cancelled_rides.journey_time
STRING

data.cancelled_rides.ride_status
STRING



POST Single Ride Info
/api/single-ride-info

single ride detail of particular booking

REQUEST BODY

booking_id
INT

REQUIRED

api_token
STRING

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

Data Received.

data.rideinfo.booking_id
INT

data.rideinfo.source_address
STRING

data.rideinfo.dest_address
STRING

data.rideinfo.source_timestamp
DATETIME

data.rideinfo.dest_timestamp
DATETIME

data.rideinfo.book_timestamp
DATETIME

data.rideinfo.ridestart_timestamp
DATETIME

data.rideinfo.driving_time
STRING

data.rideinfo.total_kms
STRING

data.rideinfo.amount
NUMERIC

data.rideinfo.ride_status
STRING

data.user_details.user_id
INT

data.user_details.user_name
STRING

data.user_details.mobno
NUMERIC

data.user_details.profile_pic
URL

data.ride_review.user_id
INT

data.ride_review.ratings
NUMERIC

data.ride_review.review_text
STRING

data.ride_review.date
DATE

data.fare_breakdown.base_fare
NUMERIC

data.fare_breakdown.ride_amount
NUMERIC

data.fare_breakdown.extra_charges
NUMERIC

data.fare_breakdown.payment_mode
STRING



POST Active Drivers
/api/active-drivers

List of online drivers

REQUEST BODY

api_token
STRING

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

Data Received.

data.driver_details
INT

ARRAY OF DRIVER_ID



POST Get Settings
/api/get-settings

list of fare-breakdowns

REQUEST BODY

api_token
STRING

REQUIRED

RESPONSE BODY

success
INT

1 = TRUE, 0 = FALSE

message
STRING

Data Received.

data.base_fare
NUMERIC

data.base_km
NUMERIC

data.std_fare
NUMERIC

data.base_waiting_time
NUMERIC

data.weekend_base_fare
NUMERIC

data.weekend_base_km
NUMERIC

data.weekend_wait_time
NUMERIC

data.weekend_std_fare
NUMERIC

data.night_base_fare
NUMERIC

data.night_base_km
NUMERIC

data.night_wait_time
NUMERIC

data.night_std_fare
NUMERIC

data.reasons
STRING

ARRAY OF REASONS

data.distance_format
STRING

KM/ MILES