Skip to main content

Route object

This page describes route object.

Object explanation#

  • name - string - required
  • trackId - integer - required
  • uuid - string - required
  • plannedTrackId - integer - required
  • userTrackRideId - integer - optional - appears after starting route
  • ascent - integer - required
  • descent - integer - required
  • trackDistance - integer - required
  • currentStage - object - required - only for planned & pending statuses
    • name - string - required
    • id - integer - optional - appears after starting route
  • totalStages - integer - required
  • startDate - string - optional - yyyy-MM-dd'T'HH:mm:ss.SSSZZZ - appears after starting route
  • timeSpent - integer - optional - appears after starting route
  • timeSpentWithoutPauses - integer - optional - appears after starting route
  • timeSpentWithoutPauses - integer - optional - appears after starting route
  • approximateTime - array - optional
    • days - string - may be "0"
    • hours - string - may be "0"
    • minutes - string - may be "0"
  • approximateUserTime - array - optional
    • days - string - may be "0"
    • hours - string - may be "0"
    • minutes - string - may be "0"

Example planned object#

{
"plannedTrackId": 489,
"trackId": 1382,
"name": "TESTS ktw - chr - orz (1620812968)",
"ascent": 734,
"descent": 757,
"trackDistance": 68129,
"uuid": "pt-489",
"currentStage": {
"name": "Dworcowa, Katowice, Polen (1) - ÅšlÄ…ski Stadium"
},
"totalStages": 2,
"currentStageNumber": 1,
"approximateTime": {
"days": "0",
"hours": "2",
"minutes": "54"
}
}

Example pending object#

{
"userTrackRideId": 734,
"plannedTrackId": 477,
"trackId": 1370,
"name": "TESTS ktw - chr - orz (1620812027)",
"startDate": "2021-05-12T09:33:49+0200",
"timeSpent": 0,
"timeSpentWithoutPauses": 0,
"ascent": 0,
"descent": 0,
"trackDistance": 68129,
"distanceTraveled": 0,
"uuid": "pt-477",
"currentStage": {
"name": "Dworcowa, Katowice, Polen (1) - ÅšlÄ…ski Stadium",
"id": 530
},
"totalStages": 2,
"currentStageNumber": 1,
"approximateTime": {
"days": "0",
"hours": "2",
"minutes": "54"
}
}

Example finished object#

{
"userTrackRideId": 731,
"plannedTrackId": 466,
"trackId": 1359,
"name": "TESTS ktw - chr - orz (1620798078)",
"startDate": "2021-05-12T05:41:20+0200",
"timeSpent": 0,
"timeSpentWithoutPauses": 0,
"ascent": 0,
"descent": 0,
"trackDistance": 68129,
"distanceTraveled": 0,
"uuid": "pt-466",
"totalStages": 2,
"currentStageNumber": 2,
"approximateTime": {
"days": "0",
"hours": "2",
"minutes": "54"
}
}
Edit this page