This endpoint is deprecated. Please see the latest version.
Adds an area or location record to one or more static DataFilters.
URL: /data/v1/addFilters
Method: POST
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 |
|
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. |
|
dataFilterKeys |
string array |
Yes |
A collection of one or more ClientKeys matching the DataFilter(s) you wish to add the record to. All specified DataFilters should be of static type. |
Response
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:
|
|
400 |
The collection of DataFilter Keys provided was either empty or null. |
The dataFilterKeys parameter was either an empty collection or null. |
Example call
URL: https://api.vision-mapping.com/data/v1/addFilters?apiKey=INSERT_YOUR_KEY_HERE
Body:
{"recordKey":"example","dataFieldKey":"example","dataFilterKeys":["abc","abc1","abc2"]}
Example response
Response 200 OK
Message:
"The request for the following Filter Key(s) could not be met: abc1"
Comments
0 comments
Article is closed for comments.