GPS SOAP Services

GPS Insight provides some services available in a standard SOAP format. Our SOAP server uses a standard WSDL connection. Create your SOAP client with the following WSDL URL:

• http://standard.gpsinsight.com/soap/services.php?wsdl

Visit the same URL as a web page to see the current list of available services:

• http://standard.gpsinsight.com/soap/services.php

This service provides a way for you to test that the server is running normally.

• Method Name: heartbeat
• Parameters:
  • name A test string to return from our SOAP server
• Example Response:

 <response type="heartbeat">
   <test>test</test>
   <errors count="0"/>
 </response>

This query returns a list of vehicles in a specified group, along with the last-reported (current) location and second-most-recently-reported (previous) location for that vehicle.

• Method Name: location
• Parameters:
  • username Your current GPS Insight username
  • password Your current GPS Insight password
  • group_id A valid vehicle group id
• Example Response:

  <response type="location">
    <vehicles>
      <vehicle>
        <vin>1GCGG25U241158437</vin>
        <vehicle>Painter Ready 2</vehicle>
        <current>
          <date>10/8/2008</date>
          <time>14:08:34</time>
          <ignition>off</ignition>
          <latitude>33.3454</latitude>
          <longitude>-111.34234</longitude>
          <age_minutes>40</age_minutes>
        </current>
        <previous>
          <date>10/8/2008</date>
          <time>14:06:33</time>
          <ignition>on</ignition>
          <latitude>33.3464</latitude>
          <longitude>-111.3412</longitude>
          <age_minutes>42</age_minutes>
        </previous>
      </vehicle>
    </vehicles>
    <errors count="0"/>
  </response>

• Example Failure Response:

 <response type="odometer">
   <errors count="1">
     <error code="100">Invalid username or password</error>
   </errors>
 </response>

This query returns a list of vehicles in a specified group, along with the last known odometer reading for that vehicle. Odometer readings are only transmitted from the vehicle at 50 minute intervals.

• Method Name: odometer
• Parameters:
  • username Your current GPS Insight username
  • password Your current GPS Insight password
  • group_id A valid vehicle group id
• Example Response:

  <response type="odometer">
    <vehicles>
      <vehicle>
        <vin>1GCGG25U241158437</vin>
        <vehicle>Painter Ready 2</vehicle>
        <odometer>71362</odometer>
        <date>Jul 11, 2007</date>
        <time>21:31</time>
        <age_minutes>26540</age_minutes>
      </vehicle>
    </vehicles>
    <errors count="0"/>
  </response>

• Example Failure Response:

 <response type="odometer">
   <errors count="1">
     <error code="100">Invalid username or password</error>
   </errors>
 </response>

This service updates the total odometer reading in miles for a single vehicle. Note: Odometer readings are only transmitted from the vehicle at 50 minute intervals so the updated odometer reading may not be reflected in reports for up to 50 minutes after a vehicle starts moving.

NOTE: You will get an error (210) if you invoke this method for a vehicle that is moving. The vehicle must be stopped to update the odometer.

• Method Name: odometerUpdate
• Parameters:
  • username Your current GPS Insight username
  • password Your current GPS Insight password
  • vin A valid vin for any vehicle on your account
  • odometer A whole number representing the current odometer reading

• Example Response:

  <response type="odometerUpdate">
    <message>Odometer for '1GCGG25U241158437' was updated to 8687</message>
    <errors count="0"/>
  </response>

• Example Failure Response:

 <response type="odometerUpdate">
   <errors count="1">
     <error code="100">Invalid username or password</error>
   </errors>
 </response>

This query returns vehicles with a current position close to a specified point. The response will consist of a set of moving vehicles and a set of stopped vehicles. The size of each set is limited to the number of results you request. There is an upper limit of 10 vehicles for each set.

• Method Name: proximity
• Parameters:
  • username Your current GPS Insight username
  • password Your current GPS Insight password
  • group_id A valid vehicle group id
  • latitude The latitude of the point you want to query
  • longitude The longitude of the point you want to query
  • count The number of vehicles you want of each status (moving or stopped)
• Example Response:

  <response type="proximity">
  <vehicles>
      <moving>
        <vehicle>
          <vin>3GNEK18R0VG118391</vin>
          <vehicle>TRAVIS</vehicle>    
          <date>Jun 17, 2007</date>
          <time>11:43</time>
          <latitude>33.60889</latitude>
          <longitude>-111.88864</longitude>
          <ignition>on</ignition>
          <speed units="MPH">43</speed>    
          <distance units="feet">3984</distance>
          <heading units="degrees">-63</heading>
          <moving>toward</moving>
        </vehicle>   
        <vehicle>
          <vin>1N4DL01D5YC214444</vin>
          <vehicle>PERRY</vehicle>
          <date>Jun 17, 2007</date>
          <time>22:52</time>
          <latitude>33.62802</latitude>
          <longitude>-111.878827</longitude>
          <ignition>on</ignition>
          <speed units="MPH">10</speed>
          <distance units="feet">4737</distance>
          <heading units="degrees">-111</heading>
          <moving>away</moving>
        </vehicle>
      </moving>
      <stopped>   
        <vehicle>
          <vin>1J4FJ68S8WL170897</vin>
          <vehicle>ELLIOT</vehicle>
          <date>Jun 16, 2007</date>
          <time>20:21</time>
          <latitude>33.6394</latitude>
          <longitude>-111.901227</longitude>
          <ignition>off</ignition>
          <speed units="MPH">37</speed>
          <distance units="feet">5001</distance>
          <heading units="degrees">-90</heading>
          <moving>stopped</moving>
        </vehicle>
        <vehicle>
          <vin>1B4HS28Z8YF151931</vin>
          <vehicle>SHAWN</vehicle>
          <date>Jun 17, 2007</date>
          <time>19:30</time>
          <latitude>33.64203</latitude>
          <longitude>-111.926827</longitude>
          <ignition>off</ignition>
          <speed units="MPH">35</speed>
          <distance units="feet">50536</distance>
          <heading units="degrees">166</heading>
          <moving>stopped</moving>
        </vehicle>
        <vehicle>
          <vin>1GCCS139278128839</vin>
          <vehicle>JONATHAN</vehicle>
          <date>Jun 17, 2007</date>
          <time>23:03</time>
          <latitude>33.61422</latitude>
          <longitude>-112.0384</longitude>
          <ignition>off</ignition>
          <speed units="MPH">12</speed>
          <distance units="feet">53426</distance>
          <heading units="degrees">40</heading>
          <moving>stopped</moving>
        </vehicle>
    </stopped>
    </vehicles>
    <sourcePoint>
      <latitude>33.503549</latitude>
      <longitude>-111.923258</longitude>
    </sourcePoint>
    <errors count="0"/>
  </response>

• Example Failure Response:

 <response type="proximity">
   <errors count="1">
     <error code="201">Requested vehicle count is too high</error>
   </errors>
 </response>

This service lets you test your username and password for authentication validity.

• Method Name: testLogin
• Parameters:
  • username Your current GPS Insight username
  • password Your current GPS Insight password
• Example Response:

 <response type="testLogin">
   <test>Login Success</test>
   <errors count="0"/>
 </response>

• Example Failure Response:

 <response type="testLogin">
   <errors count="1">
     <error code="100">Invalid username or password</error>
   </errors>
 </response>

This service updates various attribues of a single vehicle. Only the vin number and label are required but the others must be added in order if they are to be updated. NOTE: This service will update the vehicle name if it is different than the existing name but the VIN must match with an existing vehicle.

This service does not update our records immediately, rather it is scheduled for update in the near future. Therefore, a successful response means the record has been successfully scheduled for update within a few minutes.

• Method Name: vehicleUpdate
• Parameters:
  • username Your current GPS Insight username
  • password Your current GPS Insight password
  • vin A valid vin for any vehicle on your account
  • label A new or existing label for a vehicle
  • color (optional)
  • license (optional)
  • license country (2-digit, optional)
  • license state (2-digit, optional)

• Example Response:

  <response type="vehicleUpdate">
    <message>Vehicle '1GCGG25U241158437' was updated</message>
    <errors count="0"/>
  </response>

• Example Failure Response:

 <response type="vehicleUpdate">
   <errors count="1">
     <error code="100">Invalid username or password</error>
   </errors>
 </response>

• 100 - Invalid username or Password
• 105 - Service currently unavailable
• 201 - Requested vehicle count is too high
• 202 - Requested vehicle group is invalid
• 210 - Requested vehicle is running and the ignition should be off

>>See also: Map Book Web Services

>>See also: REST Web Services