We have tried to make the configuration friendly to web applications. It comes down to two tasks the first is building the search url that will return the data in the format you have specified. The second is limiting the amount of request you want to get per user.
url_request is the paramater for configuring the url that will be passed to you web application. There are a number of possible variable that you can use.
- country - country that the mobile phone is in
- province - is the state or province the phone is in
- city - the city or region the phone is in
- post_code - the zip or postal code that the phone is in
- street - the street address however this may not alway be available
In addition to the param above or as an alternative if you can already search your data using lattitude and longitude then you can use those paramaters.
- lat - lattitude
- lon - longitude
min_request_timeout is a per user timout that forces a minimum of seconds before another request will be sent to your web application
min_distance_delta is the minimum distance that a mobile phone changes before sending another request
speed_limit for some application they can not work affectivly if the user is traveling over a certain speed so we have added a speed limit that will make it so those application will not sent requests if a mobile phone passes that speed limit
data_format the format at which the data will be returned which is coverd in the data format section Services API.
{
"url_request":"http://www.myexamplesite.com/search?county=$country&state=$province&city=$city&post_code=$post_code",
"min_request_timeout":30,
"min_distance_delta":1000,
"speed_limit":30,
"data_format":"json"
}
{
"url_request":"http://www.myexacmplesite.com/search?x=$lat&y=$lon",
"min_request_timeout":30,
"min_distance_delta":1000,
"speed_limit":30,
"data_format":"xml"
}