get_round_data

To get detailed information about rides, use the route/get_round_data method:

Copied!
svc=route/get_round_data
params={
  "itemId": <long>,          
  "col": [<long>]              
}

Parameters

The request must contain the following parameters:

Parameter Description
itemID Route ID.
col Array of ride IDs.

Response

If the request is completed successfully, the response is returned in the following format:

Copied!
[
  {
    "id": <long>,         // Ride ID.
    "n": <text>,          // Name.
    "d": <text>,          // Description.
    "tz": <uint>,         // Timezone.
    "u": <long>,          // Assigned unit ID (if not specified, uses the first unit from "cu" that leaves the first checkpoint).
    "cu": [<long>],       // Array of unit IDs.
    "pt": [               // Checkpoints.
      {
        "n": <text>,      // Name.
        "f": <uint>,      // Type.
        "u": <long>,      // Unit ID (0 if not of the "checkpoint from unit" type).
        "y": <double>,    // Latitude.
        "x": <double>,    // Longitude.
        "r": <uint>       // Radius.
      }
    ],
    "sh": {               // Schedule.
      "id": <long>,       // Schedule ID.
      "n": <text>,        // Name.
      "f": <uint>,        // Type.
      "tz": <uint>,       // Timezone.
      "cfg": {            // Custom configuration. It is passed from the schedule object without changes.
        "enabled": <byte>,        // Automatic creation of rides: 1 — enabled, 0 — disabled.
        "name": <text>,           // Ride name.
        "description": <text>,    // Description.
        "roundFlags": <uint>,     // Ride flags.
        "units": [<long>],        // Unit IDs.
        "validityPeriod": <uint>  // Validity period.
      },
      "tm": [             // Time of passing checkpoints.
        {
          "at": <uint>,   // Arrival time.
          "ad": <uint>,   // Deviation from the arrival time.
          "dt": <uint>,   // Departure time.
          "dd": <uint>    // Deviation from the departure time.
        }
      ],
      "sch": {            // Time restrictions.
        "f1": <uint>,     // Start of interval 1.
        "f2": <uint>,     // Start of interval 2.
        "t1": <uint>,     // End of interval 1.
        "t2": <uint>,     // End of interval 2.
        "m": <uint>,      // Day-of-month mask.
        "y": <uint>,      // Month mask.
        "w": <uint>       // Day-of-week mask.
      }
    },
    "at": <uint>,         // Activation time.
    "vt": <uint>,         // Start of validity period.
    "vp": <uint>,         // Validity period.
    "f": <uint>,          // Ride flags.
    "st": {               // Ride state.
      "st": {             // General ride state.
        "pi": <uint>,     // Checkpoint index (4294967295 means the ride has not started).
        "ps": <uint>,     // State flags and event flags.
        "ut": <uint>      // Time of the last event.
      },
      "pts": {            // State by individual checkpoint.
        "<text>": {
          "st": <uint>,   // Event flags.
          "tm": <uint>    // Time of the last event.
        }
        // ... more checkpoints
      }
    }
  }
]

Checkpoint types are described on the update_checkpoints page.

Schedule types are described on the update_schedule page.

Ride flags

Flag Description
0x0 Checkpoint order: strict.
0x2 Remove finished rides from the timeline.
0x10 Checkpoint order: skipping is possible.
0x20 Allows running reports on rides.
0x40 Checkpoint order: arbitrary.

Ride state flags

Flag Description
0x010000 Not active.
0x020000 Finished.
0x040000 Expecting arrival.
0x080000 Expecting departure.
0x200000 Behind schedule.
0x400000 Ahead of schedule.
0x800000 Stopped.
0x0100000 Aborted.

Event flags

Flag Description
0x1 The ride started.
0x2 The ride finished.
0x4 The ride was aborted.
0x8 The unit arrived at a checkpoint.
0x10 The unit passed a checkpoint.
0x20 The unit departed from a checkpoint.
0x40 The unit arrived late.
0x80 The unit arrived ahead of time.
0x100 The unit passed a checkpoint on time.
0x200 The arrival was postponed.

If you find a mistake in the text, please select it and press Ctrl+Enter.

Report a mistake

Your message was sent. Thank you!

An error occurred while submitting the form

Download PDF file
Download Word document