Parameters - v1

Description

This service, is optional. You do not have to use this service.

This service should be used if you would like to set additional computation parameters.

Note that, please consult us to learn more about this service.

Input

  1. apiKey: In order to obtain your API KEY, first log into logvrp web application and click "Manage API Key" button.
  2. computationTicketID: You will get this using Ticket service.
  3. parameters: Array of "VrpParameter" where "VrpParameter" is defined as follows:
    1. name: String. The name of the computation parameter.
    2. value: String. The value of the computation parameter.

Parameter names and values that can be used:

  1. planningHorizon: a string which defines an integer value which is one of "0", "1", "2", "3", "4", "5".  The meaning of these values are:
    • "0" - none,
    • "1" - hour,
    • "2" - day,
    • "3" - week,
    • "4" - month,
    • "5" - year.
  2. optimizationGoal: a string which defines an integer value which is one of "0", "1", "2", "3", "4", "5", "6", "7", "8".  The meaning of these values are:
    • "0" - balanced,
    • "1" - minimize cost,
    • "2" - minimize distance,
    • "3" - minimize total operation time,
    • "4" - minimize route count,
    • "5" - vehicle decision,
    • "6" - minimize idle time,
    • "7" - mximize vehicle capacity utilization,
    • "8" - maximize route value.
  3. optimizationGoalCostImportance: a string which defines an double value between "0.0" and "1.0". Higher value means that this value is important.
  4. optimizationGoalDistanceImportance: a string which defines an double value between "0.0" and "1.0". Higher value means that this value is important.
  5. optimizationGoalOperationTimeImportance: a string which defines an double value between "0.0" and "1.0". Higher value means that this value is important.
  6. optimizationGoalVehicleCountMinimizationImportance: a string which defines an double value between "0.0" and "1.0". Higher value means that this value is important.
  7. optimizationGoalVehicleCapacityUtilizationImportance: a string which defines an double value between "0.0" and "1.0". Higher value means that this value is important.
  8. optimizationGoalVehicleIdleTimeMinimizationImportance: a string which defines an double value between "0.0" and "1.0". Higher value means that this value is important.
  9. optimizationGoalHumanResourceUtilizationImportance: a string which defines an double value between "0.0" and "1.0". Higher value means that this value is important.
  10. optimizationGoalToolResourceUtilizationImportance: a string which defines an double value between "0.0" and "1.0". Higher value means that this value is important.
  11. optimizationGoalValueMaximizationImportance: a string which defines an double value between "0.0" and "1.0". Higher value means that this value is important.
  12. optimizationGoalValueFactorMaximizationImportance: a string which defines an double value between "0.0" and "1.0". Higher value means that this value is important.
  13. optimizationGoalValueProbabilityMaximizationImportance: a string which defines an double value between "0.0" and "1.0". Higher value means that this value is important.
  14. minimumVehicleCapacityUtilization: a string which defines an integer value between "1" and "100"
  15. computationCompleteCallbackUrl: a string URL, which is called by logvrp with POST, after computation finishes. If you want to be notified computation complete event, then implement an http endpoint which can be called with HTTP POST. This will be called by logvrp with the following JSON body parameters: { "vrpComputationTicketId": "...  computation ticket id that completed ...", "algorithmId": ".. the algorithm id that completed computation ..." }

Output

Data: Returned data
Message: Output message
ReturnCode: Return code of the output. If "Success" is true, then check this value.
Success: If unpected errors, or exceptions occur, this will be false.
success: Same as Success

REST - JSON

URL
Input
Body
 

{

  "apiKey": "your API key here",

  "computationTicketID": "your computation ticket here",

  "parameters": [

{
name: "planningHorizon",
value: "0"
},
{
name: "optimizationGoal",
value: "1"
},
{
name: "optimizationGoalCostImportance",
value: "1.0"
},
{
name: "optimizationGoalDistanceImportance",
value: "0.7"
},
{
name: "optimizationGoalOperationTimeImportance",
value: "0.75"
},
{
name: "optimizationGoalVehicleCountMinimizationImportance",
value: "0.8"
},
{
name: "optimizationGoalVehicleCapacityUtilizationImportance",
value: "0.9"
},
{
name: "optimizationGoalVehicleIdleTimeMinimizationImportance",
value: "0.5"
},
{
name: "optimizationGoalHumanResourceUtilizationImportance",
value: "0.1"
},
{
name: "optimizationGoalToolResourceUtilizationImportance",
value: "0.1"
},
{
name: "optimizationGoalValueMaximizationImportance",
value: "0.2"
},
{
name: "optimizationGoalValueFactorMaximizationImportance",
value: "0.2"
},
{
name: "optimizationGoalValueProbabilityMaximizationImportance",
value: "0.2"
},
{
name: "minimumVehicleCapacityUtilization",
value: "75"
},
{
name: "computationCompleteCallbackUrl",
value: "http://mydomain.com/logvrpcallback"
}

  ]

}

 
 
 
Headers
 
Content-Type: application/json
 
Method:
 
POST 
 
Output
Response
{
  "Data": null,
  "Message": null,
  "ReturnCode": 0,
  "Success": true,
  "success": true
}

 

Have more questions? Submit a request

0 Comments

Article is closed for comments.
Powered by Zendesk