Pinpoints
A Pinpoint represents a point of interest on a map.
In addition to the point’s location and name, it contains rich information such as an HTML description, media and tags.
GET
/v3.0/pinpoints
List all pinpoints.
- Query Parameters
- list (integer) – Only return pinpoints belonging to the given list.
- Status Codes
- 200 OK – success
- 401 Unauthorized – you did not provide authentication
- 403 Forbidden – you tried to access a forbidden resource
POST
/v3.0/pinpoints
Create a new pinpoint.
Example request:
POST /v3.0/pinpoints HTTP/1.1
Authorization: Bearer 0a1b2c3d4e5f
Content-Type: application/json
{
"address": "1 Place Francis Ponge, 34000 Montpellier, France",
"category": 1,
"description": "The future of local information",
"latitude": 43.609477,
"longitude": 3.883760,
"media_credits": "John Doe",
"media_file": {
"content": "iVBORw0KGgoAAAANSUhEUgAAAFwAAABcCAIAAABsjUUPAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH4gIMCwI4sS/JDAAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAhUlEQVR42u3QQQ0AAAgEoNP+nfVtBDeIQCUTrlYgRYoUKVKkSJEiRYoUKVKQIkWKFClSpEiRIkWKFClSkCJFihQpUqRIkSJFihQpSJEiRYoUKVKkSJEiRYoUKUiRIkWKFClSpEiRIkWKFKRIkSJFihQpUqRIkSJFihSkSJEiRYoUKVKkfLRXPAG3AGqXuAAAAABJRU5ErkJggg==",
"name": "test.png",
"type": "image/png"
},
"name": "Wemap Headquarters",
"tags": ["company", "maps"]
}
Example response
HTTP/1.1 201 OK
Content-Type: application/json
{
"address": "1 Place Francis Ponge, 34000 Montpellier, France",
"category": 1,
"description": "The future of local information",
"id": 1234,
"latitude": 43.609477,
"longitude": 3.883760,
"media_credits": "John Doe",
"media_url": "https://api.getwemap.com/images/pps-picpoints/e8c836b1c71894d1e0d7901d.png",
"name": "Wemap Headquarters",
"tags": ["company", "maps"]
}
- Request JSON Object
- address (string) – Full address of the location.
- altitude (number) – Altitude in meters.
- category (integer) – Category the pinpoint belongs to.
- description (string) – HTML description.
- latitude (number) – Latitude in decimal degrees.
- longitude (number) – Longitude in decimal degrees.
- media_credits (string) – Media credits and copyright.
- media_file (object) – Media for the pinpoint.
- name (string) – Name of the pinpoint.
- tags (array) – List of tags.
- Status Codes
- 201 Created – success
- 400 Bad Request – for instance a required field is missing
- 401 Unauthorized – you did not provide authentication
- 403 Forbidden – you tried to access a forbidden resource
GET
/v3.0/pinpoints/:id
Return the given pinpoint.
- Status Codes
- 200 OK – success
- 401 Unauthorized – you did not provide authentication
- 403 Forbidden – you tried to access a forbidden resource
- 404 Not Found – the requested resource was not found
PUT
/v3.0/pinpoints/:id
Update the given pinpoint.
- Request JSON Object
- address (string) – Full address of the location.
- altitude (number) – Altitude in meters.
- category (integer) – Category the pinpoint belongs to.
- description (string) – HTML description.
- latitude (number) – Latitude in decimal degrees.
- longitude (number) – Longitude in decimal degrees.
- media_credits (string) – Media credits and copyright.
- media_file (object) – Media for the pinpoint.
- name (string) – Name of the pinpoint.
- tags (array) – List of tags.
- Status Codes
- 200 OK – success
- 400 Bad Request – for instance a required field is missing
- 401 Unauthorized – you did not provide authentication
- 403 Forbidden – you tried to access a forbidden resource
- 404 Not Found – the requested resource was not found
DELETE
/v3.0/pinpoints/:id
Delete the given pinpoint.
- Status Codes
- 204 No Content – success
- 401 Unauthorized – you did not provide authentication
- 403 Forbidden – you tried to access a forbidden resource
- 404 Not Found – the requested resource was not found