SetClassification
Updates the Classification for a record. Can be used to remove the Classification from a record.
URL: /data/v2/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. |
Model Object Properties
|
Name |
Type |
Required |
Description |
|
uniqueKey |
string |
Yes |
The unique key of a record. |
|
layerKey |
string |
Yes |
The API key matching the Layer in which the record is stored. |
|
classificationKey |
string |
No |
The API key matching the Classification being set against the specified record. Pass null to remove the classification set against the specified record. |
Response
The following responses may be returned in addition to the standard ones specified under Common Information.
|
Code |
Error Message |
Description |
|
|
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 Layer in which the record belongs. |
Example call
URL: https://api.vision-mapping.com/data/v2/setClassification?apiKey=INSERT_YOUR_KEY_HERE
Body:
{
uniqueKey: "abc",
layerKey: "abc",
classificationKey: "abc"
}
OR
{
uniqueKey: "abc",
layerKey: "abc",
classificationKey: null
}