• Developers
• /
• APIs
• /
• Location Services

Location Management: Update List or Point

Update a list of locations or a particular location within that list. Lists modified using this API can be used with our Distance Finder endpoint.

The Update List or Point API allows you to update an existing list created using our Create List endpoint. 

When updating a list or point, any fields left null will retain their original information.

To add new points to a list, only supply the new values - the existing points will be unaffected. You can add a maximum of 100 points to an existing list per request.

Request parameters

Each request to the web service requires a number of parameters, all of which are listed below. All requests require a key which can be generated in your account.

Note: where potentially sensitive data is used in these parameters, remember to make the request as secure as possible (see the API Security page for more information).

When updating a list or point, any fields left blank will retain their original information.

* = required field

Locations fields

Further information on the fields contained within the “locations” Array.

Note: Most of these fields are not required and exist to provide contextual information about the location if results are being displayed.

Back to top

Response Fields

The response from the web service is a table with the specification below. Where no items are found, the response will be empty (although all endpoints specify the columns). If an error occurs, the response will not follow this format. Instead the response will be an error table.

Back to top

Errors

Below are the errors which are specific to this web service. If an error occurs, an error table like the one below will be returned. To check for an error response, test for a 4-column table with columns "Error", "Description", "Cause" and "Resolution" containing a single row.

For a list of errors applicable to all APIs, have a look at the list of common errors.

Back to top

Examples

The example below shows a request to the API along with the corresponding response.

Example Update List or Point Request

POST https://api.addressy.com/LocationServices/LocationManagement/UpdateListOrPoint/v1.00/json4.ws?
Content-Type: application/json

{
    "key": "AA11-AA11-AA11-AA11",
    "listId": "7bbcbea3-c995-4ed7-9be2-bfb25b3b2cef",
    "listDescription": "New description",
    "locations": [
        {
            "Id": "971558ff-c725-4b66-bfee-42e7cbb2be7f",
            "Name": "Worcester Office Updated",
            "Description": "An updated location of our Worcester office",
            "Address": "Waterside, Basin Rd, Worcester WR5 3DA",
            "latitude": "51.5119437",
            "longitude": "-0.1279533",
            "metaInfo": {
                "ContactNumber": "01244657333"
            }
        }
    ]
}

Example Response

{
    "ListId": "7bbcbea3-c995-4ed7-9be2-bfb25b3b2cef",
    "ListName": "UK Offices Geocoded",
    "ListDescription": "New description",
    "Locations": [
        {
            "Id": "971558ff-c725-4b66-bfee-42e7cbb2be7f",
            "Name": "Worcester Office Updated",
            "Description": "An updated location of our Worcester office",
            "Address": "Waterside, Basin Rd, Worcester WR5 3DA",
            "Latitude": "51.5119437",
            "Longitude": "-0.1279533",
            "MetaInfo": {
                "Contact Number": "01244657333"
            }
        },
        {
            "Id": "4ba9b14d-4fa9-4ce3-8cbf-e7b19d268720",
            "Name": "Chester Office",
            "Description": "Our office in Chester",
            "Address": "The Foundation Business Park, Heronsway, Chester CH4 9GB",
            "Latitude": "53.161261",
            "Longitude": "-2.90642",
            "MetaInfo": {
                "Contact Number": "01244657333"
            }
        },
        {
            "Id": "a8caeada-0ed7-476e-8706-d4656ff7ee0d",
            "Name": "London Office",
            "Description": "Our London Office",
            "Address": "128 Queen Victoria St, London EC4V 4BJ",
            "Latitude": "51.51205",
            "Longitude": "-0.097604",
            "MetaInfo": {
                "Contact Number": "02074281250"
            }
        }
    ],
    "CreatedOn": "2023-09-04T11:19:27.395Z",
    "LastModifiedOn": "2023-09-04T12:10:22.229Z"
}

Back to top