Optimize Trip
| Request | |
|---|---|
| Description | Optimizes a trip, i.e. the sequence of stops are re-ordered to reduce overall costs. Note that the costs are determined by a cost function which takes several aspects such as travel time, travel duration, SLA, opening hours, working hours, overtime, idle time and others into account. In all cases, the trip is normalized, even if the sequence of stops has not changed. |
| Context | https://<instance>.optimizemyday.com/omdservices-basic/rest/v1/services/trip |
| URL | /optimize |
| Method | GET |
| Response Code | 200 when successful, another HTTP status code otherwise |
| Success Response | The optimized trip object, containing the optimized schedule. |
| Response Type | XML or JSON |
| Parameter | Datatype | Description |
|---|---|---|
| configId | Integer | The identifier of the configuration. |
| resourceId | String | The external identifier of the resource. |
| date | Date | The day for which the algorithm must be executed. |
| abort | Boolean | Perform the algorithm with the abort flag turned on. If omitted, this parameter defaults to true. The abort flag may cause the algorithm to throw an exception in case hard constraints are not matched. |
| oneOpt | Boolean | Avoid executing the the optimization with the OneOpt algorithm. If omitted, this parameter defaults to true. |
| reinsert | Boolean | Additionally perform the Optimize by Reinsert algorithm during the optimization. If omitted, this parameter defaults to false. |
| persist | String | Indicates if the changes must be persisted to the database. |
| _output | String | The requested output format being xml or json. If omitted, xml is assumed. |
Sample Call
Sample Result
<Result success="true">
<Trip resource="10000024" day="2017-09-20">
<Stop stopType="4" starttime="2017-09-20 08:00:00" duration="0.0" travelDistance="311883" travelTime="192.25" busyTime="192.25" pauseTimeTravel="0.0" pauseTimeOnSite="0.0" travelUnknown="false" overlap="0.0" clone="false">
<Address street="Grenzstr. 3" postalCode="08468" city="Reichenbach" country="DE" geocode="0_0_12292760_50614540 1"/>
</Stop>
<Stop task="0000106345-1-1-2017-05-11" stopType="2" starttime="2017-09-20 11:28:44" duration="90.0" travelDistance="4187" travelTime="8.4" busyTime="98.4" waitingTime="16.0" pauseTimeTravel="0.0" pauseTimeOnSite="0.0" travelUnknown="false" overlap="0.0" clone="false">
<Address street="Lötschbergstr. 40" postalCode="12683" city="Berlin" country="DE" geocode="0_0_13546650_52506000 1"/>
<Task id="30291352" lastUpdate="2017-09-17 02:10:07" configuration="16167225" contractLine="0000106345-1-1" account="0000106345" externalId="0000106345-1-1-2017-05-11" name="Dechdackar Aankeaf Barlan-Baasdarf" taskType="VISIT" territory="104" street="Lötschbergstr. 40" postalCode="12683" city="Berlin" country="DE" phone="+49305149090" geocode="0_0_13546650_52506000 1" earliest="2017-07-21 00:00:00" latest="2017-07-28 00:00:00" scheduledFor="10000024" scheduled="2017-09-20 11:28:44" status="IP" estimatedDuration="90.0" contractType="VISIT" taskGroupId="0000106345-1-2017-05-04-28" groupOffset="0" groupOffsetMargin="0" weight="0.0" volume="0.0" positionInTrip="1"/>
</Stop>
<Stop task="0000158538-1-1-2017-05-11" stopType="2" starttime="2017-09-20 13:07:08" duration="45.0" travelDistance="314123" travelTime="200.16667" busyTime="245.16667" waitingTime="0.0" pauseTimeTravel="0.0" pauseTimeOnSite="0.0" travelUnknown="false" overlap="0.0" clone="false">
<Address street="Coswiger Straße /Gebäude 9 8a" postalCode="12681" city="Berlin" country="DE" geocode="0_0_13530622_52528588 2"/>
<Task id="30291465" lastUpdate="2017-09-17 02:10:07" configuration="16167225" contractLine="0000158538-1-1" account="0000158538" externalId="0000158538-1-1-2017-05-11" name="Waga Systambeastaff GmbH" taskType="VISIT" territory="104" street="Coswiger Straße /Gebäude 9 8a" postalCode="12681" city="Berlin" country="DE" phone="+493054709370" geocode="0_0_13530622_52528588 2" earliest="2017-07-21 00:00:00" latest="2017-07-28 00:00:00" scheduledFor="10000024" scheduled="2017-09-20 13:07:08" status="IP" estimatedDuration="45.0" contractType="VISIT" taskGroupId="0000158538-1-2017-05-04-28" groupOffset="0" groupOffsetMargin="0" weight="0.0" volume="0.0" positionInTrip="2"/>
</Stop>
<Stop stopType="5" starttime="2017-09-20 17:00:00" duration="0.0" travelDistance="0" travelTime="0.0" busyTime="0.0" pauseTimeTravel="0.0" pauseTimeOnSite="0.0" travelUnknown="false" overlap="12.310833" clone="false">
<Address street="Grenzstr. 3" postalCode="08468" city="Reichenbach" country="DE" geocode="0_0_12292760_50614540 1"/>
</Stop>
<ResourceWorkPattern id="16176428" lastUpdate="2016-10-20 19:11:21" resource="10000024" workPattern="Standard" validFrom="2015-08-04 00:00:00" validTo="2040-08-04 00:00:00">
<WorkPattern id="16169128" lastUpdate="2015-12-07 11:42:23" configuration="16167225" externalId="Standard" standby="false" zeroDistanceForDeparture="false" zeroDistanceForArrival="false"/>
</ResourceWorkPattern>
<Cost costValue="158003041">
<CostComponent name="Waiting time" base="16.0" value="0"/>
<CostComponent name="Busy time" base="535.81665" value="0"/>
<CostComponent name="Idle time" base="4.1833496" value="0"/>
<CostComponent name="Travel time" base="400.81665" value="601224"/>
<CostComponent name="Travel distance" base="630193.0" value="0"/>
<CostComponent name="Duration" base="135.0" value="0"/>
<CostComponent name="Too late" base="1574.0" value="157400000"/>
<CostComponent name="Best age" base="0.0" value="1757"/>
<CostComponent name="Overlap" base="12.310833" value="0"/>
<CostComponent name="Overtime" base="12.310833" value="60"/>
</Cost>
</Trip>
</Result>