Manage Nearest Store List using SOAP API

Common Parameters:

All SOAP API functions have the following common parameters:

For Trail use set to 0. ListID=1 and 2 which are List 1 and 2 on the spreadsheet. When calling these lists the DataKey, LicenseID and Password are ignored. You will NOT be able to update the data in these lists.

API Functions

List Management functions:

• RemoveAllFromList
  
• RemoveEntryFromList
  
• GetListCount
  
• AddOrUpdateEntry
  
• GetAllInList
  
• GetEntryFromList
  

Template Management functions:

• SetTempate
  
• SetTempateWithGoogleDetails
  

RemoveAllFromList

RemoveAllFromList(LicenseID as long,
       ListID as long,
       Password as string,
       ByRef ErrorDesc as string) as Boolean

Returns TRUE if removed, else error in ErrorDesc 

if ListID =-1 then delete all lists

RemoveEntryFromList

RemoveEntryFromList(LicenseID as long,
       ListID as long,
       Password as string,
       ByRef ErrorDesc as string,
       YourID as Long) as Boolean

Returns TRUE if removed, else error in ErrorDesc

GetListCount

GetListCount(LicenseID as long, ListID as long, Password as string,
       ByRef ErrorDesc as string,
       YourCurrentLimit as long) as long

Returns count, else –1 and error in ErrorDesc

YourCurrentLimit is the list limit you currently have.  if ListID =-1 then get count for all lists

AddOrUpdateEntry

AddOrUpdateEntry(LicenseID as long,
       Datakey as string,
       ListID as long,_
       Password as string,_
       ByRef ErrorDesc as string,_
       MachineID as string,_
       Postcode as string,_
       YourID as long, _
       YourData1 as string,_
       YourData2 as string,_
       YourData3 as string,_
       YourData4 as string,_
       YourData5 as string,_
       YourData6 as string,_
       YourData7 as string,_
       YourData8 as string,_
       Type as string,_
       Area as string) as Boolean

Returns TRUE if added/updated, else error in ErrorDesc

MachineID must be the Computer name of the machine calling the function

Datakey is you datakey given to you when you opened the account

GetAllInList

GetAllInList(LicenseID as long,_
       ListID as long,_
       Password as string,_
       ByRef ErrorDesc as string,_
       ExtraParameters as string) as String

Returns XML List if set, else error in ErrorDesc

ExtraParameters may be used to filter the results in future versions

Returns

<list> <errordesc></errordesc> <recordcount>2</recordcount> <record>   <yourid>531252</yourid>   <yourdata1>My store at Wisbech</yourdata1>   <yourdata2>Turn left at the polices station. <b>Phone 08512 251258</b></yourdata2>   <yourdata3>ShowDetails.aspx?=829835</yourdata3>   <yourdata4></yourdata4>   <yourdata5></yourdata5>   <yourdata6></yourdata6>   <yourdata7></yourdata7>   <yourdata8></yourdata8>   <type></type>   <area></area>   <postcode>PE132XQ</Postcode>   <longitude>2.3512126</longitude>   <latitude>1.2162363</latitude>   <dateadded>20070304</dateadded> </record> <record>   <yourid>531253</yourid>   <yourdata1>My store at Kings Lynn</yourdata1>   <yourdata2>Turn right at the polices station. <b>Phone 08512 253522</b></yourdata2>   <yourdata3>ShowDetails.aspx?=829833</yourdata3>   <yourdata4></yourdata4>   <yourdata5></yourdata5>   <yourdata6></yourdata6>   <yourdata7></yourdata7>   <yourdata8></yourdata8>   <type></type>   <area></area>   <postcode>PE132XQ</postcode>   <longitude>2.3542126</longitude>   <latitude>1.2122233</latitude>   <dateadded>20070304</dateadded> </record> </list>

GetEntryFromList

GetEntryFromList(LicenseID as long,_
       ListID as long,_
       Password as string,_
       ByRef ErrorDesc as string,_
       YourID as long) as String

Returns XML List if set, else error in ErrorDesc

SetTempate

SetTempate(LicenseID as long,_
       TemplateID as long,_
       Password as string,_
       ByRef ErrorDesc as string,_
       HeaderTemplate as string,_
       NextPageURL as string) as Boolean

This updates the basic template stored on our server. See Step5, in previous sections and Up loader Spreadsheet for more details.

Returns TRUE if set template for List, else error in ErrorDesc

SetTempateWithGoogleDetails

SetTempateWithGoogleDetails(LicenseID as long,_
       TemplateID as long,_
       Password as string,_
       ByRef ErrorDesc as string,_
       HeaderTemplate as string,_
       DetailsTemplate as string,_
       FooterTemplate as string,_
       NextPageURL as string,_
       MapIconsLocation as string,_
       ShowTargetPin as boolean,_
       ShowShadowOnPins as boolean,_
       UseNumberedPins as boolean,_
       UseTypeFilterPins as boolean,_
       MapTargetPin_Details as string,_
       Target_PinIcon_Details as string,_
       Included_PinIcon_Details as string,_
       FilteredOut_PinIcon_Details as string,_
       MapTabTemplate1 as string,_
       MapTabTemplate2 as string,_
       MapTabTemplate3 as string,_
       MapTabTemplate4 as string,_
       ExtraFlags as string) as Boolean

Returns TRUE if set template for List, else error in ErrorDesc

This updates the basic template stored on our server. See Step5, in previous sections and Up loader Spreadsheet for more details.