Introduction

This service, is used for computing optimum routes.

In order to compute the optimum routes, you need to call some services in order.

NOTE:

To be able to call any web services described here, you need to obtain your API KEY using the logvrp web application GUI.

In order to obtain your API KEY, first log into logvrp web application and click "Manage API Key" button.

 

 Simply the steps are:

  • Get Ticket
  • Set Stations
  • Set Location Working Hours (optional, not required)
  • Set Distance Matrix
  • Set Duration Matrix
  • Set Orders
  • Set Order Periods (optional, not required)
  • Set Vehicles
  • Set Vehicle Working Hours (optional, not required)
  • Set Vehicle Hourly Costs (optional, not required)
  • Set Vehicle Location Assignments (optional, not required)
  • Set Parameters (optional, not required)
  • Run Computation
  • Get Result

  These are:

  1. Get a computation ticket using "Ticket" service
  2. Set stations that will be used in the computation using "Stations" service.
  3. Set location working hours using "LocationWorkingHours" service. (optional)
  4. Set distance matrix that will be used in the computation using "DistanceMatrix" service. Some notes:
    • Even if you do no not have any distance matrix values, you need to call this with a null value.
    • If you do no not have any distance matrix values, in this case, logvrp will calculate the distances for your stations data.
    • If you have distance matrix that you want logvrp to use, then you need to provide the distance matrix values
    • If you provide your distance matrix, in this case, logvrp will use your distances for your stations data.
  5. Set duration matrix that will be used in the computation using "DurationMatrix" service. Some notes:
    • Even if you do no not have any duration matrix values, you need to call this with a null value.
    • If you do no not have any duration matrix values, in this case, logvrp will calculate the duration for your stations data.
    • If you have duration matrix that you want logvrp to use, then you need to provide the duration matrix values
    • If you provide your duration matrix, in this case, logvrp will use your duration for your stations data.
  6. Set orders that will be used in the computation using "Orders" service.
  7. Set order periodicity/recurrence information using "OrderPeriods" service. (optional)
  8. Set vehicles that will be used in the computation using "Vehicles" service.
  9. Set vehicle working hours using "VehicleWorkingHours" service. (optional)
  10. Set vehicle hourly costs using "VehicleHourlyCosts" service. (optional)
  11. Set vehicle-location assignments using "VehicleLocationAssignments" service. (optional). If each of your vehicles have different territories to serve, or each vehicle has different customer locations pre-assigned, you can use this service to specify those vehicle-customer location mappings.
  12. Set additional computation parameters using "Parameters" service. (optional)
  13. Use "Optimization" service in order to start route optimization. You can specify optimization parameters, constraints and options in this step.
    • You need to specify which algorithm should be run.
    • "Optimization" service will return how much you need to wait in order to get optimum routes as "seconds".
    • You need to wait that much seconds that "Optimization" service returned.
    • When the time to wait (specified by "Optimization" service in the previous step) elapsed then get the results.
  14. Use "Result" service in order to get optimum routes. You will get the optimum routes calculated by the algorithm, you have specified.

 

Services

  1. Ticket
  2. Stations
  3. LocationWorkingHours
  4. DistanceMatrix
  5. DurationMatrix
  6. Orders
  7. OrderPeriods
  8. Vehicles
  9. VehicleWorkingHours
  10. VehicleHourlyCosts
  11. VehicleLocationAssignments
  12. Parameters
  13. Optimization
  14. Result

 

Web Service Return Codes

 

ReturnCode Explanation What to do
0 The web service resulted with success. The result can be used safely.
4 The data can not be retrieved from the storage, or cache. This usually happens when one of the input data values is null, empty or missing. After checking your data, if this value persists, please consult support.
6 or 7 An inner unkown error occured. Try again. If it persists, please consult support.
41 The operation is not allowed for you If you think you should have permission, please consult support.
42 Your session may have been expired, since you have passed your data (stations, orders, vehicles) Resend your vrp data using appropriate service
43 There is no such algorithm with the given code Please check your algorithm code you have supplied.
49 An invalid parameter has been used Please check your parameters supplied to service
52 Algorithm could not find valid results. You may try once more, and check your input data feasibility. If you are sure that your data is feasible, please consult support.
56 You can not call the service so frequent. Please allow some more time before calling the service.
58 Algorithm could not find a solution. You may try once more, since algorithms include some randomness.
59 The data you have supplied is not feasible. Please check your input data feasibility. If you are sure that your data is feasible, please consult support.
61 Algorithms to be used are not supplied. Please supply the algorithm IDs you want to use in optimization
75 One of the input values is null, which is required Please check your input data whether there are missing that are required.
77 The station IDs supplied are not unique. Please adjust the IDs of the stations you supply to the service so that they are unique
78 The order IDs supplied are not unique. Please adjust the IDs of the orders you supply to the service so that they are unique
79 The vehicle IDs supplied are not unique. Please adjust the IDs of the vehicles you supply to the service so that they are unique
80 The given distance matrix does not contain as much as rows and/or colummns that match with the number of stations you provided. Please check the matrix so that it is an m x m matrix, if there are m number of stations
81 You have provided more than the number of stations your account limit. Please decrease the number of stations you provide so that it is less than or equal to your account limit. You can use Divide Into Regions feature.
82 You have provided more than the number of logvrp vehicles limit. Please decrease the number of vehicles you provide so that it is less than or equal to your logvrp limit (currently 50).
83 You have provided more than the number of logvrp orders limit. Please decrease the number of orders you provide so that it is less than or equal to your logvrp limit (currently 1000).
84 The optimization computation is not finished yet. Please wait as much as the given seconds in the service and try again.
86 Your computation ticket ID has not been found. Either your computation session is expired or you did not provided a valid computation ticket ID. Please provide a valid computation ticket ID, calling the Ticket service.
87 There was a problem setting your data. Please try again and if it persists, please consult support.
88 There was a problem setting your computation ticket. Please try again and if it persists, please consult support.
89 There was a problem caching your data. Please try again and if it persists, please consult support.
90 There is no computation running for this computation ticket. Most probably your computation session is expired. Please restart a new optimization.
91 You have called the service too freqently. Please allow some time and try again.
Have more questions? Submit a request

0 Comments

Article is closed for comments.
Powered by Zendesk