location.policy.find

The location.policy.find command is used to find a Location policy.

You need to have appropriate permissions to execute this command

TR50 Request
{
  "cmd": {
    "command": "location.policy.find",
    "params": {
      "id": "5c4f6e36ec2a1331dc0219f1"
    }
  }
}

Request Parameters

NameTypeRequiredDescription
id String Yes id of the Location policy to find.
TR50 Response
{
  "cmd": {
    "success": true
    "params": {
	"id": "5c4f7174fe2a1362dc0247e3",
	"name": "myLocationPolicy",
	"network": {
	    "providers": [
		{
		  "provider": "unwiredlabs", 
		  "value": 0
		},
		{
		  "provider": "rxnetworks",
		  "condition": "accuracy",
		  "value": 501
		}
	],
	"results": "average"
	}
    }
  }
}

Response Parameters

Name Type Required Description
id String Yes id of the Location policy.
name String Yes Name of the Location policy.
provider String Yes Must provide at least one primary provider. The provider is either unwiredlabs or rxnetworks or both.
condition String   condition is set to accuracy, on_failure or ""(blank for Always). When you set to on_failure or accuracy, then the secondary location is used accordingly whenever the first provider fails or provides less accuracy results than the value specified.
value Integer   value is only used if the condition is accuracy and is the threshold when the second provider is used. For example, If you set value=500 it means that if the first provider has an accuracy > 500 , then the second provider is used
results String   results is set to either average or best.
best: When you set it to best, it takes the result with the best accuracy

average: When you set it to average, it takes an average of the results from all the providers that returned data.