Gets the allocation between areas in the specified Layer and areas in the Layer from which it is built.
URL: /data/areas/v1/getAllocation
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 |
|
mapLayerKey |
string |
Yes |
The API key matching the Layer the allocation is required for. |
Response
The following responses may be returned in addition to the standard ones specified under Common Information.
|
Code |
Error Message |
Description |
|
400 |
Allocations cannot be provided for this MapLayer. |
The Layer was not of Area type, or is not an aggregated Area Layer. |
Example call
URL: https://api.vision-mapping.com/data/areas/v1/getAllocation?apiKey=INSERT_YOUR_KEY_HERE
Body:
{"mapLayerKey":"abc"}
Example response
[{"name":"abc","uniqueKey":"abc","keys":[{"key":"abc","value":"abc"},{"key":"abc","value":123}],"items":[{"name":"abc","uniqueKey":"abc","keys":[{"key":"abc","value":"abc"},{"key":"abc","value":true}]}]}]
Comments
0 comments
Article is closed for comments.