Add a Stop to a Route

Adds a new stop to the end of a route

Query String Parameters

Name	Type	Description	Required
Action	String	RouteAddStop	Required
RouteId	Int	Id of the route to edit Get a list of routes using Route List	Required
ContactId	Int	The unique identifier of the contact which can be retrieved using Contact List. Either ContactId or ContactRef required.	Required
ContactRef	String	The unique identifier of the contact which can be retrieved using Contact List. Either ContactId or ContactRef required.	Required
JobTypeId	Int	Id of a job type for the stop being added to the route. Either JobTypeId or JobTypeName required.	Required
JobTypeName	String	Name of the job type for the stop being added to the route. Either JobTypeId or JobTypeName required.	Required
StopDur	Int	Job/stop duration in minutes - Defaults to 15 if omitted	Optional
StopTime	Time	Time of day to schedule the job - Format "HH:MM:SS" – 24 hour	Optional
StopDescription	String	Description of the stop/job - Will appear as the job description when scheduled	Optional

You can specify StopTime for each stop in a route, the system will schedule the jobs for those times. If you do not specify a StopTime the system will determine the correct driving time between the stops and, when scheduled, will apply the jobs/stops to the schedule, allowing for the driving time between each stop.

Response Codes

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=RouteAddStop&RouteId=46793&ContactId=30967687&JobTypeId= 60840&StopDur=60&StopTime=09:00&StopDescription=Pickup

Response

Response Data

{
  "Code": 0
}