• 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

    Validate Problems

    • POST https://routecloud.telogis.com/v1/validate.
    • Authentication required.
    • Request body: problem.
    • Response body: validate_response.

    The validate call checks that the supplied problem is valid. The call also returns a list of warnings, indicating potential issues about the request. If the response contains errors, any optimization endpoint (such as build) will fail with a 400 status code.

    Status Codes

    • 200 - Success.
    • 400 - The input problem was invalid. The response is an error_response.
    • 401 - Authentication required.

    For example, sending POST https://routecloud.telogis.com/v1/validate with the body:

    {
      "name": "validate_test",
      "routes": [{
        "id": "route0",
        "location": "40.659491, -111.967176",
        "jobs": [{
          "id": "job0",
          "location": "40.652311, -111.878820",
          "priority": "an invalid priority"
        }]
      }]
    }
    

    Returns the following response:

    {
      "errors": [
        {
          "property": "request.jobs['job0'].priority",
          "code": "job_priority_invalid_error",
          "message": "'job.priority' must be one of: 'highest', 'high', 'normal', 'low' or 'lowest'.",
          "attempted_value": "an invalid priority",
          "parameters": {
            "property_name": "priority"
          }
        }
      ],
      "warnings": []
    }
    

    See Also

    • The problem type.
    • The validate_response type.