routePlanningSettings

Requires permission visits:journey-plan:manage.

Returns the organization's route planning rules, with the stops per day, the time zone and, for automatic planning, the next run and the day it plans up to. Requires permission to manage journey plans.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query RoutePlanningSettings {
  routePlanningSettings {
    daysOff
    defaultVisitFrequencyDays
    isDefault
    keepManualStops
    maxSameDayRadiusKm
    minutesPerVisit
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query RoutePlanningSettings {\n  routePlanningSettings {\n    daysOff\n    defaultVisitFrequencyDays\n    isDefault\n    keepManualStops\n    maxSameDayRadiusKm\n    minutesPerVisit\n  }\n}"
}
EOF

Response:

{
  "data": {
    "routePlanningSettings": {
      "daysOff": [
        "string"
      ],
      "defaultVisitFrequencyDays": 0,
      "isDefault": true,
      "keepManualStops": true,
      "maxSameDayRadiusKm": 0,
      "minutesPerVisit": 0
    }
  }
}

routePlanningSettings: RoutePlanningSettings!

Type

RoutePlanningSettings object

The organization's route planning rules, with the values worked out from them.