Sign in

v1

latestOpenAPI 3.0.02026-07-24189145350.1 KB
Trips

Update trip checkpoint step

Update trip checkpoint step

patch/apis/stork-api/trips/{idOrCode}/checkpoints/{checkpointIndex}/steps/{stepIndex}

Path parameters

idOrCodestring required

Trip id or trip code

checkpointIndexnumber required
stepIndexnumber required

Request body

iconstring
namestring
finishTripsInProgressboolean
normalDurationstring
maxDurationstring
minDurationstring
zonesstring[]
actionstring
slugstring
completedAtstring
overwritePlannedstring
plannedAtstring required
triggeredAtstring required
triggerWithCertificationboolean
typestring

Example request

{
  "plannedAt": "2024-05-27T16:19:20.702+00:00",
  "triggeredAt": "2024-05-27T16:19:20.702+00:00"
}

Response

isDeletedboolean
deletedAtstring
idstring required
organizationIdstring required
realStartstring required
tripDefinitionstring required
delayedYellowstring required
delayedRedstring required
pendingColorstring required
finishedColorstring required
scheduledStartstring required
scheduledFinishstring required
realFinishstring required
finishReasonstring required
finishBystring required
localestring required
tripLifetimestring required
tripStartedLifetimestring required
tripCodestring required
totalDelaynumber required
terminalNamestring required
metersnumber required
minPercentagenumber required
maxPercentagenumber required
maxDrivingTimenumber required
restingTimenumber required
drivingTimeWindowTolerancenumber required
metersWithoutOptionsnumber required
finishOnLastCheckpointStepboolean required
forceShowLastCheckpointNextboolean required
stoppedboolean required
stoppedTimeIntransitToFirstCheckpointnumber required
drivenTimenumber
drivingTimeWindowstring[]
ttlFinishedTripsstring required
alertsstring[] required
logsstring[] required
hashstring required
reportingTypeobject required
tagsstring[] required