Data/v2/AddFilters

Adds an area or location record to one or more static DataFilters.

URL: /data/v2/addFilters

Method: POST

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
uniqueKey	string	Yes	The unique key of a record.
layerKey	string	Yes	The API key matching the Layer in which the record is stored.
dataFilterKeys	string array	Yes	A collection of one or more API keys matching the DataFilter(s) you wish to add the record to. All specified DataFilters should be of static type.

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

Code

Error Message

Description

200

The request for the following Filter Key(s) could not be met: { key }, { key }, { key }

The request was carried out successfully for all Keys provided with the exception of the Keys returned in the error message.

For any keys returned, either:

the DataFilter was not found,
the DataFilter was not of static type,
the DataFilter was not attached to the Layer in which the specified record is in.

400

The collection of DataFilter Keys provided was either empty or null.

The dataFilterKeys parameter was either an empty collection or null.

URL: https://api.vision-mapping.com/data/v2/addFilters?apiKey=INSERT_YOUR_KEY_HERE

Body:

{
   uniqueKey: "abc",
   layerKey: "abc",
   dataFilterKeys: [
      "abc",
      "abc1",
      "abc2"
   ]
}

Response 200 OK

Message:

"The request for the following Filter Key(s) could not be met: abc1"