<?xml version="1.0" encoding="UTF-8" ?>
<rss version="2.0" xmlns:dc="http://purl.org/dc/elements/1.1/"><channel><title>IGeocodeService Script API Type</title><link>https://community.telligent.com/community/13/w/api-documentation/73644/igeocodeservice-script-api-type</link><description>&lt;p&gt;&lt;span&gt;Developing on Verint Community? Use the API documentation as a reference for all supported interactions with Verint Community.&lt;/span&gt;&lt;/p&gt;</description><dc:language>en-US</dc:language><generator>14.0.0.586 14</generator><item><title>IGeocodeService Script API Type</title><link>https://community.telligent.com/community/13/w/api-documentation/73644/igeocodeservice-script-api-type</link><pubDate>Fri, 08 Mar 2024 17:27:29 GMT</pubDate><guid isPermaLink="false">a0cc6a72-eaea-48ff-bb94-e96e7f510192</guid><dc:creator>Ben Tiedt</dc:creator><comments>https://community.telligent.com/community/13/w/api-documentation/73644/igeocodeservice-script-api-type#comments</comments><description>Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:27:29&lt;br /&gt;
&lt;hr class="generated-documentation-start" style="border-width:0;" /&gt;&lt;div class="documentation"&gt;&lt;p&gt;Plugin that can have at most one enabled instance&lt;/p&gt;&lt;ul&gt;&lt;li&gt;&lt;a href="#Properties"&gt;Properties&lt;/a&gt;&lt;/li&gt;&lt;li&gt;&lt;a href="#GenerateServiceRedirectLink"&gt;GenerateServiceRedirectLink&lt;/a&gt;&lt;/li&gt;&lt;li&gt;&lt;a href="#Geocode"&gt;Geocode&lt;/a&gt;&lt;/li&gt;&lt;li&gt;&lt;a href="#GetMapUrl"&gt;GetMapUrl&lt;/a&gt;&lt;/li&gt;&lt;li&gt;&lt;a href="#InitializeService"&gt;InitializeService&lt;/a&gt;&lt;/li&gt;&lt;/ul&gt;&lt;a name="Properties"&gt;&lt;/a&gt;&lt;div class="documentation-members properties"&gt;&lt;h2&gt;Properties&lt;/h2&gt;&lt;table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"&gt;&lt;thead&gt;&lt;tr class="WikiTableBgBlue"&gt;&lt;th&gt;Name&lt;/th&gt;&lt;th&gt;Access&lt;/th&gt;&lt;th&gt;Type&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;/tr&gt;&lt;/thead&gt;&lt;tbody&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;IsEnabled&lt;/td&gt;&lt;td rowspan="1"&gt;Read&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;Boolean&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Is Enabled&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;MapContentType&lt;/td&gt;&lt;td rowspan="1"&gt;Read, Write&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;String&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Map Content Type&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;ServiceIdentifier&lt;/td&gt;&lt;td rowspan="1"&gt;Read&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;String&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Service Identifier&lt;/td&gt;&lt;/tr&gt;&lt;/tbody&gt;&lt;/table&gt;&lt;/div&gt;&lt;div class="documentation-members methods"&gt;&lt;h2&gt;Methods&lt;/h2&gt;&lt;a name="GenerateServiceRedirectLink"&gt;&lt;/a&gt;&lt;h3&gt;GenerateServiceRedirectLink&lt;/h3&gt;&lt;h4&gt;&lt;em&gt;Velocity&lt;/em&gt;&lt;/h4&gt;&lt;pre class="brush: velocity"&gt;#set($stringResponse = $iGeocodeService.GenerateServiceRedirectLink($query))&lt;/pre&gt;&lt;h4&gt;&lt;em&gt;JavaScript&lt;/em&gt;&lt;/h4&gt;&lt;pre class="brush: javascript"&gt;var stringResponse = iGeocodeService.GenerateServiceRedirectLink(query);&lt;/pre&gt;&lt;h4&gt;&lt;em&gt;Parameters&lt;/em&gt;&lt;/h4&gt;&lt;table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"&gt;&lt;thead&gt;&lt;tr class="WikiTableBgBlue"&gt;&lt;th&gt;Name&lt;/th&gt;&lt;th&gt;Type&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;th&gt;Required&lt;/th&gt;&lt;th&gt;Default&lt;/th&gt;&lt;th&gt;Options&lt;/th&gt;&lt;/tr&gt;&lt;/thead&gt;&lt;tbody&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;query&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;String&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Query&lt;/td&gt;&lt;td rowspan="1"&gt;Required&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;/tr&gt;&lt;/tbody&gt;&lt;/table&gt;&lt;h4&gt;&lt;em&gt;Returns&lt;/em&gt;&lt;/h4&gt;&lt;p&gt;&lt;div&gt;&lt;code&gt;String&lt;/code&gt;&lt;/div&gt;&lt;/p&gt;&lt;a name="Geocode"&gt;&lt;/a&gt;&lt;h3&gt;Geocode&lt;/h3&gt;&lt;h4&gt;&lt;em&gt;Velocity&lt;/em&gt;&lt;/h4&gt;&lt;pre class="brush: velocity"&gt;#set($geocodeResultResponse = $iGeocodeService.Geocode($query, $getMap))&lt;/pre&gt;&lt;h4&gt;&lt;em&gt;JavaScript&lt;/em&gt;&lt;/h4&gt;&lt;pre class="brush: javascript"&gt;var geocodeResultResponse = iGeocodeService.Geocode(query, getMap);&lt;/pre&gt;&lt;h4&gt;&lt;em&gt;Parameters&lt;/em&gt;&lt;/h4&gt;&lt;table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"&gt;&lt;thead&gt;&lt;tr class="WikiTableBgBlue"&gt;&lt;th&gt;Name&lt;/th&gt;&lt;th&gt;Type&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;th&gt;Required&lt;/th&gt;&lt;th&gt;Default&lt;/th&gt;&lt;th&gt;Options&lt;/th&gt;&lt;/tr&gt;&lt;/thead&gt;&lt;tbody&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;query&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;String&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Query&lt;/td&gt;&lt;td rowspan="1"&gt;Required&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;getMap&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;Boolean&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Get Map&lt;/td&gt;&lt;td rowspan="1"&gt;Required&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;/tr&gt;&lt;/tbody&gt;&lt;/table&gt;&lt;h4&gt;&lt;em&gt;Returns&lt;/em&gt;&lt;/h4&gt;&lt;p&gt;&lt;div&gt;&lt;code&gt;[[GeocodeResult Script API Type|GeocodeResult]]&lt;/code&gt;&lt;/div&gt;&lt;/p&gt;&lt;a name="GetMapUrl"&gt;&lt;/a&gt;&lt;h3&gt;GetMapUrl&lt;/h3&gt;&lt;h3&gt;GetMapUrl Overload 1&lt;/h3&gt;&lt;h4&gt;&lt;em&gt;Velocity&lt;/em&gt;&lt;/h4&gt;&lt;pre class="brush: velocity"&gt;#set($stringResponse = $iGeocodeService.GetMapUrl($lattitude, $longitude))&lt;/pre&gt;&lt;h4&gt;&lt;em&gt;JavaScript&lt;/em&gt;&lt;/h4&gt;&lt;pre class="brush: javascript"&gt;var stringResponse = iGeocodeService.GetMapUrl(lattitude, longitude);&lt;/pre&gt;&lt;h4&gt;&lt;em&gt;Parameters&lt;/em&gt;&lt;/h4&gt;&lt;table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"&gt;&lt;thead&gt;&lt;tr class="WikiTableBgBlue"&gt;&lt;th&gt;Name&lt;/th&gt;&lt;th&gt;Type&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;th&gt;Required&lt;/th&gt;&lt;th&gt;Default&lt;/th&gt;&lt;th&gt;Options&lt;/th&gt;&lt;/tr&gt;&lt;/thead&gt;&lt;tbody&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;lattitude&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;Double&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Lattitude&lt;/td&gt;&lt;td rowspan="1"&gt;Required&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;longitude&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;Double&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Longitude&lt;/td&gt;&lt;td rowspan="1"&gt;Required&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;/tr&gt;&lt;/tbody&gt;&lt;/table&gt;&lt;h3&gt;GetMapUrl Overload 2&lt;/h3&gt;&lt;h4&gt;&lt;em&gt;Velocity&lt;/em&gt;&lt;/h4&gt;&lt;pre class="brush: velocity"&gt;#set($stringResponse = $iGeocodeService.GetMapUrl($lattitude, $longitude, $mapWidth, $mapHeight, $zoom))&lt;/pre&gt;&lt;h4&gt;&lt;em&gt;JavaScript&lt;/em&gt;&lt;/h4&gt;&lt;pre class="brush: javascript"&gt;var stringResponse = iGeocodeService.GetMapUrl(lattitude, longitude, mapWidth, mapHeight, zoom);&lt;/pre&gt;&lt;h4&gt;&lt;em&gt;Parameters&lt;/em&gt;&lt;/h4&gt;&lt;table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"&gt;&lt;thead&gt;&lt;tr class="WikiTableBgBlue"&gt;&lt;th&gt;Name&lt;/th&gt;&lt;th&gt;Type&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;th&gt;Required&lt;/th&gt;&lt;th&gt;Default&lt;/th&gt;&lt;th&gt;Options&lt;/th&gt;&lt;/tr&gt;&lt;/thead&gt;&lt;tbody&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;lattitude&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;Double&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Lattitude&lt;/td&gt;&lt;td rowspan="1"&gt;Required&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;longitude&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;Double&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Longitude&lt;/td&gt;&lt;td rowspan="1"&gt;Required&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;mapWidth&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;Int32&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Map Width&lt;/td&gt;&lt;td rowspan="1"&gt;Required&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;mapHeight&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;Int32&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Map Height&lt;/td&gt;&lt;td rowspan="1"&gt;Required&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;zoom&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;Int32&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Zoom&lt;/td&gt;&lt;td rowspan="1"&gt;Required&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;/tr&gt;&lt;/tbody&gt;&lt;/table&gt;&lt;h4&gt;&lt;em&gt;Returns&lt;/em&gt;&lt;/h4&gt;&lt;p&gt;&lt;div&gt;&lt;code&gt;String&lt;/code&gt;&lt;/div&gt;&lt;/p&gt;&lt;a name="InitializeService"&gt;&lt;/a&gt;&lt;h3&gt;InitializeService&lt;/h3&gt;&lt;h4&gt;&lt;em&gt;Velocity&lt;/em&gt;&lt;/h4&gt;&lt;pre class="brush: velocity"&gt;#set($booleanResponse = $iGeocodeService.InitializeService())&lt;/pre&gt;&lt;h4&gt;&lt;em&gt;JavaScript&lt;/em&gt;&lt;/h4&gt;&lt;pre class="brush: javascript"&gt;var booleanResponse = iGeocodeService.InitializeService();&lt;/pre&gt;&lt;h4&gt;&lt;em&gt;Returns&lt;/em&gt;&lt;/h4&gt;&lt;p&gt;&lt;div&gt;&lt;code&gt;Boolean&lt;/code&gt;&lt;/div&gt;&lt;/p&gt;&lt;/div&gt;&lt;/div&gt;&lt;hr class="generated-documentation-end" style="border-width:0;" /&gt;&lt;div style="clear:both;"&gt;&lt;/div&gt;
</description></item></channel></rss>