API: searchLocation
Michael Fatica avatar
Written by Michael Fatica
Updated over a week ago

To retrieve the details of a set of locations matching a field=value condition use

MetaLocator.searchLocation

Use our API Test tool to obtain the latest documentation on this and other API methods.

Parameters:

Username (String) : Your MetaLocator Username
Password (String) : Your MetaLocator Password
Safe Field Name: Field safe name (see the template markup column under Fields, no curly braces)
Value: The value to search for

Returns:

An XMLRPC Struct array containing a list of complete location details for each location matching the condition provided.

This method can be used to return any records that have failed geocoding by providing "geocoded" for the safe field name and "2" for the value.

An example of a complete response follows:

<methodResponse>
<params>
<param>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>id</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>name</name>
<value>
<string>Test</string>
</value>
</member>
<member>
<name>type</name>
<value>
<string></string>
</value>
</member>
<member>
<name>description</name>
<value>
<string>This is a description.</string>
</value>
</member>
<member>
<name>published</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>user_id</name>
<value>
<string>0</string>
</value>
</member>
<member>
<name>isdirty</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>geofailed</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>address</name>
<value>
<string>zzz</string>
</value>
</member>
<member>
<name>address2</name>
<value>
<string>zz</string>
</value>
</member>
<member>
<name>city</name>
<value>
<string>zz</string>
</value>
</member>
<member>
<name>state</name>
<value>
<string>zz</string>
</value>
</member>
<member>
<name>county</name>
<value>
<string></string>
</value>
</member>
<member>
<name>postalcode</name>
<value>
<string>zzzz</string>
</value>
</member>
<member>
<name>country</name>
<value>
<string>United States</string>
</value>
</member>
<member>
<name>date</name>
<value>
<string></string>
</value>
</member>
<member>
<name>startdate</name>
<value>
<string></string>
</value>
</member>
<member>
<name>enddate</name>
<value>
<string></string>
</value>
</member>
<member>
<name>phone</name>
<value>
<string>123-123-1234</string>
</value>
</member>
<member>
<name>hours</name>
<value>
<string></string>
</value>
</member>
<member>
<name>fax</name>
<value>
<string></string>
</value>
</member>
<member>
<name>link</name>
<value>
<string>gerf</string>
</value>
</member>
<member>
<name>email</name>
<value>
<string>info@metalocator.com</string>
</value>
</member>
<member>
<name>icon</name>
<value>
<string></string>
</value>
</member>
<member>
<name>facebook</name>
<value>
<string></string>
</value>
</member>
<member>
<name>twitter</name>
<value>
<string></string>
</value>
</member>
<member>
<name>instagram</name>
<value>
<string></string>
</value>
</member>
<member>
<name>linkedin</name>
<value>
<string></string>
</value>
</member>
<member>
<name>sendtoemail</name>
<value>
<string></string>
</value>
</member>
<member>
<name>tld</name>
<value>
<string>US</string>
</value>
</member>
<member>
<name>image</name>
<value>
<string></string>
</value>
</member>
<member>
<name>gallery</name>
<value>
<string></string>
</value>
</member>
<member>
<name>metadescription</name>
<value>
<string></string>
</value>
</member>
<member>
<name>metakeywords</name>
<value>
<string></string>
</value>
</member>
<member>
<name>language</name>
<value>
<string></string>
</value>
</member>
<member>
<name>sourcefile</name>
<value>
<string>Back End</string>
</value>
</member>
<member>
<name>staticlink</name>
<value>
<string></string>
</value>
</member>
<member>
<name>lng</name>
<value>
<string>-99.41461918999994</string>
</value>
</member>
<member>
<name>lat</name>
<value>
<string>39.39870315600007</string>
</value>
</member>
<member>
<name>publishstart</name>
<value>
<string></string>
</value>
</member>
<member>
<name>publishend</name>
<value>
<string></string>
</value>
</member>
<member>
<name>mlwppostid</name>
<value>
<string></string>
</value>
</member>
<member>
<name>reviewmonitoringenabled</name>
<value>
<string>0</string>
</value>
</member>
<member>
<name>factualenabled</name>
<value>
<string>0</string>
</value>
</member>
<member>
<name>slug</name>
<value>
<string>sample-location-cambio</string>
</value>
</member>
<member>
<name>retailers_id</name>
<value>
<string></string>
</value>
</member>
<member>
<name>tagmasksum</name>
<value>
<string>0</string>
</value>
</member>
<member>
<name>locale</name>
<value>
<string></string>
</value>
</member>
<member>
<name>datecreated</name>
<value>
<string>2023-08-24 15:30:57</string>
</value>
</member>
<member>
<name>dateupdated</name>
<value>
<string>2023-09-18 15:12:35</string>
</value>
</member>
<member>
<name>storeno</name>
<value>
<string></string>
</value>
</member>
<member>
<name>uniqueid</name>
<value>
<string></string>
</value>
</member>
<member>
<name>servicetype</name>
<value>
<string></string>
</value>
</member>
<member>
<name>mondayhours</name>
<value>
<string></string>
</value>
</member>
<member>
<name>tuesdayhours</name>
<value>
<string></string>
</value>
</member>
<member>
<name>wednesdayhours</name>
<value>
<string></string>
</value>
</member>
<member>
<name>thursdayhours</name>
<value>
<string></string>
</value>
</member>
<member>
<name>fridayhours</name>
<value>
<string></string>
</value>
</member>
<member>
<name>saturdayhours</name>
<value>
<string></string>
</value>
</member>
<member>
<name>sundayhours</name>
<value>
<string></string>
</value>
</member>
<member>
<name>productsatthislocation</name>
<value>
<string></string>
</value>
</member>
<member>
<name>userid</name>
<value>
<string></string>
</value>
</member>
<member>
<name>timezone</name>
<value>
<string></string>
</value>
</member>
<member>
<name>ignore</name>
<value>
<string></string>
</value>
</member>
<member>
<name>newcolumnadded</name>
<value>
<string>Test</string>
</value>
</member>
<member>
<name>externalkey</name>
<value>
<string>11</string>
</value>
</member>
<member>
<name>territorycounty</name>
<value>
<string></string>
</value>
</member>
<member>
<name>ecommercelandingpage</name>
<value>
<string></string>
</value>
</member>
<member>
<name>hpservicecenterexcellenceaward</name>
<value>
<string>Y</string>
</value>
</member>
<member>
<name>title</name>
<value>
<string>Test from prodd</string>
</value>
</member>
<member>
<name>location_type</name>
<value>
<string>RANGE_INTERPOLATED</string>
</value>
</member>
<member>
<name>time_zone</name>
<value>
<string>America/Chicago</string>
</value>
</member>
<member>
<name>marker</name>
<value>
<string></string>
</value>
</member>
<member>
<name>marker_order</name>
<value>
<string>11</string>
</value>
</member>
<member>
<name>priority</name>
<value>
<string></string>
</value>
</member>
<member>
<name>priority_name</name>
<value>
<string>Distributors</string>
</value>
</member>
<member>
<name>has_offers</name>
<value>
<string>0</string>
</value>
</member>
<member>
<name>review_average</name>
<value>
<string>3.6666666666666665</string>
</value>
</member>
<member>
<name>review_count</name>
<value>
<string>3</string>
</value>
</member>
<member>
<name>claim_user_id</name>
<value>
<string></string>
</value>
</member>
<member>
<name>taglist</name>
<value>
<string>Retailers||, Distributors||, </string>
</value>
</member>
<member>
<name>tagidlist</name>
<value>
<string>253, 254, </string>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>id</name>
<value>
<string>2</string>
</value>
</member>
<member>
<name>name</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>type</name>
<value>
<string></string>
</value>
</member>
<member>
<name>description</name>
<value>
<string>&lt;p&gt;This is a sample description for location 1. Descriptions are HTML fields and allow you to add &lt;em&gt;&lt;strong&gt;formatting&lt;/strong&gt;&lt;/em&gt;, &lt;a href=&quot;http://www.google.com&quot; target=&quot;_blank&quot; rel=&quot;noopener noreferrer&quot;&gt;links&lt;/a&gt;, images or anything you see on a Web page.&lt;/p&gt;
&lt;p&gt;The description can be split into two parts, allowing the full text to be displayed only on the Detail page, and a short blurb displayed on the search results page.&lt;/p&gt;
&lt;p&gt;&lt;img src=&quot;http://demo.metalocator.com/images/user/photodune-4944725-commercial-offices-xs.jpg&quot; alt=&quot;Building&quot; width=&quot;547&quot; height=&quot;365&quot; /&gt;&lt;/p&gt;</string>
</value>
</member>
<member>
<name>published</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>user_id</name>
<value>
<string>0</string>
</value>
</member>
<member>
<name>isdirty</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>geofailed</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>address</name>
<value>
<string>f</string>
</value>
</member>
<member>
<name>address2</name>
<value>
<string></string>
</value>
</member>
<member>
<name>city</name>
<value>
<string>f</string>
</value>
</member>
<member>
<name>state</name>
<value>
<string>f</string>
</value>
</member>
<member>
<name>county</name>
<value>
<string>f</string>
</value>
</member>
<member>
<name>postalcode</name>
<value>
<string>zzzzzzzzzzzzzzz</string>
</value>
</member>
<member>
<name>country</name>
<value>
<string>United States</string>
</value>
</member>
<member>
<name>date</name>
<value>
<string></string>
</value>
</member>
<member>
<name>startdate</name>
<value>
<string></string>
</value>
</member>
<member>
<name>enddate</name>
<value>
<string></string>
</value>
</member>
<member>
<name>phone</name>
<value>
<string>123-123-1235</string>
</value>
</member>
<member>
<name>hours</name>
<value>
<string></string>
</value>
</member>
<member>
<name>fax</name>
<value>
<string></string>
</value>
</member>
<member>
<name>link</name>
<value>
<string>http://www.metalocator.com</string>
</value>
</member>
<member>
<name>email</name>
<value>
<string>info@metalocator.com</string>
</value>
</member>
<member>
<name>icon</name>
<value>
<string></string>
</value>
</member>
<member>
<name>facebook</name>
<value>
<string></string>
</value>
</member>
<member>
<name>twitter</name>
<value>
<string></string>
</value>
</member>
<member>
<name>instagram</name>
<value>
<string></string>
</value>
</member>
<member>
<name>linkedin</name>
<value>
<string></string>
</value>
</member>
<member>
<name>sendtoemail</name>
<value>
<string></string>
</value>
</member>
<member>
<name>tld</name>
<value>
<string>US</string>
</value>
</member>
<member>
<name>image</name>
<value>
<string></string>
</value>
</member>
<member>
<name>gallery</name>
<value>
<string></string>
</value>
</member>
<member>
<name>metadescription</name>
<value>
<string></string>
</value>
</member>
<member>
<name>metakeywords</name>
<value>
<string></string>
</value>
</member>
<member>
<name>language</name>
<value>
<string></string>
</value>
</member>
<member>
<name>sourcefile</name>
<value>
<string>Back End</string>
</value>
</member>
<member>
<name>staticlink</name>
<value>
<string></string>
</value>
</member>
<member>
<name>lng</name>
<value>
<string>-99.41461918999994</string>
</value>
</member>
<member>
<name>lat</name>
<value>
<string>39.39870315600007</string>
</value>
</member>
<member>
<name>publishstart</name>
<value>
<string></string>
</value>
</member>
<member>
<name>publishend</name>
<value>
<string></string>
</value>
</member>
<member>
<name>mlwppostid</name>
<value>
<string></string>
</value>
</member>
<member>
<name>reviewmonitoringenabled</name>
<value>
<string>0</string>
</value>
</member>
<member>
<name>factualenabled</name>
<value>
<string>0</string>
</value>
</member>
<member>
<name>slug</name>
<value>
<string>sample-location</string>
</value>
</member>
<member>
<name>retailers_id</name>
<value>
<string></string>
</value>
</member>
<member>
<name>tagmasksum</name>
<value>
<string>0</string>
</value>
</member>
<member>
<name>locale</name>
<value>
<string></string>
</value>
</member>
<member>
<name>datecreated</name>
<value>
<string>2023-08-24 15:30:57</string>
</value>
</member>
<member>
<name>dateupdated</name>
<value>
<string>2023-09-18 15:14:16</string>
</value>
</member>
<member>
<name>storeno</name>
<value>
<string></string>
</value>
</member>
<member>
<name>uniqueid</name>
<value>
<string></string>
</value>
</member>
<member>
<name>servicetype</name>
<value>
<string></string>
</value>
</member>
<member>
<name>mondayhours</name>
<value>
<string></string>
</value>
</member>
<member>
<name>tuesdayhours</name>
<value>
<string></string>
</value>
</member>
<member>
<name>wednesdayhours</name>
<value>
<string></string>
</value>
</member>
<member>
<name>thursdayhours</name>
<value>
<string></string>
</value>
</member>
<member>
<name>fridayhours</name>
<value>
<string></string>
</value>
</member>
<member>
<name>saturdayhours</name>
<value>
<string></string>
</value>
</member>
<member>
<name>sundayhours</name>
<value>
<string></string>
</value>
</member>
<member>
<name>productsatthislocation</name>
<value>
<string></string>
</value>
</member>
<member>
<name>userid</name>
<value>
<string></string>
</value>
</member>
<member>
<name>timezone</name>
<value>
<string></string>
</value>
</member>
<member>
<name>ignore</name>
<value>
<string></string>
</value>
</member>
<member>
<name>newcolumnadded</name>
<value>
<string>Test</string>
</value>
</member>
<member>
<name>externalkey</name>
<value>
<string>2</string>
</value>
</member>
<member>
<name>territorycounty</name>
<value>
<string></string>
</value>
</member>
<member>
<name>ecommercelandingpage</name>
<value>
<string></string>
</value>
</member>
<member>
<name>hpservicecenterexcellenceaward</name>
<value>
<string></string>
</value>
</member>
<member>
<name>title</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>location_type</name>
<value>
<string>RANGE_INTERPOLATED</string>
</value>
</member>
<member>
<name>time_zone</name>
<value>
<string>America/Chicago</string>
</value>
</member>
<member>
<name>marker</name>
<value>
<string></string>
</value>
</member>
<member>
<name>marker_order</name>
<value>
<string>11</string>
</value>
</member>
<member>
<name>priority</name>
<value>
<string></string>
</value>
</member>
<member>
<name>priority_name</name>
<value>
<string>Distributors</string>
</value>
</member>
<member>
<name>has_offers</name>
<value>
<string>0</string>
</value>
</member>
<member>
<name>review_average</name>
<value>
<string></string>
</value>
</member>
<member>
<name>review_count</name>
<value>
<string>0</string>
</value>
</member>
<member>
<name>claim_user_id</name>
<value>
<string></string>
</value>
</member>
<member>
<name>taglist</name>
<value>
<string>Retailers||, Distributors||, </string>
</value>
</member>
<member>
<name>tagidlist</name>
<value>
<string>253, 254, </string>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</param>
</params>
</methodResponse>
Did this answer your question?