Skip to main content
PUT
Error

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
agencyId
string
required

The agency id.

Pattern: ^[A-Z]{3,6}_[a-zA-Z0-9-._~:@!$,]+$
Example:

"LND_Agency-42"

​
planId
string
required

The plan id. At least one character among those allowed: unaccented alpha-numeric characters, "-", ".", "_", "~", ":", "@", "!", "$", ",".

Pattern: ^[a-zA-Z0-9-._~:@!$,]+$
​
resourceId
string
required

The resource id. At least one character among those allowed: unaccented alpha-numeric characters, "-", ".", "_", "~", ":", "@", "!", "$", ",".

Pattern: ^[a-zA-Z0-9-._~:@!$,]+$

Query Parameters

​
force
boolean
default:false

If true, on an archived item, the requested action will be forced and the item will be unarchived.

Body

application/json

The State to update.

[TO_VALIDATE] Believed to describe a resource's manual-mode state. Needs confirmation.

​
mode
enum<string>
default:free

[TO_VALIDATE] Description pending review by a Kardinal engineer.

Available options:
free,
fixed
​
assignments
object[]

[TO_VALIDATE] Believed to list manually forced stop/break assignments for the resource. Needs confirmation.

The beginTime is set to arrivalTime if not setted. If the stopId is the id of an alternative, arrivalTime, beginTime, and departureTime cannot be set and the chosen alternative stop is optimized by the solver.

Response

State response updated.

[TO_VALIDATE] Description pending review by a Kardinal engineer.

​
item
object

[TO_VALIDATE] Believed to describe a resource's manual-mode state. Needs confirmation.

​
agencyId
string

The agency id.

Pattern: ^[A-Z]{3,6}_[a-zA-Z0-9-._~:@!$,]+$
Example:

"LND_Agency-42"

​
planId
string

The plan id.

Pattern: ^[a-zA-Z0-9-._~:@!$,]+$
Example:

"plan-AB"

​
planVersion
integer
read-only

The plan version.

Required range: x >= 1
Example:

42