Get the boundary and formatting of a specified area. Can only be used for organisation data and NOT subscribed data.
URL: /data/areas/v2/getBoundary
Method: POST
Method Parameters
|
Name |
Type |
Required |
Description |
|
apiKey |
string |
Yes |
The API key for your organisation. |
|
model |
object |
Yes |
The object detailing the specified values. See Model Object Properties. |
Model Object Properties
|
Name |
Type |
Required |
Description |
|
uniqueKey |
string |
Yes |
The unique key of a record. |
|
layerKey |
string |
Yes |
The API key matching the Layer in which the record is stored. |
Response
All responses that may be returned are specified under Common Information.
Example call
URL: https://api.vision-mapping.com/data/areas/v2/getBoundary?apiKey=INSERT_YOUR_KEY_HERE
Body:
{"uniqueKey":"abc","layerKey":"abc"}
Example response
{"name":"abc","uniqueKey":"abc","labelX":0.1,"labelY":0.1,"formatting":{"colour":"abc","key":"abc","name":"abc","opacity":0.1},"dataFields":[{"key":"abc","value":"abc"},{"key":"abc","value":123}],"boundaryAsJson":[[[{"x":0.1,"y":0.1},{"x":0.1,"y":0.1}]]]}
Comments
0 comments
Article is closed for comments.