API

LocationBox API

User Point List

UserPointList request must look like this:

http://www.locationbox.com.tr/locationbox/services?Key=key&Cmd=UserPointList&Typ=output_format&SubKeys=keys&WhereClause=whereclause&Count=number(max.100)


Request Parameters


Key: LocationBox user key. (Register for user key)
Cmd: LocationBox service name. (UserPointList)
Typ: Response format. (XML or JSON)
SubKeys (optional): This keys can also access UserPointList.
WhereClause (optional): Where clause in UserPoint List fields.
Count (optional): Max 100 Points for one request.

Response Parameters


XML Response

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

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

http://www.locationbox.com.tr/locationbox/services?Key=key&Cmd=UserPointList&Typ=XML&SubKeys=keys&WhereClause=&Count=10

The response will be as following:

<response>
 <transactionid>LBS_311312</transactionid>
 <status>0</status>
 <errno />
 <errdesc />
 <items>
 <item>
  <id>1</id>
  <name>Sample</name>
  <type>0</type>
  <latitude>40.9686</longitude>
  <longitude>29.1005</longitude>
 </item>
 <item>
  <id>2</id>
  <name>Sample2</name>
  <type>3</type>
  <latitude>40.1499892613656</longitude>
  <longitude>26.4262958130633</longitude>
 </item>
 <item>
  <id>3</id>
  <name>Sample3</name>
  <type>0</type>
  <latitude>41.4269485473633</longitude>
  <longitude>32.9790115356445</longitude>
 </item>
 <item>
 </items>
</response>

JSON Response

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

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

http://www.locationbox.com.tr/locationbox/services?Key=key&Cmd=UserPointList&Typ=JSON&WhereClause=&Count=10

The response will be as following:


{ "transactionid": "LBS_11313", "status": 0, "items": [ { "id": "1", "name": "Sample", "type": 0, "latitude": 40.9686, "longitude": 29.1005, "angle": 30.5 }, { "id": "2", "name": "Sample2", "type": 3, "latitude": 40.1499892613656, "longitude": 26.4262958130633, "angle": 26.43 }, { "id": "3", "name": "Sample3", "type": 3, "latitude": 41.4269485473633, "longitude": 32.9790115356445, "angle": 57.5 }

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.