This endpoint has been deprecated. There is no newer version.
Transfer a Location from one Layer to a different Layer.
URL: /data/locations/v2/transfer
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 location record. |
layerKey |
string |
Yes |
The API key matching the Layer in which the record is stored. |
targetLayerKey |
string |
Yes |
The API key matching the Layer in which the record should be moved to. |
Response
The following responses may be returned in addition to the standard ones specified under Common Information.
Code |
Error Message |
Description |
400 |
The Target MapLayer was not suited for Locations. |
The targetLayerKey parameter value specifies a Layer of Area type. Locations can only be created on Layers of Location type. |
A Location with the same UniqueKey already exists in the target Layer. Moving this Record would cause a duplicate. |
The Layer specified by the targetLayerKey parameter value already contains a record with the specified uniqueKey parameter value. | |
No record providing access to the Target MapLayer was found. |
A Layer matching the specified value from the targetLayerKey parameter could not be found. |
Example call
URL: https://api.vision-mapping.com/data/locations/v2/transfer?apiKey=INSERT_YOUR_KEY_HERE
Body:
{"uniqueKey":"abc","layerKey":"abc","targetLayerKey":"abc"}
Comments
0 comments
Article is closed for comments.