Data/Locations/v1/Transfer

This endpoint is deprecated. Please see the latest version.

Transfer a Location from one MapLayer to a different MapLayer.

URL: /data/locations/v1/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.

Name	Type	Required	Description
recordKey	string	Yes	The Key of a location record.
dataFieldKey	string	Yes	The ClientKey matching the DataField in which the recordKey value is stored. The specified DataField should be of SystemLink type.
targetMapLayerKey	string	Yes	The ClientKey of the MapLayer in which the specified record should be moved to.
targetDataFieldKey	string	Yes	The ClientKey matching the DataField in which the recordKey value should be stored after the transfer. The specified DataField should be of SystemLink type. This value may be the same as the dataFieldKey value if the specified DataField is attached to both the existing and target MapLayers.

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 targetMapLayerKey parameter value specifies a MapLayer of Area type. Locations can only be created on MapLayers of Location type.
	The Target DataField was not set as a SystemLink.	The targetDataFieldKey parameter value specifies a DataField that is not of SystemLink type.
	The Target DataField has not been linked to the Target MapLayer.	The targetDataFieldKey parameter value specifies a DataField that is not linked to the MapLayer specified by the targetMapLayerKey parameter value.
	No record providing access to the Target MapLayer was found.	A MapLayer matching the specified value from the targetMapLayerKey parameter could not be found.

URL: https://api.vision-mapping.com/data/locations/v1/transfer?apiKey=INSERT_YOUR_KEY_HERE

Body:

{"recordKey":"abc","dataFieldKey":"abc","targetMapLayerKey":"abc","targetDataFieldKey":"abc"}