This endpoint is deprecated. Please see the latest version.
Get the boundary and formatting of a specified area.
URL: /data/areas/v1/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 |
|
recordKey |
string |
Yes |
The Key of a record. |
|
dataFieldKey |
string |
Yes |
The ClientKey matching the DataField in which the recordKey value is stored. The specified DataField should be of SystemLink type. |
Response
All responses that may be returned are specified under Common Information.
Example call
URL: https://api.vision-mapping.com/data/areas/v1/getBoundary?apiKey=INSERT_YOUR_KEY_HERE
Body:
{"recordKey":"abc","dataFieldKey":"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"}],"boundaryAsJson":[[[{"x":0.1,"y":0.1},{"x":0.1,"y":0.1}]]]}
Comments
0 comments
Article is closed for comments.