API

LocationBox API

Near Campaigns

Near Campaigns Service gives campaign list where campaings are near to your location by distance based on criterias which you can find below.

A Near Campaign request must look like this:

http://www.locationbox.com.tr/locationbox/services?Key=key&Cmd=CampNearCampaigns&Typ=output_format
&Latitude=latitude&Longitude=longitude&Radius=radius&Category=category



Request Parameters


Key: LocationBox user key. (Register for user key)
Cmd: LocationBox service name. (CampNearCampaigns)
Typ: Response format. (XML or JSON)
Latitude: Latitude of location.
Longitude: Longitude of location.
Radius: The radius of the area bounding the campaigns.
Category: Category specification of Campaign.

Response Parameters


XML Response

Near Campaign response returns in XML format when the Typ parameter is set as "XML".

Below is an example for a POI Search request which is expected to return a response in XML format .

http://www.locationbox.com.tr/locationbox/services?Key=key&Cmd=CampNearCampaigns&Typ=XML
&Latitude=41.01&Longitude=29.1&Radius=10000&Category=Elektronik

The response will be as following:

<response>
 <transactionid>LBS_37486216</transactionid>
 <status>0</status>
 <errno />
 <errdesc />
 <items>
  <campaign>
   <id>539</id>
   <name>Play Station Portable</name>
   <description>Play Station Portable</description>
   <category>Elektronik</category>
   <hot>1</hot>
   <startdate>2012-07-21 00:00:00</startdate>
   <enddate>2012-08-01 00:00:00</enddate>
   <brandid>493</brandid>
   <brandname>TEKNOSA</brandname>
   <productname>Play Station Portable</productname>
   <producttitle/>
   <productdetails/>
   <productpayment/>
   <productlistprice>399.0</productlistprice>
   <productprice>299.0</productprice>
   <discountpercent>0.0</discountpercent>
   <stockamount>0</stockamount>
   <imageurl1>
   http://www.locationbox.com.tr/images_camp/camp_539_1.jpg
   </imageurl1>
   </imageurl2>
   </imageurl3>
   <count>203</count>
  </campaign>
  <poi>
   <id>34200085127</id>
   <name>TEKNOSA-ÝSTANBUL YENÝSAHRA OPTÝMUM</name>
   <address>YENÝ SAHRA MAH. ÝSTÝKLAL SOKAK ATAÞEHÝR ÝSTANBUL</address>
   <phone>+90 216 6641620</phone>
   <latitude>40.98869</latitude>
   <longitude>29.08622</longitude>
   <distance>2635</distance>
  </poi>

   ...

  </campaign>
 </items>
</response>
JSON Response

Near Campaign response returns in JSON format when the Typ parameter is set as "JSON".

Below is an example for a Campaign request which is expected to return a response in JSON format .

http://www.locationbox.com.tr/locationbox/services?Key=key&Cmd=CampNearCampaigns&Typ=JSON
&Latitude=41.01&Longitude=29.1&Radius=10000&Category=Elektronik

The response will be as following:


{ { "transactionid": "LBS_37494957", "status": 0, "items": [ { "id": 539, "name": "Play Station Portable", "description": "Play Station Portable", "category": "Elektronik","hot": "true", "startdate": "2012-07-31 00:00:00", "enddate": "2012-08-01 00:00:00", "brandid": 493, "brandname": "TEKNOSA", "productname": "Play Station Portable", "producttitle": "Play Station Portable", "productdetails": "Play Station Portable", "productpayment": "", "productlistprice": "399.0", "productprice": "299.0", "discountpercent": "0.0", "stockamount": "0", "imageurl1": "http://www.locationbox.com.tr/images_camp/camp_539_1.jpg", "imageurl2": "", "imageurl3": "", "imageurl4": "", "imageurl5": "","count": -1, "poi": { "id": 34200085127, "name": "TEKNOSA-ÝSTANBUL YENÝSAHRA OPTÝMUM", "address": "YENÝ SAHRA MAH. ÝSTÝKLAL SOKAK ATAÞEHÝR ÝSTANBUL", "phone": "+90 216 6641620", "latitude": 40.98869, "longitude": 29.08622, "distance": 2635 } },
...
{ "id": 544, "name": "Televizyonlarda %18 indirim", "description": "Televizyonlarda %18 indirim", "category": "Elektronik", "hot": "true", "startdate": "2012-07-31 00:00:00", "enddate": "2012-07-31 00:00:00", "brandid": 36, "brandname": "Bimeks", "productname": "Televizyonlarda %18 indirim", "producttitle": "Televizyonlarda %18 indirim", "productdetails": "Televizyonlarda %18 indirim", "productpayment": "", "productlistprice": "0.0", "productprice": "0.0", "discountpercent": "0.0", "stockamount": "0", "imageurl1": "http://www.locationbox.com.tr/images_camp/camp_544_1.jpg", "imageurl2": "", "imageurl3": "", "imageurl4": "", "imageurl5": "","count": -1, "poi": { "id": 34200052051, "name": "BIMEKS-ÜMRANIYE CARREFOUR", "address": "SARAY MAH. KÜÇÜKSU CADDESI ÜMRANIYE ÝSTANBUL", "phone": "+90 216 5151178", "latitude": 41.03446, "longitude": 29.11547, "distance": 3012 } },

transactionid: The id of response given by LocationBox Service. Every response can be tracked using transactionid when necessary.
status: Response format. (XML or JSON)

Status Codes
0 -- Success
1 -- Fail

errno: Error code
errdesc: Error definition

Error Codes
10001 Error processing your request. Please try again soon.
Cmd parameter is misspelled/not found.
10011 Error processing your request. Please check the Cmd parameter.
Cmd is not specified.
10012 Error processing your request. Please check the Key parameter.
Key is not specified.
10013 Error processing your request. Please check the Key parameter.
Key is invalid.
20012 No data found.