Easy Parcel API's |
| Name |
Path |
Method |
Parameters |
Success Response |
Failure Response |
| User Sessions |
| Registration |
/register.php |
POST |
*first_name
*last_name
*email
*password
*mobile
*profession
*device_id
|
{
"id":1,
"X-Access-Token":"pq8pgHWX95bLZCML",
"first_name":"your first name",
"last_name":"your last name",
"email":"youremail@example.com",
"profession":"",
"address":"",
"profile_image_url":null,
"mobile":"1234567890",
}
|
{
"status":422,
"message":"This email address already
exist in our records"
}
|
| Login |
/session.php |
POST |
*email
*password
*device_id
|
{
"id":1,
"X-Access-Token":"pq8pgHWX95bLZCML",
"first_name":"your first name",
"last_name":"your last name",
"email":"youremail@example.com",
"profession":"",
"address":"",
"profile_image_url":null,
"mobile":"1234567890",
"recovery_login":true/false
}
|
{
"status":400,
"message":"The email and password you
entered don't match"
}
|
| Logout |
/session.php |
POST |
*is_delete
(true)
|
{
"status":200,
"message":"Success"
}
|
{
"status":400,
"message":"An error occured while
deleting your session"
}
|
| Password |
| Forgot Password |
/password_recovery.php |
POST |
*email
|
{
"status":200,
"message":"We have sent an email to your
registered email address. Please
follow instructions provided in
email"
}
|
{
"status":404,
"message":"provided email id doesn't
exist"
}
|
| Change Password |
/change_password.php |
POST |
*old_password
*new_password
|
{
"status":200,
"message":"Success"
}
|
{
"status":400,
"message":"Old password doesn't match
with your account password"
}
|
| Profile |
| Get My Profile |
/profile.php |
GET |
|
{
"id":1,
"first_name":"your first name",
"last_name":"your last name",
"email":"youremail@example.com",
"profession":"",
"profile_image_url":null,
"mobile":"1234567890",
}
|
{
"status":401,
"message":"X-Access-Token header
is missing"
}
|
| Update Profile |
/profile.php |
POST |
first_name
last_name
profession
mobile
profile_image
|
{
"id":1,
"first_name":"your first name",
"last_name":"your last name",
"email":"youremail@example.com",
"profession":"",
"profile_image_url":null,
"mobile":"1234567890",
}
|
{
"status":401,
"message":"X-Access-Token header
is missing"
}
|
| Delete Account |
/profile.php |
DELETE |
|
|
{
"status":200,
"message":"Success"
}
|
{
"status":401,
"message":"X-Access-Token header
is missing"
}
|
| Push Notifications |
| Register Device (Push Notifications) |
/register_device.php |
POST |
*device_id
*device_token
*platform
(ios/android/
windows_mobile)
|
|
{
"status":200,
"message":"Success"
}
|
{
"status":400,
"message":"Unable to register
device token"
}
|
| Unregister Device (Push Notifications) |
/register_device.php |
POST |
*device_id
*is_delete
(true)
|
|
{
"status":200,
"message":"Success"
}
|
{
"status":400,
"message":"Unable to unregister
device"
}
|
API's for Journey |
| Journey |
| Add new journey |
/journey.php |
POST |
*jaunt_source
*jaunt_destination
*departure_date
*arrival_date
*transport_type
(bike/car/van/bus/truck)
*parcel_type
(letter/document/parcel/luggage)
*max_weight
*is_confirm
(true/false)
*is_visible
(true/false)
|
{
"status":200,
"message":"Success"
}
|
{
"status":401,
"message":"X-Access-Token header
is missing"
}
|
| Get Journey List |
/journey.php |
GET |
|
page_size
page_index
|
{
"past_journey":[
{
"id":1
"jaunt_source":"Bhopal",
"jaunt_destination":"Indore",
"departure_date":12345678,
"arrival_date":12345678,
"transport_type":"bike/car/van/bus/truck",
"max_weight":15,
"is_active":true/false
},
{
"id":1
"jaunt_source":"Nagpur",
"jaunt_destination":"Mumbai",
"departure_date":12345678,
"arrival_date":12345678,
"transport_type":"bike/car/van/bus/truck",
"max_weight":15,
"is_active":true/false
}],
"current_journey":[
{
"id":1
"jaunt_source":"Bhopal",
"jaunt_destination":"Indore",
"departure_date":12345678,
"arrival_date":12345678,
"transport_type":"bike/car/van/bus/truck",
"max_weight":15,
"is_active":true/false
},
{
"id":1
"jaunt_source":"Nagpur",
"jaunt_destination":"Mumbai",
"departure_date":12345678,
"arrival_date":12345678,
"transport_type":"bike/car/van/bus/truck",
"max_weight":15,
"is_active":true/false
}],
"upcoming_journey":[
{
"id":1
"jaunt_source":"Bhopal",
"jaunt_destination":"Indore",
"departure_date":12345678,
"arrival_date":12345678,
"transport_type":"bike/car/van/bus/truck",
"max_weight":15,
"is_active":true/false
},
{
"id":1
"jaunt_source":"Nagpur",
"jaunt_destination":"Mumbai",
"departure_date":12345678,
"arrival_date":12345678,
"transport_type":"bike/car/van/bus/truck",
"max_weight":15,
"is_active":true/false
}]
}
|
{
"status":401,
"message":"X-Access-Token header
is missing"
}
|
| Get Details of Journey |
/journey.php/:id |
GET |
|
{
"id":1,
"jaunt_source":"Bhopal",
"jaunt_destination":"Indore",
"departure_date":12345678,
"arrival_date":12345678,
"transport_type":"bike/car/van/bus/truck",
"max_weight":15,
"is_active":true/false
"User":{
"id":1,
"first_name":"user first name",
"last_name":"user last name",
"email":"youremail@example.com",
"profession":"Professor",
"profile_image_url":null,
"mobile":"1234567890",
"profile_image_url":"image_url1.jpg",
}
}
|
{
"status":404,
"message":"Transporter doesn't exist"
}
|
| Update Journey |
/journey.php/:id |
POST |
jaunt_source
jaunt_destination
departure_date
arrival_date
transport_type
(bike/car/van/bus/truck)
parcel_type
(letter/document/parcel/luggage)
max_weight
is_confirm
(true/false)
is_visible
(true/false)
|
{
"status":200,
"message":"Success"
}
|
{
"status":401,
"message":"We are unable to update journey"
}
|
| Delete Journey |
/journey.php/:id |
POST |
*is_delete
(true)
|
{
"status":200,
"message":"Success"
}
|
{
"status":401,
"message":"We are unable delete
your journey"
}
|
Searching Journey API |
Search Joureny |
/search.php |
GET |
*source
*destination
date
transport_type
(bike/car/van/bus/truck)
parcel_type
(letter/document/parcel/luggage)
max_weight
page_size
page_index
|
{
"journey":[
{
"id":1
"jaunt_source":"Bhopal",
"jaunt_destination":"Indore",
"departure_date":12345678,
"arrival_date":12345678,
"transport_type":"bike/car/van/bus/truck",
"max_weight":15,
"is_active":true/false
"User":{
"id":1,
"first_name":"user first name",
"last_name":"user last name",
"profile_image_url":"image_url1.jpg",
}
},
{
"id":1
"jaunt_source":"Bhopal",
"jaunt_destination":"Indore",
"departure_date":12345678,
"arrival_date":12345678,
"transport_type":"bike/car/van/bus/truck",
"max_weight":15,
"is_active":true/false
"User":{
"id":1,
"first_name":"user first name",
"last_name":"user last name",
"profile_image_url":"image_url1.jpg",
}
},
{
"id":1
"jaunt_source":"Bhopal",
"jaunt_destination":"Indore",
"departure_date":12345678,
"arrival_date":12345678,
"transport_type":"bike/car/van/bus/truck",
"max_weight":15,
"is_active":true/false
"User":{
"id":1,
"first_name":"user first name",
"last_name":"user last name",
"profile_image_url":"image_url1.jpg",
}
}]
}
|
{
"status":401,
"message":"X-Access-Token header
is missing"
}
|