GetKeyStatus

GetKeyStatus Service gives information about the key active status, expire_date, request_limit and packages (TRAFIK, NOBETCI_ECZANE, WEATHER_REPORT, DEMOGRAFIK, EARTHQUAKE..).

A GetKeyStatus request must look like this:

https://locationbox.com.tr/locationbox/services?Key=key&Typ=output_format&Cmd=GetKeyStatus

Request Parameters

Key: LocationBox user key. (Register for user key)
Cmd: LocationBox service name. (JSON)
Typ: Response format. (XML or JSON)

Response Parameters

XML Response

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

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

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

The response will be as following:

<response>
 <transactionid> LBS_1144315815 </transactionid>
 <status> 0 </status>
 <errno />
 <errdesc />
 <key> 3..9 </key>
 <expire_date> 2024-12-31 </expire_date>
 <request_limit> 60000000 </request_limit>
 <request_count> 5430959 </request_count>
 <active> 1 </active>
 <packages>
  <package>
   <name> NOBETCI_ECZANE </name>
   <count> 2 </count>
   <expire> 31.12.2024 00:00:00 </expire>
  </package>
 </packages>
</response>


JSON Response

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

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

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

The response will be as following:

{ "transactionid": "LBS_1144315815", "status": 0, "key": "3..9", "expireDate": "2024-12-31", "requestLimit": 60000000, "requestCount": 5433630, "active": 1, "packages": [ { "name": "NOBETCI_ECZANE", "count": 2, "expire": "31.12.2024 00:00:00" } ] }

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.