Skip to main content

Add or Update Job Waypoints

Inserts or replaces an existing waypoint for a job.

Query String Parameters

NameTypeDescriptionRequired
ActionStringJobAddWaypointRequired
WPJobIdStringThe unique identifier of the job, which can be retrieved using any of the methods listed under add something here.Required
WPJobRefStringThe reference of the job that is input as free text.Optional - see tip
WPContactIdIntIf supplied, address details will be taken from this contact.Optional
WPContactRefStringIf WPContactId not supplied, WPContactRef will be used to search for contact.Optional
WPNameStringThe name of the contact.Optional
WPStreetStringThe street address of the contact.Optional
WPCityStringThe address town of the contact.Optional
WPCountryStringThe address country of the contact.Optional
WPPostcodeStringThe postal code of the contact.Optional
WPLatDoubleLatitude.Optional
WPLonDoubleLongitude.Optional
WPStopLenIntDuration.Optional
WPNotesStringWaypoint notes.Optional
WPStopNoIntWaypoint stop number.Optional
WPReplaceBoolReplace the waypoint at position 'WPStopNo' if set to 1.Optional

tip
Either the Job Id or Reference can be supplied. If both parameters are provided, the Job Id will take precedence.

Response Codes

CodeMessageInformation
2 error - WPJobid
2 error
0result
2 error
2Can't get a valid position for the contact address

Example

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=JobAddWaypoint&WPJobId=131252692&WPContactId=30434972