Get route templates with steps

/v2/routes/templatesWithSteps

Finds the route templates defined in the account and returns them.

Parameters

This endpoint has no parameters.

Return

A array of route templates as defined bellow

[
  {
    "id": 0,
    "name": "string",
    "numberOfLegs": 0,
    "departurePlace": "string",
    "arrivalPlace": "string",
    "duration": 0,
    "code": "string",
    "colour": 0,
    "timestamp": "2024-03-05T15:24:13.201Z",
    "username": "string",
    "steps": [
      {
        "id": 0,
        "createCorridor": true,
        "corridorWidth": 0,
        "polyline": "string",
        "assignId": 0,
        "assignNumber": 0,
        "routeGroupId": 0,
        "starts": {
          "placeId": 0,
          "address": "string",
          "planned": "2024-03-05T15:24:13.201Z",
          "coordinates": {
            "latitude": 0,
            "longitude": 0
          },
          "clientId": 0
        },
        "arrive": {
          "placeId": 0,
          "address": "string",
          "planned": "2024-03-05T15:24:13.201Z",
          "coordinates": {
            "latitude": 0,
            "longitude": 0
          },
          "clientId": 0
        },
        "times": {
          "mileage": 0,
          "duration": 0,
          "breaks": 0,
          "stopOver": 0
        },
        "notifications": {
          "mode": "none",
          "delta": 0,
          "subject": "string",
          "message": "string",
          "useCrmContacts": true,
          "useAccountContacts": true,
          "warnings": {
            "emails": "string",
            "phones": "string"
          },
          "others": {
            "emails": "string",
            "phones": "string"
          }
        },
        "alarms": {
          "contacts": {
            "emails": "string",
            "phones": "string"
          },
          "terminal": "notSendAlarm",
          "sound": 0,
          "playSound": true,
          "confirmation": true,
          "form": "string",
          "formInterval": 0,
          "warningATDBefore": true,
          "warningATDBeforeDuration": 0,
          "warningATDAfter": true,
          "warningATDAfterDuration": 0,
          "warningETABefore": true,
          "warningETABeforeDuration": 0,
          "warningETAAfter": true,
          "warningETAAfterDuration": 0,
          "warningETATolerance": true,
          "warningETAAfterImidiately": true,
          "warningATDAfterImidiately": true
        },
        "messages": {
          "message": "string",
          "scheduleArriveTime": true,
          "destinationPoint": true,
          "taskId": 0,
          "jobId": 0
        },
        "dragPoints": [
          {
            "latitude": 0,
            "longitude": 0
          }
        ],
        "formSinceLastTime": 0,
        "altDirIndex": 0
      }
    ],
    "auxiliaryId": "string",
    "field1": "string",
    "field2": "string",
    "field3": "string"
  }
]

Response HTTP Codes

200 - OK

The result of the endpoint contains route templates

201 - No content

No route templates were found in the account

401 - Unauthorized

  • Invalid creadencials

403 - Forbidden

  • If the user has no permissions to use this endpoint