API

LocationBox API

Add Buffered Route To User Region

Add Buffered Route To User Region Service combine special route and region on database that user gave based on criterias which you can find below.

AddBufferedRouteToUserRegion request must look like this:

http://www.locationbox.com.tr/locationbox/services?Key=key&Cmd=AddBufferedRouteToUserRegion&Typ=output_format&Id=regionId&Name=regionName
&Coors=routecoors&BufferDist=bufferdistance
&String1=string&String2=string2&Number1=number1&Number2=number2


Request Parameters


Key: LocationBox user key. (Register for user key)
Cmd: LocationBox service name. (AddBufferedRouteToUserRegion)
Typ: Response format. (XML or JSON)
Id: ID of region.
PathId: ID of path.
BufferDist: Buffer distance. (meter)
Name (Optional): Name of buffered route.
Type (Optional): Type of bufered route.
String1...String9: Available parameters for user data in string format.
Number1...Number9: Available parameters for user data in number format.

Response Parameters


XML Response

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

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

http://www.locationbox.com.tr/locationbox/services?Key=key&Cmd=AddBufferedRouteToUserRegion&Typ=XML&Id=12&Name=Rota1&PathId=7851655
&BufferDist=200&String1=www.infotech.com.tr&String2=kurumsal@infotech.com.tr&Number1=1&Number2=2


The response will be as following:

<response>
 <transactionid>LBS_37538710</transactionid>
 <status>0</status>
 <id>12</id>
 <errno />
 <errdesc />
</response>

JSON Response

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

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

http://www.locationbox.com.tr/locationbox/services?Key=key&Cmd=AddBufferedRouteToUserRegion&Typ=XML&Id=12&Name=Rota1&PathId=7851655
&BufferDist=200&String1=www.infotech.com.tr&String2=kurumsal@infotech.com.tr&Number1=1&Number2=2


The response will be as following:


{ "transactionid": "LBS_50372229", "status": 0, "id": "12" }

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.