• Help
• Journey Planner
• How it works
• OSM
• Developers
• API
• Photomap
• Photo licensing

CycleStreets API (v2)

• Details for:

  * Introduction * Overview & how to specify the API key Cycle routing - plan new journey Cycle routing - retrieve Cycle routing - plan leisure (circular) route Journeys of user Isochrones - show Nearest point Batch routes matrix - create job Batch routes matrix - control job Batch routes matrix - job data Batch routes matrix - delete job Geocoder Photomap locations Photomap location Photomap categories Add photo Update photo Like photo Photo of the day Photomap tags Points of Interest (POIs) Points of Interest (POIs) - types Collisions data Collision report Collisions metadata Traffic counts data Popup cycleways - locations being implemented Popup cycleways - suggested LTNs: Modal filters LTNs: Streets LTN statistics Infrastructure locations Infrastructure location Infrastructure schema GPS tracks - add List galleries Retrieve a specified gallery Create a gallery Update a gallery User authenticate User create Map downloads Status API testing - multiple API testing - run one API testing - list of tests Add feedback API V1 documentation (deprecated)
• API overview
• Obtain API key
• Usage policy
• Uptime policy

Update photo

This API call updates an existing location in the Photomap, e.g. to change details such as category, caption, etc.

The API call is very similar to the photomap.add call. The only difference is that an id, representing the location number, must be specified.

The call updates only the values for the supplied fields. For instance, if the location has a photo already and the update does not supply a new photo, the existing photo will not be removed.

Valid user credentials must be supplied, as with photomap.add.

Example

Example which updates an existing location.

In this example, only the caption and additional metadata are being updated. All other existing data will be unmodified.

POST https://api.cyclestreets.net/v2/photomap.update
(
	[id] => 64001
	[username] => myusername
	[password] => mypassword1978
	[caption] => This location serves the nearby shops. There has recently been an increase in the number of stands.
	[additionalMetadata] => {"spaces":20,"covered":"no","highway":"Red route"}
)

Result:

{
    "id": 64001,
    "url": "https://www.cyclestreets.net/location/64001/",
    "shortlink": "https://cycle.st/p64001",
    "imageUrl": "https://www.cyclestreets.net/location/64001/cyclestreets64001.jpg",
    "thumbnailUrl": "https://www.cyclestreets.net/location/64001/cyclestreets64001-size425.jpg"
}

Request parameters - required

id int

The location ID.

username string

The username or e-mail address of a user (whose account has been through validation). The API call will use the username/password credentials to perform authentication. If you are creating a third-party auditing-style application, it is fine to register a single user account and all submissions be made as that user.

password string

The password for this user. See details for username.

For other parameters, see documentation for photomap.add.

Request parameters - optional

Any of the fields supported by photomap.add (as listed in the required/recommended/optional parameter sections) can be supplied to updated their value(s).

Note that, currently, additionalMetadata must be (re-)supplied as a complete collection if any part of it needs to be updated. We hope to remove this limitation shortly.

There is no support in this API call for updating the username that 'owns' the location. Note that if an update is performed using a privileged (admin) account, the original username of the submitter is maintained.

Response

As shown above, the response is the same as the example in photomap.add.

Error response

JSON object containing an error key and a text string.

Example error (text string will vary):

{
    "error": "You do not appear to have rights to update this location."
}