This endpoint is deprecated. Please see the latest version.
Update the address data for a location.
URL: /data/locations/v1/setAddress
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
All Address fields are required. Passing null into any of these fields will result in that line of the Address being set to a blank value.
|
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. |
|
line1 |
string |
Yes |
The new value for Line 1 of the Address. |
|
line2 |
string |
Yes |
The new value for Line 2 of the Address. |
|
line3 |
string |
Yes |
The new value for Line 3 of the Address. |
|
cityTown |
string |
Yes |
The new value for the City/Town of the Address. |
|
countyState |
string |
Yes |
The new value for the County/State of the Address. |
|
postcode |
string |
Yes |
The new value for the Postal / ZIP Code of the Address. |
|
country |
string |
Yes |
The new value for the Country of the Address. |
Response
All responses that may be returned are specified under Common Information.
Example call
URL: https://api.vision-mapping.com/data/locations/v1/setAddress?apiKey=INSERT_YOUR_KEY_HERE
Body:
{"recordKey":"abc","dataFieldKey":"abc","line1":"abc","line2":"abc","line3":"abc","cityTown":"abc","countyState":"abc","postcode":"abc","country":"abc"}
Comments
0 comments
Article is closed for comments.