VehicleHourlyCosts - 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 the additional hourly costs of vehicles.

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. vehicleHourlyCosts: Array of "VehicleHourlyCost" where "VehicleHourlyCost" is defined as follows:
    1. VehicleId: String. The Id of the vehicle that this working hours to be set. This vehicle id must exist in the vehicle list provided in the "Vehicles" service.
    2. Standard: A double value. Defines the cost of vehicle in regular working hours.
    3. Overtime: A double value. Defines the cost of vehicle in overtime working hours (out of regual working hours).
    4. Waiting: A double value. Defines the cost of vehicle in the pause time "within regular working hours".
    5. Idle: A double value. Defines the cost of vehicle in non-working hours. Note the difference between "Waiting".

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",

  "vehicleHourlyCosts": [

    {

      VehicleId: "1",

      Standard: 1,

      Overtime: 2,

      Waiting: 0.5,

      Idle: 0

    },

    {

      VehicleId: "2",

      Standard: 1.2,

      Overtime: 2.4,

      Waiting: 0.7,

      Idle: 0

    }

  ]

}

 
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