Skip to content

Commit

Permalink
landmarkreport
Browse files Browse the repository at this point in the history
Add examples for landmarkreport endpoint.
Minor corrections.
  • Loading branch information
pendenga committed May 13, 2024
1 parent c40f7a3 commit 896f0a3
Show file tree
Hide file tree
Showing 7 changed files with 264 additions and 10 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
<div class="jumbotron">
<h2>API Guide for Developers</h2>
<p class="lead">
<img src="https://www.gpsinsight.com/apidocs/images/gpsi_logo_flat.png" alt=""/><br>
<img src="https://apidocs.gpsinsight.com/images/gpsi_logo_flat.png" alt=""/><br>
Welcome to the GPS Insight API Guide for Developers! This documentation is designed for people familiar with object-oriented programming concepts. You should also be familiar with GPS Insight capabilities from a user's point of view.
</p>
</div>

<div class="Getting Started page-header">
<h2>Getting Started</h2>
<p>An application programming interface (API) specifies how some software components should interact with each other. GPS Insight's API provides a form of communication via XML or JSON coding language to push your fleet’s data from our system to your back-end systems (e.g., ERP, Dispatch, CRM). By using our API you can effortlessly integrate your fleet’s data into your back-end systems to provide transparency into payroll, fuel card transactions, additional documentation, asset management, and more.</p>
<img src="https://www.gpsinsight.com/apidocs/images/API_process.png">
<img src="https://apidocs.gpsinsight.com/images/API_process.png">
<p>The typical process for interacting with our API is broken into three high-level steps. You'll need to: <br>
<ul>
<li>
Expand Down Expand Up @@ -61,7 +61,7 @@
</p>
<p class="listcontinue" style="text-indent: 39px">The following response appears:</p>
<p class="listcontinue">
<img src="https://www.gpsinsight.com/apidocs/images/0000-00.png" class="MaxWidth100PercentNoThumbnail" />
<img src="https://apidocs.gpsinsight.com/images/0000-00.png" class="MaxWidth100PercentNoThumbnail" />
</p>
<ol data-mc-continue="true">
<li value="3">Copy the Session Token (shown above highlighted in yellow), and paste it into Notepad. You will use this token when you make a request. (See #2.&#160;Make a Request).</li>
Expand All @@ -88,18 +88,18 @@
<li value="3">In the API&#160;Apps List grid, click&#160;<b>API&#160;App</b> next to Create New.</li>
</ol>
<p class="listcontinue" style="text-indent: 39px">
<img src="https://www.gpsinsight.com/apidocs/images/0000-01.png" class="MaxWidth100PercentNoThumbnail" />
<img src="https://apidocs.gpsinsight.com/images/0000-01.png" class="MaxWidth100PercentNoThumbnail" />
</p>
<ol data-mc-continue="true">
<li value="4">In the New&#160;API&#160;App window, enter an&#160;App Name and Description, and click <b>Save API&#160;App</b>.</li>
</ol>
<p class="listcontinue" style="text-indent: 39px">
<img src="https://www.gpsinsight.com/apidocs/images/00-0001.png" class="MaxWidth100PercentNoThumbnail" />
<img src="https://apidocs.gpsinsight.com/images/00-0001.png" class="MaxWidth100PercentNoThumbnail" />
</p>
<br>
<p class="listcontinue" style="text-indent: 39px">A new App Token is generated:</p>
<p class="listcontinue" style="text-indent: 39px">
<img src="https://www.gpsinsight.com/apidocs/images/00-0002.png" class="MaxWidth100PercentNoThumbnail" />
<img src="https://apidocs.gpsinsight.com/images/00-0002.png" class="MaxWidth100PercentNoThumbnail" />
</p>
<ol data-mc-continue="true">
<li value="5">Copy the App Token (shown above highlighted in yellow), and past it into Notepad. You will use this token when you authenticate.</li>
Expand All @@ -110,7 +110,7 @@
</p>
<p class="listcontinue">The following response appears:</p>
<p class="listcontinue">
<img src="https://www.gpsinsight.com/apidocs/images/0000-00.png" class="MaxWidth100PercentNoThumbnail" />
<img src="https://apidocs.gpsinsight.com/images/0000-00.png" class="MaxWidth100PercentNoThumbnail" />
</p>
<ol data-mc-continue="true">
<li value="8">Copy the Session Token (shown above highlighted in yellow), and paste it into Notepad. You will use this token when you make a request. (See #2.&#160;Make a Request).</li>
Expand All @@ -125,7 +125,7 @@
<strong>Request Structure</strong><br>
Before you can make this request, you must understand the request structure.<br>
</p>
<img src="https://www.gpsinsight.com/apidocs/images/request_structure.png"/><br><br>
<img src="https://apidocs.gpsinsight.com/images/request_structure.png"/><br><br>
<p>Use the table below to understand the parts of the following request structure:</p>
<div class="well well-sm">
<p class="code">https://<span style="color: #ea6312; font-weight: bold;">api.gpsinsight.com/v2</span>/<span style="color: #e6b729; font-weight: bold;">vehicle</span>/<span style="color: #9e5e9b; font-weight: bold;">location</span>/<span style="color: #54849a; font-weight: bold;">xml</span>?<span style="color: #6aac90; font-weight: bold;">session_token=abcd1234</span>&amp;<span style="font-weight: bold; color: #808000;">vehicle=truck1</span> <!--[CDATA[ ]]--></p>
Expand Down Expand Up @@ -265,7 +265,7 @@
(e.g., your company's website).<br><br>
<a href="https://api.gpsinsight.com/v2/examples/javascript_example.html">https://api.gpsinsight.com/v2/examples/javascript_example.html<br><br>
</a>
<img src="https://www.gpsinsight.com/apidocs/images/real_example.png">
<img src="https://apidocs.gpsinsight.com/images/real_example.png">
</p>
</div>
<div><h2>IP Whitelist</h2></div>
Expand Down
18 changes: 18 additions & 0 deletions landmarkreport/clearCache.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Example Request:

https://api.gpsinsight.com/v2/landmarkreport/closesttolandmark?session_token=xxxx&landmark_group=21771&group=3838&radius=8800&rows=2

Example Response:

{
head: { .... },
data: [
{
landmark_id: 790948,
name: "Airport",
number: 3,
latitude: 33.4330887,
longitude: -112.0059585
}, { ... }
]
}
59 changes: 59 additions & 0 deletions landmarkreport/closestToAddress.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
Example Request:

https://api.gpsinsight.com/v2/landmarkreport/closesttoaddress?session_token=xxxx&address=7201%20E%20Henkel%20Way%20Scottsdale%20AZ&group=Landmarks%20by%20Adam&radius=10000

Example Response:

{
"head": { ... },
"data": [
{
"id": 1005032,
"label": "Whole Foods",
"latitude": 33.6540995,
"longitude": -111.9268682,
"radius": 387,
"polygon": "-111.9274557,33.6548226,0 -111.9259,33.654791,0 -111.9260824,33.6533828,0 -111.9264793,33.6533765,0 -111.9276863,33.6534523,0 -111.9278365,33.6540459,0 -111.9274288,33.6541974,0 -111.9274557,33.6548226,0",
"color": "0000ff",
"city": " ",
"state": " ",
"address": "7999 E. Whisper Rock Trail, Scottsdale, Arizona 85262",
"geoc_lat": 33.6540996,
"geoc_lng": -111.9268683,
"min_lng": -111.9278365,
"max_lng": -111.9259,
"min_lat": 33.6533765,
"max_lat": 33.6548226,
"numericDistance": 0.386,
"formattedDistance": "0.4 mi.",
"numericDriveDistance": 0.765,
"formattedDriveDistance": "0.8 mi.",
"numericDriveTime": 2,
"formattedDriveTime": "2 min"
},
{
"id": 1002381,
"label": "Verde Apartments",
"latitude": 33.6498106,
"longitude": -111.9352797,
"radius": 391,
"polygon": "-111.9342256,33.6488773,0 -111.9342577,33.6502884,0 -111.9358027,33.6502884,0 -111.9363016,33.6493328,0 -111.9342256,33.6488773,0",
"color": "0000ff",
"city": "Phoenix",
"state": "AZ",
"address": "17950 North 68th Street",
"geoc_lat": 33.6495828,
"geoc_lng": -111.9352636,
"min_lng": -111.9363016,
"max_lng": -111.9342256,
"min_lat": 33.6488773,
"max_lat": 33.6502884,
"numericDistance": 0.907,
"formattedDistance": "0.9 mi.",
"numericDriveDistance": 1.416,
"formattedDriveDistance": "1.4 mi.",
"numericDriveTime": 4,
"formattedDriveTime": "4 min"
}
]
}
59 changes: 59 additions & 0 deletions landmarkreport/closestToLandmark.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
Example Request:

https://api.gpsinsight.com/v2/landmarkreport/closesttoaddress?session_token=xxxx&landmark=Verde%20Apartments&group=Landmarks%20by%20Adam&radius=10000

Example Response:

{
"head": { ... },
"data": [
{
"id": 1002381,
"label": "Verde Apartments",
"latitude": 33.6498106,
"longitude": -111.9352797,
"radius": 391,
"polygon": "-111.9342256,33.6488773,0 -111.9342577,33.6502884,0 -111.9358027,33.6502884,0 -111.9363016,33.6493328,0 -111.9342256,33.6488773,0",
"color": "0000ff",
"city": "Phoenix",
"state": "AZ",
"address": "17950 North 68th Street",
"geoc_lat": 33.6495828,
"geoc_lng": -111.9352636,
"min_lng": -111.9363016,
"max_lng": -111.9342256,
"min_lat": 33.6488773,
"max_lat": 33.6502884,
"numericDistance": 0,
"formattedDistance": "0.0 mi.",
"numericDriveDistance": 0,
"formattedDriveDistance": "0.0 mi.",
"numericDriveTime": 0,
"formattedDriveTime": "0 min"
},
{
"id": 1005032,
"label": "Whole Foods",
"latitude": 33.6540995,
"longitude": -111.9268682,
"radius": 387,
"polygon": "-111.9274557,33.6548226,0 -111.9259,33.654791,0 -111.9260824,33.6533828,0 -111.9264793,33.6533765,0 -111.9276863,33.6534523,0 -111.9278365,33.6540459,0 -111.9274288,33.6541974,0 -111.9274557,33.6548226,0",
"color": "0000ff",
"city": " ",
"state": " ",
"address": "7999 E. Whisper Rock Trail, Scottsdale, Arizona 85262",
"geoc_lat": 33.6540996,
"geoc_lng": -111.9268683,
"min_lng": -111.9278365,
"max_lng": -111.9259,
"min_lat": 33.6533765,
"max_lat": 33.6548226,
"numericDistance": 0.568,
"formattedDistance": "0.6 mi.",
"numericDriveDistance": 0.902,
"formattedDriveDistance": "0.9 mi.",
"numericDriveTime": 3,
"formattedDriveTime": "3 min"
}
]
}
59 changes: 59 additions & 0 deletions landmarkreport/closestToLatLng.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
Example Request:

https://api.gpsinsight.com/v2/landmarkreport/closesttolatlng?session_token=xxxx&latitude=33.6590744&longitude=-111.9237522&group=3838&radius=800

Example Response:

{
"head": { ... },
"data": [
{
"id": 1005032,
"label": "Whole Foods",
"latitude": 33.6540995,
"longitude": -111.9268682,
"radius": 387,
"polygon": "-111.9274557,33.6548226,0 -111.9259,33.654791,0 -111.9260824,33.6533828,0 -111.9264793,33.6533765,0 -111.9276863,33.6534523,0 -111.9278365,33.6540459,0 -111.9274288,33.6541974,0 -111.9274557,33.6548226,0",
"color": "0000ff",
"city": " ",
"state": " ",
"address": "7999 E. Whisper Rock Trail, Scottsdale, Arizona 85262",
"geoc_lat": 33.6540996,
"geoc_lng": -111.9268683,
"min_lng": -111.9278365,
"max_lng": -111.9259,
"min_lat": 33.6533765,
"max_lat": 33.6548226,
"numericDistance": 0.388,
"formattedDistance": "0.4 mi.",
"numericDriveDistance": 0.802,
"formattedDriveDistance": "0.8 mi.",
"numericDriveTime": 2,
"formattedDriveTime": "2 min"
},
{
"id": 1002381,
"label": "Verde Apartments",
"latitude": 33.6498106,
"longitude": -111.9352797,
"radius": 391,
"polygon": "-111.9342256,33.6488773,0 -111.9342577,33.6502884,0 -111.9358027,33.6502884,0 -111.9363016,33.6493328,0 -111.9342256,33.6488773,0",
"color": "0000ff",
"city": "Phoenix",
"state": "AZ",
"address": "17950 North 68th Street",
"geoc_lat": 33.6495828,
"geoc_lng": -111.9352636,
"min_lng": -111.9363016,
"max_lng": -111.9342256,
"min_lat": 33.6488773,
"max_lat": 33.6502884,
"numericDistance": 0.923,
"formattedDistance": "0.9 mi.",
"numericDriveDistance": 1.454,
"formattedDriveDistance": "1.5 mi.",
"numericDriveTime": 4,
"formattedDriveTime": "4 min"
}
]
}
59 changes: 59 additions & 0 deletions landmarkreport/closestToVin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
Example Request:

https://api.gpsinsight.com/v2/landmarkreport/closesttovin?session_token=xxxx&vin=5TDXK3DC4DS35XXXX&group=3838&radius=800

Example Response:

{
"head": { ... },
"data": [
{
"id": 1005032,
"label": "Whole Foods",
"latitude": 33.6540995,
"longitude": -111.9268682,
"radius": 387,
"polygon": "-111.9274557,33.6548226,0 -111.9259,33.654791,0 -111.9260824,33.6533828,0 -111.9264793,33.6533765,0 -111.9276863,33.6534523,0 -111.9278365,33.6540459,0 -111.9274288,33.6541974,0 -111.9274557,33.6548226,0",
"color": "0000ff",
"city": " ",
"state": " ",
"address": "7999 E. Whisper Rock Trail, Scottsdale, Arizona 85262",
"geoc_lat": 33.6540996,
"geoc_lng": -111.9268683,
"min_lng": -111.9278365,
"max_lng": -111.9259,
"min_lat": 33.6533765,
"max_lat": 33.6548226,
"numericDistance": 0.393,
"formattedDistance": "0.4 mi.",
"numericDriveDistance": 0.785,
"formattedDriveDistance": "0.8 mi.",
"numericDriveTime": 2,
"formattedDriveTime": "2 min"
},
{
"id": 1002381,
"label": "Verde Apartments",
"latitude": 33.6498106,
"longitude": -111.9352797,
"radius": 391,
"polygon": "-111.9342256,33.6488773,0 -111.9342577,33.6502884,0 -111.9358027,33.6502884,0 -111.9363016,33.6493328,0 -111.9342256,33.6488773,0",
"color": "0000ff",
"city": "Phoenix",
"state": "AZ",
"address": "17950 North 68th Street",
"geoc_lat": 33.6495828,
"geoc_lng": -111.9352636,
"min_lng": -111.9363016,
"max_lng": -111.9342256,
"min_lat": 33.6488773,
"max_lat": 33.6502884,
"numericDistance": 0.906,
"formattedDistance": "0.9 mi.",
"numericDriveDistance": 1.437,
"formattedDriveDistance": "1.4 mi.",
"numericDriveTime": 4,
"formattedDriveTime": "4 min"
}
]
}
2 changes: 1 addition & 1 deletion vehiclereport/atLandmarkSummary.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Example Request:

https://api.gpsinsight.com/v2/vehiclereport/closesttolandmark?session_token=xxxx&landmark_group=21771&group=3838&radius=8800&rows=2
https://api.gpsinsight.com/v2/vehiclereport/atlandmarksummary?session_token=xxxx&landmark_group=21771&group=3838&radius=8800&rows=2

Example Response:

Expand Down

0 comments on commit 896f0a3

Please sign in to comment.