AdminCompainesV1

APIDescription
POST v1/admin/companies

ADMIN - List companies according to the approvement status

POST v1/admin/companies/setApproved

ADMIN - Updates the approvement status of a single company for an admin.

POST v1/admin/companies/update

ADMIN - Updates a single company for an admin.

POST v1/admin/companies/insert

ADMIN - Insert a single company.

POST v1/admin/companies/vehicle-user-relation/add

ADMIN - Add Company vehicle relation to user.

POST v1/admin/companies/vehicle-user-relation/disable

ADMIN - Disable Company vehicle relation to user.

POST v1/admin/companies/vehicle-user-relation/list

ADMIN - List Company vehicle relation to user.

POST v1/company/user-relation/list

WEB - USER COMPANY RELATIONS

POST v1/company/user-relation/save

WEB - USER COMPANY RELATIONS SAVE

POST v1/company/user-vehicle/list

WEB - List user's vehicles.

POST v1/company/user-vehicle/approve

WEB - User vehicle approve.

AdminMobileUsersV1

APIDescription
POST v1/admin/mobileUsers

ADMIN - Returns a list of mobile users for an admin.

POST v1/admin/mobileUsers/detail

ADMIN - Returns the details of a mobile user for an admin.

POST v1/admin/mobileUsers/detail/byCellNumber

ADMIN - Returns the details of a mobile user for an admin by the user mobile cell number.

POST v1/admin/mobileUsers/update

ADMIN - Updates a single mobile user for an admin.

POST v1/admin/mobileUsers/updateVehicle

ADMIN - Updates a single vehicle of a mobile user for an admin.

POST v1/admin/mobileUsers/changeVehicleUser

ADMIN - Change vehicle user for an admin.

POST v1/admin/mobileUsers/short-info/byCellNumber

ADMIN - Return user basic info for an admin by the user mobile cell number.

POST v1/admin/mobileUsers/add

ADMIN - Add mobile user with company.

POST v1/admin/mobileUsers/send/message-or-notification

ADMIN - Send message or notification for user uid list

POST v1/admin/send/email

ADMIN - Send email

AdminShipmentV1

APIDescription
POST v1/admin/shipment/detail

ADMIN - Returns the details of a shipment for an admin.

POST v1/admin/shipment/listByCompany

ADMIN - Returns the list of shipments of a company filterable by an optional company specific custom ID.

POST v1/admin/shipment/delete

POST v1/admin/shipment/state

ADMIN - Change shipment state.

POST v1/admin/shipment/listByUser

ADMIN - Get shipments by user id.

POST v1/admin/shipment/vehicle-stop-times

ADMIN - Shipment Vehicle Stop Times Summary Result

POST v1/admin/shipment/vehicle-stop-times/add

ADMIN - Add Shipment Vehicle Stop Times Summary Request | Status : 0- Waiting 1- Preparing 2- Completed

POST v1/admin/shipment/company-shipment-count

ADMIN - Company Shipment Count List

AdminUsersV1

APIDescription
POST v1/admin/users

ADMIN - Returns a list of company users for an admin.

POST v1/admin/users/detail

ADMIN - Returns the details of a company user for an admin.

POST v1/admin/users/update

ADMIN - Updates a single company user for an admin.

POST v1/admin/users/delete

ADMIN - Delete company user

ApplicationV1

APIDescription
GET v1/application/health

Application Health.

POST v1/application/confirmation

MOBILE - WEB - Send 6 digits number confirmation code to user's cell phone as SMS.

POST v1/mobile/application/setting

MOBILE - APPLICATION SETTINGS.

POST v1/web/application/setting

WEB - APPLICATION SETTINGS.

POST v1/web/application/web/user/forgot

WEB - APPLICATION SEND MAIL TO USER WITH PWD RESET LINK.

POST v1/web/application/web/user/forgot/confirm

WEB - APPLICATION CHANGE USER PASSWORD.

POST v1/application/mobile/user/forgot

MOBILE - APPLICATION SEND MAIL TO USER WITH PWD RESET LINK.

POST v1/application/mobile/user/forgot/confirm

MOBILE - APPLICATION CHANGE USER PASSWORD.

POST v1/application/report/list

WEB - APPLICATION REPORT LIST.

POST v1/application/role/add

APPLICATION ADD ROLE

POST v1/application/role/delete

APPLICATION DELETE ROLE

POST v1/application/role/update

APPLICATION UPDATE ROLE

POST v1/application/role/list

APPLICATION ROLE LIST

POST v1/application/role/save-permissions

APPLICATION UPDATE ROLE PERMISSIONS

POST v1/application/role/permissions

APPLICATION UPDATE ROLE PERMISSIONS

POST v1/application/permission/list

APPLICATION PERMISSION LIST

POST v1/application/permission/update

APPLICATION UPDATE PERMISSION

POST v1/application/permission/add

APPLICATION ADD PERMISSION

POST v1/application/permission/delete

APPLICATION DELETE PERMISSION

POST v1/application/company-user/permissions

APPLICATION COMPANY USER PERMISSION LIST

POST v1/application/menu/add

APPLICATION ADD MENU

POST v1/application/menu/update

APPLICATION UPDATE MENU

POST v1/application/menu/delete

APPLICATION DELETE MENU

POST v1/application/menu/list

APPLICATION MENU LIST

CompanyV1

APIDescription
POST v1/company/new

WEB - REGISTER NEW COMPANY

POST v1/company/login

WEB - LOGIN TO COMPANY ACCOUNT

POST v1/company/logout

WEB - LOGOUT FROM COMPANY ACCOUNT

POST v1/company/sessionState

WEB - CHECK ACTIVE SESSION STATE FOR COMPANY ACCOUNT

POST v1/company/user/register

WEB - CREATE COMPANY USER

POST v1/company/user/update

WEB - UPDATE USER PROFILE OF CURRENT COMPANY USER

POST v1/company/user/updatePassword

WEB - UPDATE PASSWORD OF CURRENT COMPANY USER

POST v1/company/subcompanies

WEB - RETURN THE LIST OF SUB-COMPANIES OF A PARENT COMPANY THAT CAN BE MANAGED BY THE CURRENT COMPANY

POST v1/company/subcompany/add

WEB - NEW SUB COMPANY AND DELEGATION

POST v1/company/subcompany/update

WEB - UPDATE SUB COMPANY

POST v1/company/subcompany/change-status

WEB - SUB COMPANY CHANHE APPROVE STATUS

POST v1/company/user

WEB - LIST COMPANY USERS

POST v1/company/user/disable

WEB - DISABLE COMPANY USER

POST v1/company/user/setEnabled

WEB - ENABLE/DISABLE COMPANY USER

POST v1/company/shipment

WEB - LIST SHIPMENT. List active shipments.

POST v1/company/shipment/by-company-list

WEB - LIST SHIPMENT BY COMPANY IDS. List active shipments.

POST v1/company/shipment/listDelegated

WEB - LIST DELEGATED SHIPMENTS

POST v1/company/shipment/offer

WEB - LIST OFFERS. To get offers for a shipment.

POST v1/company/shipment/offer/accept

WEB - ACCEPT OFFER.

POST v1/company/shipment/count

WEB - LIST SHIPMENT COUNTS.

POST v1/company/shipment/state

WEB - CHANGE SHIPMENT STATE.

POST v1/company/shipment/departuredate

WEB - CHANGE SHIPMENT DEPARTURE DATE.

POST v1/company/shipment/add

WEB - ADD NEW SHIPMENT

POST v1/company/shipment/remove

WEB - DELETE SHIPMENT

POST v1/company/shipment/share

WEB - SHARE A SHIPMENT WITH AN AUTO-GENERATED TOKEN.

POST v1/company/shipment/share/detail

POST v1/company/shipment/share/location-detail

POST v1/company/shipment/address

WEB - LIST COMPANY ADDRESSES

POST v1/company/shipment/address/detail

WEB - COMPANY ADDRESSES BY ID

POST v1/company/shipment/address/add

WEB - ADD NEW ADDRESS.

POST v1/company/shipment/address/remove

WEB - REMOVE ADDRESS.

POST v1/company/shipment/address/update

WEB - UPDATE ADDRESS.

POST v1/company/shipment/location

WEB - User location in transit.

POST v1/company/shipment/locationDetails

WEB - User location details for a shipment.

POST v1/company/driver

WEB - List drivers of the company

POST v1/company/driver/details

WEB - Return the detailed information for a driver

POST v1/company/driver/statistics

WEB - Return the performance statistics for a driver

POST v1/company/driver/add

WEB - Add company driver

POST v1/company/driver/remove

WEB - Remove company driver

POST v1/company/driver/checkAvailable

WEB - List drivers of the company available between two specific date time points

POST v1/company/driver/findNearby

WEB - Find drivers near to a location

POST v1/company/driver/profileDetails

WEB - Find the profile details of a driver

POST v1/company/driver/assignShipment

WEB - Assign a company shipment to a company driver

POST v1/company/shipmentTemplate/list

WEB - List shipment templates of the company

POST v1/company/shipmentTemplate/save

WEB - Adds or updates a shipment template

POST v1/company/shipmentTemplate/remove

WEB - Remove a shipment template

POST v1/company/delegate/list

WEB - List delegate companies of the company

POST v1/company/shipment/delegate

WEB - Delegate a shipment to another company

POST v1/company/shipment/offerRequest

WEB - Request offers for a company shipment from a list of drivers

POST v1/company/shipment/offerRequest/list

WEB - Returns offers for a company shipment

POST v1/company/feedback/questions

WEB - Return the list of feedback questions for a shipment feedback

POST v1/company/feedback

WEB - Return the list of feedback questions for a shipment feedback

POST v1/company/approvedCompany/list

WEB - Returns the list of appreved companies

POST v1/company/shipment/listByState

WEB - Returns the list of shipment by state and date of global

POST v1/company/vehicle/add

WEB - Register new vehicle to company.

POST v1/company/vehicle/update

WEB - Update vehicle for company.

POST v1/company/vehicle/remove

WEB - Remove vehicle for company.

POST v1/company/vehicle/list

WEB - List company's vehicles.

POST v1/company/vehicle/detail

WEB - Detail company's vehicle.

POST v1/company/shipment/report

WEB - REPORT LIST SHIPMENT. List active shipments report.

POST v1/company/user/token

WEB - TOKEN TO COMPANY ACCOUNT

POST v1/company/user/token-login

WEB - TOKEN TO COMPANY ACCOUNT LOGIN

POST v1/company/driver/blacklist

WEB - Blacklist for drivers of the company

POST v1/company/driver/blacklist/add

WEB - Add blacklist company driver

POST v1/company/driver/blacklist/delete

WEB - Delete company driver ing blacklist

POST v1/company/shipment/document-list

WEB - LIST SHIPMENT DOCUMENTS

MobileShipmentOfferV1

Manages shipment offer methods for the mobile user

APIDescription
POST v1/user/shipment/offer

MOBILE - Shipment get all offers.

POST v1/user/shipment/offer/add

MOBILE - Shipment add offer.

POST v1/user/shipment/offer/accept

MOBILE - Shipment accept offer.

POST v1/user/shipment/offer/count

MOBILE - Shipment offers count.

POST v1/user/shipment/offer/listStatus

MOBILE - Shipment offers by count status.

MobileV1

APIDescription
POST v1/user/register

MOBILE - Register new user to system if given cell number is not in DB, cell number must have 10 digits long.

POST v1/user/update

MOBILE - Update user's details. You can call this method only once. Only the field you can update more than once is user_image by calling v1/user/image

POST v1/user/update/image

MOBILE - Update user's image.

POST v1/user/device

MOBILE - Register or Update is exists user mobile device UUID for push notification.

POST v1/user/login

MOBILE - Login user, returns user details.

POST v1/user/logout

MOBILE - Logout user, once user logged out system does not send push notification or SMS. User not listed under available drivers.

POST v1/user/sessionState

MOBILE - Check active session state for mobile user account.

POST v1/user/statistics

MOBILE - Return the performance statistics for the mobile user.

POST v1/user/location

MOBILE - Receive user's location.

POST v1/user/location/multiple

MOBILE - Receive user's multiple locations.

POST v1/user/vehicle

MOBILE - List user's vehicles.

POST v1/user/vehicle/add

MOBILE - Register new vehicle to user domain.

POST v1/user/vehicle/update

MOBILE - Update existing vehicle to user domain.

POST v1/user/vehicle/remove

MOBILE - Remove existing vehicle from user domain.

POST v1/user/bank

MOBILE - List user's bank account.

POST v1/user/bank/add

MOBILE - Register new bank account to user domain.

POST v1/user/bank/remove

MOBILE - Remove existing bank account from user domain.

POST v1/user/shipment

MOBILE - List shipments.

POST v1/user/shipment/offerRequest/list

MOBILE - Return the list of offer requests for the user.

POST v1/user/shipment/offerRequest/respond

MOBILE - Respond to one of the offer requests.

POST v1/user/shipment/departure/paper/add

MOBILE - UPLOAD Departure Papers.

POST v1/user/shipment/departure/paper/add/multiple

MOBILE - UPLOAD Departure Multiple Papers.

POST v1/user/shipment/delivery/paper/add

MOBILE - UPLOAD DELIVERY Papers.

POST v1/user/shipment/delivery/paper/add/multiple

MOBILE - UPLOAD DELIVERY Multiple Papers.

POST v1/user/shipment/delivery/paper/invoice/add

MOBILE - UPLOAD DELIVERY Papers.

POST v1/user/shipment/delivery/paper/invoice/add/multiple

MOBILE - UPLOAD DELIVERY Multiple Papers.

POST v1/user/report/add

MOBILE - Submit Report.

POST v1/user/shipment/stop/log

MOBILE - INSERT Stop Entry Log.

POST v1/user/shipment/onroad

MOBILE - User set shipment on road.

POST v1/user/shipment/checkVehicle

MOBILE - User check vehicle type for shipment.

POST v1/user/shipment/document-list

MOBILE - LIST SHIPMENT DOCUMENTS

ShipmentProblemV1

Contains mobile and web user methods for shipment problem reporting

APIDescription
POST v1/user/shipmentProblem

MOBILE - Returns the list of shipment problems for a shipment to the mobile user

POST v1/company/shipmentProblem

WEB - Returns the list of shipment problems for a shipment to the web user

POST v1/user/shipmentProblem/create

MOBILE - Creates a problem report for a shipment

TestApi

APIDescription
POST v1/test/sms?phoneNumber={phoneNumber}

TEST - Test SMS Service