Add or Update Job Waypoints
Inserts or replaces an existing waypoint for a job.
Query String Parameters
Name | Type | Description | Required |
---|---|---|---|
Action | String | JobAddWaypoint | Required |
WPJobId | String | The unique identifier of the job, which can be retrieved using any of the methods listed under add something here. | Required |
WPJobRef | String | The reference of the job that is input as free text. | Optional - see tip |
WPContactId | Int | If supplied, address details will be taken from this contact. | Optional |
WPContactRef | String | If WPContactId not supplied, WPContactRef will be used to search for contact. | Optional |
WPName | String | The name of the contact. | Optional |
WPStreet | String | The street address of the contact. | Optional |
WPCity | String | The address town of the contact. | Optional |
WPCountry | String | The address country of the contact. | Optional |
WPPostcode | String | The postal code of the contact. | Optional |
WPLat | Double | Latitude. | Optional |
WPLon | Double | Longitude. | Optional |
WPStopLen | Int | Duration. | Optional |
WPNotes | String | Waypoint notes. | Optional |
WPStopNo | Int | Waypoint stop number. | Optional |
WPReplace | Bool | Replace 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
Code | Message | Information |
---|---|---|
2 | error - WPJobid | |
2 | error | |
0 | result | |
2 | error | |
2 | Can't get a valid position for the contact address |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=JobAddWaypoint&WPJobId=131252692&WPContactId=30434972
Response Data
{ "Code": 0 }