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.

This endpoint requires the use of a Loqate Management key. Management keys are used to provide access to server-side functions in place of your standard API key, ensuring that were any of your keys to be scraped from a customer facing website, they could not be used to edit or delete your Location Lists. For information on how to create a Management key please see the Setting Up Store Finder Keys guide.

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
Response fields
Errors

Base URL

https://api.addressy.com/LocationServices/LocationManagement/UpdateListOrPoint/v1.00

Note: we don't support API connections using HTTP - all calls should use HTTPS.

JSON

https://api.addressy.com/LocationServices/LocationManagement/UpdateListOrPoint/v1.00/json4.ws?

Note: A REST endpoint with a JSON payload is the only call style supported.

Request

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.

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

Request parameters

Key Required String The Loqate Management key used to authenticate with the service. For example: "AA11-AA11-AA11-AA11".

listID Required String The unique GuID for a given list.

listName Optional String The name of the list being created.

listDescription Optional String A description of the list being created.

locations Optional Array of Location Objects An array of strings that is populated with information about a location. If latitude and longitude are blank then Geocoding must be set to true.

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.

Id Required String A GuID unique to a given location. If updating fields within one location this parameter is required.

latitude Required String The WGS 84 latitude in decimal degrees format. This is mandatory unless Geocoding is set to TRUE.

longitude Required String The WGS 84 longitude in decimal degrees format. This is mandatory unless Geocoding is set to TRUE.

name Optional String The name of the location.

description Optional String The description of the location for display purposes.

address Optional String The address of the location for display purposes. If Geocoding is set to TRUE then this parameter is mandatory.

isoCountry Optional String The ISO2 or ISO3 country code. If Geocoding is set to TRUE then this parameter is mandatory.

metaInfo Optional Dictionary <string,string> A key value pair that can be used to store any other relevant information. For example, this could be used to store contact information as “ContactNumber”:”123456789”

Example request

POST https://api.addressy.com/LocationServices/LocationManagement/UpdateListOrPoint/v1.00/json4.ws?

Content-Type: application/json

Add your API key into the code below for a sample request:

{
    "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"
            }
        }
    ]
}

Response

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.

Response fields

ListID String Automatically generated GuID used to uniquely identify a list.

ListName String The name of the list passed in the request.

ListDescription String The description of the list passed in the request.

Locations Array of Strings An array of strings that is populated with information about a location. Also contains a uniquely generated GuID per point.

CreatedOn DateTime The date and time of when the list was initially created.

LastModifiedOn DateTime The date and time of when the list was last modified.

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"
}

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 "Number", "Description", "Cause" and "Resolution" containing a single row.

Here's an example, for reference:

{
    "Number": 1010,
    "Description": "Location Management operations required a Management Key",
    "Cause": "Location Management operations required a Management Key",
    "Resolution": "Ensure you are using a Management key created by adding a Store Finder service to your Loqate account"
}

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

Number	Description	Cause	Resolution
1001	No List Id Suppled	The List Id is missing from the input paramaters	Please supply a List Id and try again.
1004	Invalid lat or long Supplied for point.<Point name>	Invalid lat or long supplied.	Check input data.
1005	Point Supplied with no name.	Point supplied with no name.	Check point data.
1006	No list of that ID can be found associated with your account.	There has either been no list uploaded with that ID or one that has had that ID previously has been deleted.	Correct ListID and try again.
1010	Location Management operations required a Management Key	Location Management operations required a Management Key	Ensure you are using a Management key created by adding a Store Finder service to your Loqate account.