VehicleLocationAssignments - v1

Description

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

This service should be used if you would like to define the pre-assigned locations of vehicles. This means that, if your vehicles serve to only specific customer locations, then you can pre-assign the vehicles to those locations.

Note that, if you pre-assign the vehicles to locations, then the vehicles will serve to those locations.

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. vehicleLocationAssignments: Array of "VehicleLocationAssignment" where "VehicleLocationAssignment" 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. LocationIds: An array of strings which are the IDs of locations.

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

  "vehicleLocationAssignments": [

    {

      VehicleId: "1",

      LocationIds: ["2", "3", "4"]

    },

    {

      VehicleId: "2",

      LocationIds: ["5", "6", "7"]

    }

  ]

}

 
 
 
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