Sign in

v1

latestOpenAPI 3.0.02026-07-24189145350.1 KB
Trip Definitions

Update trip definition

Update trip definition

patch/apis/stork-api/trip-definitions/{id}

Path parameters

idstring required

Mongo id

Request body

namestring
localestring
tripLifetimestring
tripStartedLifetimestring
ttlFinishedTripsstring
delayedYellowstring
delayedRedstring
pendingColorstring
finishedColorstring
drivingTimeWindowstring[]
restingTimenumber
drivingTimeWindowTolerancenumber
metersWithoutOptionsnumber
maxPercentagenumber
minPercentagenumber
maxDrivingTimenumber
finishOnLastCheckpointStepboolean
forceShowLastCheckpointNextboolean
organizationIdstring

Example request

{
  "checkpointDefinitions": [
    {
      "steps": [
        {
          "name": "Ingreso a CD",
          "icon": "Entry",
          "normalDuration": "PT20M",
          "minDuration": "PT30M",
          "maxDuration": "PT20M"
        }
      ]
    }
  ]
}

Response

idstring required
organizationIdstring required
organizationsstring[] required
namestring required
localestring required
tripLifetimestring required
tripStartedLifetimestring required
ttlFinishedTripsstring required
delayedYellowstring required
delayedRedstring required
pendingColorstring required
finishedColorstring required
minPercentagenumber required
maxPercentagenumber required
maxDrivingTimenumber required
restingTimenumber required
drivingTimeWindowTolerancenumber required
metersWithoutOptionsnumber required
finishOnLastCheckpointStepboolean required
forceShowLastCheckpointNextboolean required