If you are using our route optimisation module, you will see some extra optional fields on your users. These include a start location, end location and a capacity.
These locations are used by our route optimisation module to try and start and end routes at pre-determined locations, usually a worker's home or an office location. To set these for a user that does not have a location set already, you can include the following XML in a PUT or a POST to a User.
<start_location>
<formatted_address>18 Railway Street, Newmarket, Auckland, New Zealand</formatted_address>
<lat>-36.865387</lat>
<lng>174.780437</lng>
</start_location>
<end_location>
<formatted_address>18 Railway Street, Newmarket, Auckland, New Zealand</formatted_address>
<lat>-36.865387</lat>
<lng>174.780437</lng>
<end_location>However, if you are replacing an existing location in a PUT, you will need to include the current location ID as per this example:
<user>
<start_location>
<id>27570362</id>
<formatted_address>18 Railway Street, Newmarket, Auckland, New Zealand</formatted_address>
<lat>-36.865387</lat>
<lng>174.780437</lng>
</start_location>
</user>Capacity settings are also turned on when route optimisation is enabled. This feature allows you to set a capacity allowed for a user and a capacity required on a job. The vWork optimisation module will then prevent overloading a vehicle.
Capacity can be measured however you like: meals, boxes, pallets, tonnes, cubic metres, etc. But you need to use the same metric on both users and jobs. You cannot use capacity to solve complex load planning problems.
For example, a user with a small van could carry 100 meals, and a customer may order 12 meals in a job. You would then need to add a capacity of "100" for the user, and a capacity of "12" on the job.
To set capacity for a user simply include the value in a PUT or POST to the user, like so:
<capacity>100</capacity>