Skip to main content

OnRouteData

routeName stringnullable
description stringnullable
routePoints object[]nullable
  • Array [
  • sequence integer<int32>
    pointType integer<int32>

    Possible values: [0, 1, 2, 3, 4, 5]

    minutes_at_location integer<int32>
    locationName stringnullable
    averageSpeedKmph integer<int32>nullable
    latitude number<double>nullable
    longitude number<double>nullable
    extraDetail object
    name stringnullable
    description stringnullable
    customer stringnullable
    documentNo stringnullable
    contactName stringnullable
    contactNumber stringnullable
    toleranceMeters integer<int32>nullable
    requireSignature booleannullable
    requirePhoto booleannullable
    resolvedLocation object
    id stringnullable
    tenantId stringnullable
    position object
    latitude number<double>required
    longitude number<double>required
    type stringnullable
    name stringrequired

    Possible values: <= 255 characters

    tolerance integer<int32>required
    tag stringrequired

    Possible values: <= 255 characters

    polyPoints object[]nullable
  • Array [
  • latitude number<double>required
    longitude number<double>required
  • ]
  • radius integer<int32>nullable
    geoZone stringnullable
    category stringnullable
    userType stringnullable
    contactID stringnullable
    contactName stringnullable
    contactNumber stringnullable
    contactEmail stringnullable
    address stringnullable
    addressCity stringnullable
    addressState stringnullable
    addressCountry stringnullable
    description stringnullable
  • ]
  • OnRouteData
    {
    "routeName": "string",
    "description": "string",
    "routePoints": [
    {
    "sequence": 0,
    "pointType": 0,
    "minutes_at_location": 0,
    "locationName": "string",
    "averageSpeedKmph": 0,
    "latitude": 0,
    "longitude": 0,
    "extraDetail": {
    "name": "string",
    "description": "string",
    "customer": "string",
    "documentNo": "string",
    "contactName": "string",
    "contactNumber": "string",
    "toleranceMeters": 0,
    "requireSignature": true,
    "requirePhoto": true
    },
    "resolvedLocation": {
    "id": "string",
    "tenantId": "string",
    "position": {
    "latitude": 0,
    "longitude": 0
    },
    "type": "string",
    "name": "string",
    "tolerance": 0,
    "tag": "string",
    "polyPoints": [
    {
    "latitude": 0,
    "longitude": 0
    }
    ],
    "radius": 0,
    "geoZone": "string",
    "category": "string",
    "userType": "string",
    "contactID": "string",
    "contactName": "string",
    "contactNumber": "string",
    "contactEmail": "string",
    "address": "string",
    "addressCity": "string",
    "addressState": "string",
    "addressCountry": "string",
    "description": "string"
    }
    }
    ]
    }