Synchronizing a RouteCloud Scenario with Verizon Connect Fleet
POST
https://routecloud.telogis.com/v1/platform/sync.- Authentication required.
- Request body: sync_request.
- Response body:
- If
wait=1
specified, returns the task result (see below). - Otherwise, returns a task_redirect_response.
- If
- Task result:
This endpoint is used to publish changes made in a RouteCloud Scenario to live data.
If changes have been made to the live data since your scenario was created, your changes may not be published. This can occur if your changes were based on out-of-date information or conflict with other changes made. To check for unpublished changes inspect the sync_response. In this situation we suggest you request a fresh snapshot and repeat the operation.
Query Parameters
wait=1
- Optional. Wait until thebuild
completes before returning the result. See Retrieving API Results.
Status Codes
200
- Success.302
- Ifwait=1
was provided and thebuild
result is not yet available, a redirect is sent every 15 seconds (instead of a normal result) to refresh the HTTP timeout. See Retrieving API Results.400
- The request was invalid. The response will be an error_response.401
- Authentication required.
sync_request
Name | Type | Description |
---|---|---|
commit_local | string | Must be set to "when_no_conflicts" |
sandbox_id | string | The id of the sandbox to publish |
publish_all_job_assignments | boolean | Should be set to true to apply the job assignments you have made in your scenario |
sync_response
Name | Type | Description |
---|---|---|
local_changes | delta[] | Lists any changes that were not applied. Changes might not be applied if another user has modified the live data (which can lead to a conflict) since your scenario was created. |