Get Trips

Request
Description Retrieves the trips of resources in territories the connected user has access to.
Context https://<instance>.optimizemyday.com/omdservices-basic/rest/v1/services/data
URL /getTrips
Method GET
Response Code 200 when successful, another HTTP status code otherwise
Success Response A document containing a hierarchical representation of a trip, including stops, work patterns and cost information.
Response Type XML or JSON
Parameter Datatype Description
configId Integer The identifier of the configuration.
dateFrom Date The first day to retrieve.
dateTo Date The last day to retrieve.
resourceId String A list of resource external identifiers for which trips are requested. If this parameter is not specified, all resources of the territories the user has access to are retrieved.
_output String The requested output format being xml or json. If omitted, xml is assumed.

Sample Call

https://sandbox.optimizemyday.com/omdservices-basic/rest/v1/services/data/getTrips?configId=16167225&dateFrom=2017-09-18&dateTo=2017-09-20&resourceId=10000021&resourceId=10000024

Sample Result

<Result success="true">
  <Trip resource="10000021" day="2017-09-18">
    <Stop stopType="4" starttime="2017-09-18 08:00:00" duration="0.0" travelDistance="0" travelTime="0.0" busyTime="0.0" pauseTimeTravel="0.0" pauseTimeOnSite="0.0" travelUnknown="false" overlap="0.0" clone="false">
      <Address street="Hagenhoopt 26" postalCode="21435" city="Stelle" country="DE" geocode="0_0_10144400_53367500 1"/>
    </Stop>
    <Stop stopType="5" starttime="2017-09-18 17:00:00" duration="0.0" travelDistance="0" travelTime="0.0" busyTime="0.0" pauseTimeTravel="0.0" pauseTimeOnSite="0.0" travelUnknown="false" overlap="0.0" clone="false">
      <Address street="Hagenhoopt 26" postalCode="21435" city="Stelle" country="DE" geocode="0_0_10144400_53367500 1"/>
    </Stop>
    <ResourceWorkPattern id="16176434" lastUpdate="2016-10-20 19:12:55" resource="10000021" 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="0">
      <CostComponent name="Waiting time" base="0.0" value="0"/>
      <CostComponent name="Busy time" base="0.0" value="0"/>
      <CostComponent name="Idle time" base="540.0" value="0"/>
    </Cost>
  </Trip>
  <Trip resource="10000021" day="2017-09-19">
    <Stop stopType="4" starttime="2017-09-19 08:00:00" duration="0.0" travelDistance="0" travelTime="0.0" busyTime="0.0" pauseTimeTravel="0.0" pauseTimeOnSite="0.0" travelUnknown="false" overlap="0.0" clone="false">
      <Address street="Hagenhoopt 26" postalCode="21435" city="Stelle" country="DE" geocode="0_0_10144400_53367500 1"/>
    </Stop>
    <Stop task="85d8a703-a-1-1-2017-05-11" stopType="2" starttime="2017-09-19 08:00:00" duration="90.0" travelDistance="0" travelTime="0.0" busyTime="90.0" waitingTime="0.0" pauseTimeTravel="0.0" pauseTimeOnSite="0.0" travelUnknown="false" overlap="0.0" clone="false">
      <Address street="Hagenhoopt 26" postalCode="21435" city="Stelle" country="DE" geocode="0_0_10144400_53367500 1"/>
      <Task id="30291548" lastUpdate="2017-09-16 02:10:10" configuration="16167225" contractLine="85d8a703-a-1-1" account="85d8a703-a" externalId="85d8a703-a-1-1-2017-05-11" name="Allgemein" taskType="VISIT" territory="104" street="Hagenhoopt 26" postalCode="21435" city="Stelle" country="DE" geocode="0_0_10144400_53367500 1" earliest="2017-05-04 00:00:00" latest="2017-05-18 00:00:00" scheduledFor="10000021" scheduled="2017-09-19 08:00:00" status="IP" estimatedDuration="90.0" contractType="VISIT" taskGroupId="85d8a703-a-1-2017-05-04-28" groupOffset="0" groupOffsetMargin="0" weight="0.0" volume="0.0" positionInTrip="1"/>
    </Stop>
    <Stop task="710c0465-c-1-1-2017-05-11" stopType="2" starttime="2017-09-19 09:30:00" duration="75.0" travelDistance="0" travelTime="0.0" busyTime="75.0" waitingTime="0.0" pauseTimeTravel="0.0" pauseTimeOnSite="0.0" travelUnknown="false" overlap="0.0" clone="false">
      <Address street="Hagenhoopt 26" postalCode="21435" city="Stelle" country="DE" geocode="0_0_10144400_53367500 1"/>
      <Task id="30291541" lastUpdate="2017-09-16 02:10:10" configuration="16167225" contractLine="710c0465-c-1-1" account="710c0465-c" externalId="710c0465-c-1-1-2017-05-11" name="Allgemein" taskType="VISIT" territory="104" street="Hagenhoopt 26" postalCode="21435" city="Stelle" country="DE" geocode="0_0_10144400_53367500 1" earliest="2017-05-04 00:00:00" latest="2017-05-18 00:00:00" scheduledFor="10000021" scheduled="2017-09-19 09:30:00" status="IP" estimatedDuration="75.0" contractType="VISIT" taskGroupId="710c0465-c-1-2017-05-04-28" groupOffset="0" groupOffsetMargin="0" weight="0.0" volume="0.0" positionInTrip="2"/>
    </Stop>
    <Stop task="552b9a21-f-1-1-2017-05-11" stopType="2" starttime="2017-09-19 10:45:00" duration="105.0" travelDistance="0" travelTime="0.0" busyTime="105.0" waitingTime="0.0" pauseTimeTravel="0.0" pauseTimeOnSite="0.0" travelUnknown="false" overlap="0.0" clone="false">
      <Address street="Hagenhoopt 26" postalCode="21435" city="Stelle" country="DE" geocode="0_0_10144400_53367500 1"/>
      <Task id="30291531" lastUpdate="2017-09-16 02:10:10" configuration="16167225" contractLine="552b9a21-f-1-1" account="552b9a21-f" externalId="552b9a21-f-1-1-2017-05-11" name="Allgemein" taskType="VISIT" territory="104" street="Hagenhoopt 26" postalCode="21435" city="Stelle" country="DE" geocode="0_0_10144400_53367500 1" earliest="2017-05-04 00:00:00" latest="2017-05-18 00:00:00" scheduledFor="10000021" scheduled="2017-09-19 10:45:00" status="IP" estimatedDuration="105.0" contractType="VISIT" taskGroupId="552b9a21-f-1-2017-05-04-28" groupOffset="0" groupOffsetMargin="0" weight="0.0" volume="0.0" positionInTrip="3"/>
    </Stop>
    <Stop task="0e36d1dd-3-1-1-2017-05-11" stopType="2" starttime="2017-09-19 12:30:00" duration="75.0" travelDistance="0" travelTime="0.0" busyTime="75.0" waitingTime="0.0" pauseTimeTravel="0.0" pauseTimeOnSite="0.0" travelUnknown="false" overlap="0.0" clone="false">
      <Address street="Hagenhoopt 26" postalCode="21435" city="Stelle" country="DE" geocode="0_0_10144400_53367500 1"/>
      <Task id="30291511" lastUpdate="2017-09-16 02:10:10" configuration="16167225" contractLine="0e36d1dd-3-1-1" account="0e36d1dd-3" externalId="0e36d1dd-3-1-1-2017-05-11" name="Allgemein" taskType="VISIT" territory="104" street="Hagenhoopt 26" postalCode="21435" city="Stelle" country="DE" geocode="0_0_10144400_53367500 1" earliest="2017-05-04 00:00:00" latest="2017-05-18 00:00:00" scheduledFor="10000021" scheduled="2017-09-19 12:30:00" status="IP" estimatedDuration="75.0" contractType="VISIT" taskGroupId="0e36d1dd-3-1-2017-05-04-28" groupOffset="0" groupOffsetMargin="0" weight="0.0" volume="0.0" positionInTrip="4"/>
    </Stop>
    <Stop task="61b756c7-5-1-1-2017-05-11" stopType="2" starttime="2017-09-19 13:45:00" duration="120.0" travelDistance="0" travelTime="0.0" busyTime="120.0" waitingTime="0.0" pauseTimeTravel="0.0" pauseTimeOnSite="0.0" travelUnknown="false" overlap="0.0" clone="false">
      <Address street="Hagenhoopt 26" postalCode="21435" city="Stelle" country="DE" geocode="0_0_10144400_53367500 1"/>
      <Task id="30291538" lastUpdate="2017-09-16 02:10:10" configuration="16167225" contractLine="61b756c7-5-1-1" account="61b756c7-5" externalId="61b756c7-5-1-1-2017-05-11" name="Allgemein" taskType="VISIT" territory="104" street="Hagenhoopt 26" postalCode="21435" city="Stelle" country="DE" geocode="0_0_10144400_53367500 1" earliest="2017-05-04 00:00:00" latest="2017-05-18 00:00:00" scheduledFor="10000021" scheduled="2017-09-19 13:45:00" status="IP" estimatedDuration="120.0" contractType="VISIT" taskGroupId="61b756c7-5-1-2017-05-04-28" groupOffset="0" groupOffsetMargin="0" weight="0.0" volume="0.0" positionInTrip="5"/>
    </Stop>
    <Stop task="2f6eed52-e-1-1-2017-05-11" stopType="2" starttime="2017-09-19 15:45:00" duration="120.0" travelDistance="0" travelTime="0.0" busyTime="120.0" waitingTime="0.0" pauseTimeTravel="0.0" pauseTimeOnSite="0.0" travelUnknown="false" overlap="0.0" clone="false">
      <Address street="Hagenhoopt 26" postalCode="21435" city="Stelle" country="DE" geocode="0_0_10144400_53367500 1"/>
      <Task id="30291520" lastUpdate="2017-09-16 02:10:10" configuration="16167225" contractLine="2f6eed52-e-1-1" account="2f6eed52-e" externalId="2f6eed52-e-1-1-2017-05-11" name="Allgemein" taskType="VISIT" territory="104" street="Hagenhoopt 26" postalCode="21435" city="Stelle" country="DE" geocode="0_0_10144400_53367500 1" earliest="2017-05-04 00:00:00" latest="2017-05-18 00:00:00" scheduledFor="10000021" scheduled="2017-09-19 15:45:00" status="IP" estimatedDuration="120.0" contractType="VISIT" taskGroupId="2f6eed52-e-1-2017-05-04-28" groupOffset="0" groupOffsetMargin="0" weight="0.0" volume="0.0" positionInTrip="6"/>
    </Stop>
    <Stop stopType="5" starttime="2017-09-19 17:00:00" duration="0.0" travelDistance="0" travelTime="0.0" busyTime="0.0" pauseTimeTravel="0.0" pauseTimeOnSite="0.0" travelUnknown="false" overlap="0.0" clone="false">
      <Address street="Hagenhoopt 26" postalCode="21435" city="Stelle" country="DE" geocode="0_0_10144400_53367500 1"/>
    </Stop>
    <ResourceWorkPattern id="16176434" lastUpdate="2016-10-20 19:12:55" resource="10000021" 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="535410932">
      <CostComponent name="Waiting time" base="0.0" value="0"/>
      <CostComponent name="Busy time" base="585.0" value="0"/>
      <CostComponent name="Idle time" base="0.0" value="0"/>
      <CostComponent name="Used trip" base="1.0" value="5000"/>
      <CostComponent name="Duration" base="585.0" value="0"/>
      <CostComponent name="Too late" base="5354.0" value="535400000"/>
      <CostComponent name="Best age" base="0.0" value="5932"/>
    </Cost>
  </Trip>
 </Result>

results matching ""

    No results matching ""