Locations Placemarks API Endpoint Follow

Using the Meridian API Placemarks endpoint, you can modify and add content to placemarks you’ve added in the Editor. You can also use the API to add new placemarks to a map.

The Placemarks API endpoint will return a 400 error for update (POST/PATCH/PUT) calls that include a language header, because it’s unclear whether the placemark data should be replaced or its translation.

The Placemarks Endpoint

The Placemarks endpoint is tied to a specific Meridian Editor location.

/api/locations/{location_id}/placemarks/{placemark_id}

Token Authentication

Before you can use the Meridian API’s Placemarks endpoint, POST a valid token to:

https://edit.meridianapps.com/api/tokens

All of the following API requests will need to use token authentication. Read requests don’t require a token.

To get a token, post a valid email and password to:

https://edit.meridianapps.com/api/login

Token Authentication

Upon receiving successful login credentials, the login API returns a token value. This token is available for use until it’s deleted or a logout request is received.

For more information on token authentication, please see Token API.

Create a New Placemark

To create a placemark with the API, POST a request to:

https://edit.meridianapps.com/api/locations/{Location ID}/placemarks

Your POST request requires map, x, y, and type values. Please see below for more information on these placemark fields.

The x/y values are used to generate latitude and longitude values for that placemark.

Create a New Placemark Using Latitude and Longitude

You can also create placemarks using latitude and longitude values in place of x and y.

Before using lat/long coordinates, make sure that your Map Anchor Points have been set.

The Meridian Editor will validate whether the lat/long values are valid coordinates, but won’t validate whether those coordinates are on the map or not.

Use decimal degree latitude and longitude coordinates.

Edit a Placemark’s Values

To edit an existing placemark’s values, PATCH a request to:

https://edit.meridianapps.com/api/locations/{Location ID}/placemarks/{Placemark ID}

Delete a Placemark

To delete a placemark, DELETE a request to:

https://edit.meridianapps.com/api/locations/{Location ID}/placemarks/{Placemark ID}

Upload Placemark Images

Images are uploaded using a multi-part/form data stream.

When you PUT the image, please make sure the Key is set to “upload”.

Once you’ve created a placemark and have its ID, send a PUT request to the SVG endpoint to upload a file:

https://edit.meridianapps.com/api/locations/{Location ID}/placemarks/{Placemark ID}/image

Make sure your images are smaller than 2.5 megabytes.

Download Placemark Images

In order to download placemark’s image, send a GET request to the placemarks endpoint for a specific location, map, and placemark ID:

https://edit.meridianapps.com/api/locations/{Location ID}/placemarks/{Placemark ID}

The image URL is in the image_url field.

Placemark Filters

Placemark filters provide you with more control when requesting placemarks through the API.

The following are supported placemark filters:

• category_id
• custom_1, custom_2, custom_3, custom_4
• hide_on_map
• is_facility
• map
• name
• related_map
• type
• type_category
• uid

Filter values are case sensitive and require exact matches.

When using multiple filters, comma separated values are evaluated as OR.

Use the UID Field

If you need to associate a placemark with a unique ID in a non-Meridian system, use the placemark UID field to do so.

Store the internal ID in the placemark’s UID field.

Use this API call to get a placemark by its UID:

https://edit.meridianapps.com/api/locations/{location ID}/placemarks?uid={UID value}

UID is meant to relate placemarks to items in customer databases. Please note that the Editor doesn’t warn about duplicate UIDs.

Placemark API Field Reference

Here are descriptions of the Placemark API endpoint fields.

{
    "link": "https://edit.meridianapps.com",
    "title": "Meridian Editor"
}

{
    "link": "page/id123",
    "title": "Phone Numbers"
}

Placemark Types