https://docs.icepack.ai/nvd/ Recent content in Nominated Visit Day on API Documentation Hugo -- gohugo.io en Tue, 19 Dec 2023 00:00:00 +0000 https://docs.icepack.ai/nvd/configuration/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/nvd/configuration/ Overview The configuration for a Nominated Visit Day (NVD) model is designed to encapsulate the high-level features that are present in periodic NVD problems. Since NVDs are normally specified for sales-representatives (often simply called sales-reps) concepts such as vehicle capacities (like in the IVR model) aren’t typically used in this context. What is important is visit frequency and ensuring that repeated visits to certain customers keep to a certain visit profile. https://docs.icepack.ai/nvd/geocode/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/nvd/geocode/ Overview The term geocode is used to describe a pair of coordinates. In general, we mostly handle routing requests which are on the face of planet earth so we’ve biased the terminology used here in that direction. In the context of the NVD model, we only currently support road network queries which means that the geocode here must be a longitude/latitude pair on the face of planet earth. Applicable models NVD nvd-hap0j2y4zlm1 Geocode A longitude/latitude pair for routing on the face of planet earth which are used to determine entry and exit points on the road network. https://docs.icepack.ai/nvd/profile/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/nvd/profile/ Overview Profiles represent a set of constraints that are applied over a series of visits. A profile is linked to a visit object which defines the customer information (such as location). Applicable models NVD nvd-hap0j2y4zlm1 Profile The profile object contains the information regarding the number of visits in this profile and the frequency type. If a non-standard profile is required, a custom cycle can be specified. Schema definition message Profile { required eFrequency frequencyType = 1; repeated customCycle allowableCycles = 2; optional int32 numVisits = 3; } Fields frequencyType The type of frequency applicable in this profile. https://docs.icepack.ai/nvd/visit/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/nvd/visit/ Overview The visit defines the activity that needs to be performed through the period. The profile associated with the visit will govern how many times a visit is required to be performed in the period. One can consider a visit as analogous to a job in the IVR model, and each instance of a visit equivalent to a task. Applicable models NVD nvd-hap0j2y4zlm1 Visit Defines a set of work to be performed in the schedule over the period. https://docs.icepack.ai/nvd/territory/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/nvd/territory/ Overview A territory is analogous to a sales rep. It’s typical to have sales reps positioned at different locations and as such, each could be considered to me managing a territory. Applicable models NVD nvd-hap0j2y4zlm1 Territory A territory defines an available resource which may service visits. A territory could be considered a sales-rep in this context which requires daily working hours (corresponding to the period) as well as a home location which serves as the start and end of each day. https://docs.icepack.ai/nvd/visit-sequence/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/nvd/visit-sequence/ Overview Applicable models NVD nvd-hap0j2y4zlm1 Visit Sequence The task sequence provides an interface to describe the sequence in which visits should be performed per territory per day. Schema definition message VisitSequence { required string territoryId = 1; required int32 dayIndex = 2; // the day index (zero-based) repeated string visitId = 3; } Fields territoryId The territory to which the sequence of visits should be applied. dayIndex The day index for the visit sequence. https://docs.icepack.ai/nvd/model/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/nvd/model/ Overview The model is the object which contains all the defined input data for a solve. Applicable models NVD nvd-hap0j2y4zlm1 Model An NVD model is, at minimum, a collection of configuration, visits and territories (or sales-reps). An optional visit sequence can be provided should the user wish to evaluate a particular allocation of visits to a territory over a period. Schema definition message Model { required Configuration configuration = 1; repeated Visit visits = 2; repeated Territory territories = 3; repeated VisitSequence visitSequence = 4; } Fields configuration A configuration object defining the units and cost coefficients to be used in the optimisation process. https://docs.icepack.ai/nvd/solve-request/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/nvd/solve-request/ Overview Different actions can be performed against a model and the solve request object provides a mechanism to communicate the action to the solver. Applicable models NVD nvd-hap0j2y4zlm1 Endpoint POST: https://api.icepack.ai/vehicle-router/solve/ Solve Request The solve request indicates what type of solve should be performed against a specified model Schema definition message SolveRequest { optional Model model = 1; optional string modelID = 2; repeated VisitSequence routes = 3; optional SolveType solveType = 4 [default = Optimise]; } Fields model The target model which should be solved (commonly specified). https://docs.icepack.ai/nvd/objectives/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/nvd/objectives/ Overview This section provides a high-level description of the objectives used in the NVD model. Applicable models NVD nvd-hap0j2y4zlm1 Cost Objective The most common objective used in optimisation problems is one which attempts to minimise the cost of a particular solution. In the context of an NVD model, this would be to perform the visits specified (with their prescribed frequency) at a minimum cost meaning that routes should be efficiently sequenced and visits allocated to days which allow for other visits on the same day to be performed effectively. https://docs.icepack.ai/nvd/solution-response/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/nvd/solution-response/ Overview The NVD solution response has an additional tier of structure over the standard IVR solution response. This is due to the problem typically being multi-objective in nature and, as a result, the initial solution is in fact a Pareto frontier (see objectives) from which the user can then select a solution instance which then closely mimics the standard IVR response (with the addition of a day assignment). Applicable models NVD nvd-hap0j2y4zlm1 Endpoint GET: https://api.