• 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

Batch routes matrix - control job

This API call controls a batch matrix job that has been created using batchroutes.createjob API call.

Note that, by default, jobs are auto-started within the batchroutes.createjob API call, so you do not normally need to use this.

It returns a URL of the batchroutes.jobdata API call that can be polled to determine when the data is available.

Example

Example which starts asyncronous planning of a batch job.

POST https://api.cyclestreets.net/v2/batchroutes.controljob?key=...
(
	[id] => 69158
	[action] => start
	[username] => myusername
	[password] => mypassword
)

Result:

{
    "id": 69158,
    "status": "open",
    "statusUrl": "https://api.cyclestreets.net/v2/batchroutes.jobdata?key=..."
}

Request parameters - required

id int

Batch job ID, as returned from batchroutes.createjob.

action string (start|pause|continue|terminate)

Action to take. Available actions are:

• start: Start (open) job
• pause: Pause job
• continue: Continue (re-open) job
• terminate: Stop job and delete generated data (leaving job definition itself in place)

username string

Your CycleStreets account username. In due course this will be replaced with an OAuth token.

password string

Your CycleStreets account password.

Request parameters - optional

None.

Response

JSON response as above, containing a result status and the URL to poll which gives the progress.

The returned status values are:

• ready: The job is ready to be started
• open: The job is being planned
• paused: The job is paused
• finalising: The job results are being finalised
• complete: The job is complete

Error response

JSON object containing an error key and a text string.

Example error (text string will vary):

{
    "error": "An error occurred while controlling the job."
}