Data/v1/SetClassification

This endpoint is deprecated. Please see the latest version.

Updates the Classification for a record. Can be used to remove the Classification from a record.

URL: /data/v1/setClassification

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 record.
dataFieldKey	string	Yes	The ClientKey matching the DataField in which the recordKey value is stored. The specified DataField should be of SystemLink type.
classificationKey	string	No	The ClientKey matching the Classification being set against the specified record. Pass null to remove the classification set against the specified record.

The following responses may be returned in addition to the standard ones specified under Common Information.

Code	Error Message	Description
400	The Classification was not attached to the same MapLayer as the Location.	A Classification matching the classificationKey value was found but is not attached to the MapLayer in which the record belongs.

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

Body:

{"recordKey":"abc","dataFieldKey":"abc","classificationKey":"abc"}

{"recordKey":"abc","dataFieldKey":"abc","classificationKey":null}