load_rounds
To load the rides of a certain route for a specified period, use the route/load_rounds method:
svc = route/load_rounds
params = {
"itemId": <long>,
"timeFrom": <uint>,
"timeTo": <uint>,
"fullJson": <uint>
}
Parameters
The request must contain the following parameters:
| Parameter | Description |
|---|---|
| itemID | Route ID. |
| timeFrom | Interval beginning. |
| timeTo | Interval end. |
| fullJson | Response format. Pass 1 for detailed information, or 0 for basic information. |
Response
If the request is completed successfully, the response contains either basic or detailed information about the route rides, depending on the value of the fullJson parameter.
A response with basic information is returned in the following format:
[
{
"id": <long>, // Ride ID.
"ct": <long>, // Ride creation time (UNIX).
"mt": <long>, // Ride update time (UNIX).
"n": <text>, // Ride name.
"d": <text>, // Description.
"sh": <text>, // Schedule name.
"f": <uint>, // Ride flags.
"tz": <uint>, // Timezone.
"u": <long>, // Unit assigned to this ride.
"at": <uint>, // Activation time (Unix timestamp).
"vt": <uint>, // Start of the validity period (Unix timestamp).
"vp": <uint>, // Validity period (seconds).
"sts": <uint>, // Ride state flags.
"st": { // Ride state.
"st": { // General ride state.
"pi": <uint>, // Checkpoint index (4294967295 if not started).
"ps": <uint>, // State flags and event flags.
"ut": <uint> // Last event time (Unix timestamp).
},
"pts": { // State by individual checkpoint.
"<checkpoint_id>": {
"st": <uint>, // Event flags.
"tm": <uint> // Last event time.
}
// ... additional checkpoints
}
}
}
]
You can find state flags and event flags on the get_round_data page.
A response with detailed information has the same format as the one described on the get_round_data page.