stdcm

This function computes a STDCM and returns the result.

Changed on

It first checks user authorization, then retrieves timetable, infrastructure, train schedules, and rolling stock data, and runs train simulations. The result contains the simulation output based on the train schedules and infrastructure provided.

post/timetable/{id}/stdcm

Request

  • Base URL: https://demo.osrd.fr/api
  • URL: https://demo.osrd.fr/api/timetable/{id}/stdcm
  • Auth: none declared

Path parameters

idinteger required

timetable_id

Query parameters

infrainteger required

The infra id

Headers

x-osrd-stdcm-fallbackboolean nullable

Whether this request is a fallback, sent after an initial request failed to find a path

Request body

allowed_track_sectionsstring[]

Set of authorized track section ids, empty means no restriction

comfort'STANDARD' | 'AIR_CONDITIONING' | 'HEATING' required
electrical_profile_set_idinteger nullable
marginstring nullable

Can be a percentage X%, a time in minutes per 100 kilometer Xmin/100km

maximum_departure_delayinteger nullable

By how long we can shift the departure time in milliseconds Deprecated, first step data should be used instead

maximum_run_timeinteger nullable

Specifies how long the total run time can be in milliseconds Deprecated, first step data should be used instead

start_timestring date-time nullable

Deprecated, first step arrival time should be used instead

temporary_speed_limit_group_idinteger nullable
time_gap_afterinteger

Margin after the train passage in milliseconds

Enforces that the path used by the train should be free and available at least that many milliseconds after its passage.

time_gap_beforeinteger

Margin before the train passage in seconds

Enforces that the path used by the train should be free and available at least that many milliseconds before its passage.

work_schedule_group_idinteger nullable

Response

The simulation result

OR

Changes

  • 2164e74a5225Revision changes
    • info

      added the new optional header request parameter x-osrd-stdcm-fallback

  • 4854917a0aceRevision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status