• Home
  • Guides
  • Reference
  • Support

    Show / Hide Table of Contents
    • API Overview
      • Overview
      • Authentication
      • Retrieving API Results
      • Referenced vs Inline Entities
      • Choosing API Response Data
      • Handling API Errors
    • separator
    • Vehicle Routing Endpoints
      • Path
    • Optimization Endpoints
      • Instantiate
      • Build
      • Assignment Restrictions
      • Optimize
      • Sequence
      • Evaluate
      • Recommend
      • Insert
      • Centroids
      • Zones
      • Consolidate By Job Restrictions
      • Consolidate By Route Assignments
    • Geocoding Endpoints
      • Geocode
      • Reverse Geocode
    • Task Endpoints
      • List
      • Status
      • Result
      • Cancel
    • Sandbox Endpoints
      • List
      • Create
      • Rename
      • Retrieve
      • Update
      • Delete
      • Revisions
      • Add Revision
      • Expiry
      • Permissions
    • Verizon Connect Fleet Integration Endpoints
      • Pull Platform Data
      • Sync Platform Data
      • List Platform Territories
    • Other Endpoints
      • Canonicalize
      • Route Cards
      • Validate
      • Version
    • separator
    • Request Types
      • problem
      • capacity_metric
      • depot
      • driver
      • driver_break
      • job
      • job_template
      • job_type
      • load_amount
      • marker
      • problem_defaults
      • route
      • schedule
      • settings
      • shift
      • shift_override
      • shift_pattern
      • shift_pattern_assignment
      • stop
      • vehicle
      • zone
      • variance
    • Response Types
      • instantiate_response
      • problem_response
      • problem_aggregates
      • driver_response
      • geocoded_location
      • recommend_option
      • route_response
      • schedule_response
      • schedule_instantiate_response
      • stop_response
      • violation
    • Meta Types
      • task_redirect_response
      • task_status_response
      • validate_response
    • Sandbox Types
      • delta
      • array_delta
      • dict_delta
      • keyed_array_delta
      • object_delta
      • set_delta
      • revision
      • revision_created_response
      • revision_response
      • sandbox_response
    • Common Types
      • date_range
      • day_of_week
      • hazmat_load_type
      • id
      • latlon
      • stop_type
      • time_window
      • custom
      • polygon
    • Primitive Types
      • boolean
      • date
      • datetime
      • float
      • integer
      • string
      • timespan

    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.
    • Task result:
      • sync_response.

    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 the build completes before returning the result. See Retrieving API Results.

    Status Codes

    • 200 - Success.
    • 302 - If wait=1 was provided and the build 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.