API

LocationBox API

String to Image

String to Image Service get basecode64 image and give an url for that image which you can show on map.

A String to Image request must look like this:

http://www.locationbox.com.tr/locationbox/services?Key=key&Cmd=StringToImage&Typ=output_format


Request Parameters


You need to POST to get to image's url

Key: LocationBox user key. (Register for user key)
Cmd: LocationBox service name. (WeatherForecast)
Typ: Response format. (XML or JSON)
Width: You can set width of image
Height: You can set height of image
ImgString: You have to post basecode64 with ImgString

Response Parameters


XML Response

String to Image response returns in XML format when the Typ parameter is set as "XML".

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

http://www.locationbox.com.tr/locationbox/services?Key=key&Cmd=StringToImage&Typ=XML

The response will be as following:

<response>
 <transactionid>LBS_37525910</transactionid>
 <status>0</status>
 <errno />
 <errdesc />
  <url>
   <url>http://localhost:8080/locationbox/images/LBS_41325.jpg</url>
   <width>200</width>
   <height>200</height>
  </response>
JSON Response

String to Image response returns in JSON format when the Typ parameter is set as "JSON".

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

http://www.locationbox.com.tr/locationbox/services?Key=key&Cmd=StringToImage&Typ=JSON

The response will be as following:


{ "transactionid": "LBS_41321", "status": 0, "url": "http://localhost:8080/locationbox/images/LBS_41321.jpg", "width": 200, "height": 200 }

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

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.