--- title: "Return a specific timetable with its associated paced trains" method: GET path: "/timetable/{id}/train_schedules" tags: ["timetable"] --- # Return a specific timetable with its associated paced trains `GET /timetable/{id}/train_schedules` ## Path parameters - `id` integer, required ## Query parameters - `page` integer - `page_size` integer ## Response `200` Timetable with train schedule ids - object — Statistics about a paginated editoast response Provides the pagination settings issued in the request alongside a few convenience fields useful to navigate the paginated results. # Expected usage This struct is meant to be used and flattened in the response of a paginated query. ``` #[derive(Serialize, ToSchema)] struct MyPaginatedResponse { #[schema(flatten)] pagination: PaginationStats, result: Vec, // any other field that makes sense in a paginated response } ``` We named the data field `result` to cope with the old pagination schema which enforced this name. For new paginated responses, the field name is up to your imagination :) - `count` integer, required — The total number of items - `current` integer, required — The current page number - `next` integer, nullable, required — The next page number, if any - `page_count` integer, required — The total number of pages - `page_size` integer, required — The number of items per page - `previous` integer, nullable, required — The previous page number, if any - `results` TrainScheduleResponse[], required - `category` union - object - `main_category` 'HIGH_SPEED_TRAIN' | 'INTERCITY_TRAIN' | 'REGIONAL_TRAIN' | 'NIGHT_TRAIN' | 'COMMUTER_TRAIN' | 'FREIGHT_TRAIN' | 'FAST_FREIGHT_TRAIN' | 'TRAM_TRAIN' | 'TOURISTIC_TRAIN' | 'WORK_TRAIN', required - object - `sub_category_code` string, required - `comfort` 'STANDARD' | 'AIR_CONDITIONING' | 'HEATING' - `constraint_distribution` 'STANDARD' | 'MARECO', required - `initial_speed` number, double - `labels` string[] - `margins` Margins - `boundaries` NonBlankString[], required - `values` string[], required — The values of the margins. Must contains one more element than the boundaries Can be a percentage `X%` or a time in minutes per 100 kilometer `Xmin/100km` - `options` TrainScheduleOptions - `stops_at_end_of_block` boolean - `use_electrical_profiles` boolean - `use_speed_limits_for_simulation` boolean - `path` PathItem[], required - `id` string, required — The unique identifier of the path item. This is used to reference path items in the train schedule. - `location` union, required — The location of a path waypoint - object - `offset` integer, required — Offset in mm - `track` string, required — Track section identifier - `type` 'track_offset', required - object - `local_track_name` string, nullable - `operational_point` union, required - object - … - object - … - object - … - `type` 'operational_point_part_reference', required - `power_restrictions` object[] - `from` string, required - `to` string, required - `value` string, required - `rolling_stock_name` string, required - `schedule` ScheduleItem[] - `arrival` string, duration — Duration in ISO 8601 format (e.g. PT2H for 2 hours) - `at` string, required — Position on the path of the schedule item. - `reception_signal` 'OPEN' | 'STOP' | 'SHORT_SLIP_STOP' — State of the signal where the train is received for its stop. For (important) details, see . - `reference_base_arrival` string, duration — Duration in ISO 8601 format (e.g. PT2H for 2 hours) - `reference_position` integer, nullable - `stop_for` string, duration — Duration in ISO 8601 format (e.g. PT2H for 2 hours) - `speed_limit_tag` string, nullable - `start_time` integer, required — For calendar timetables: elapsed ms since 1970-01-01T00:00:00Z. For hourly timetables: elapsed ms since the timetable start. - `train_name` string, required - `paced` object, nullable - `exceptions` PacedTrainException[], required - `occurrence_index` integer - `constraint_distribution` ConstraintDistributionChangeGroup - `value` 'STANDARD' | 'MARECO', required - `initial_speed` InitialSpeedChangeGroup - `value` number, double, required - `labels` LabelsChangeGroup - `value` string[], required - `options` OptionsChangeGroup - `value` TrainScheduleOptions, required - `stops_at_end_of_block` boolean - `use_electrical_profiles` boolean - `use_speed_limits_for_simulation` boolean - `path_and_schedule` PathAndScheduleChangeGroup - `margins` Margins, required - `boundaries` NonBlankString[], required - `values` string[], required — The values of the margins. Must contains one more element than the boundaries Can be a percentage `X%` or a time in minutes per 100 kilometer `Xmin/100km` - `path` PathItem[], required - `id` string, required — The unique identifier of the path item. This is used to reference path items in the train schedule. - `location` union, required — The location of a path waypoint - … - `power_restrictions` PowerRestrictionItem[], required - `from` string, required - `to` string, required - `value` string, required - `schedule` ScheduleItem[], required - `arrival` string, duration — Duration in ISO 8601 format (e.g. PT2H for 2 hours) - `at` string, required — Position on the path of the schedule item. - `reception_signal` 'OPEN' | 'STOP' | 'SHORT_SLIP_STOP' — State of the signal where the train is received for its stop. For (important) details, see . - `reference_base_arrival` string, duration — Duration in ISO 8601 format (e.g. PT2H for 2 hours) - `reference_position` integer, nullable - `stop_for` string, duration — Duration in ISO 8601 format (e.g. PT2H for 2 hours) - `rolling_stock` RollingStockChangeGroup - `comfort` 'STANDARD' | 'AIR_CONDITIONING' | 'HEATING', required - `rolling_stock_name` string, required - `rolling_stock_category` RollingStockCategoryChangeGroup - `value` union - object - … - object - … - `speed_limit_tag` SpeedLimitTagChangeGroup - `value` string, nullable - `start_time` StartTimeChangeGroup - `value` integer, required — For calendar timetables: elapsed ms since 1970-01-01T00:00:00Z. For hourly timetables: elapsed ms since the timetable start. - `train_name` TrainNameChangeGroup - `value` string, required - `disabled` boolean - `id` integer, nullable — TODO The new exception table id (for incremental migration) - `key` string, required — Unique key for the exception within the paced train, required and generated by the frontend. - `interval` string, duration, required — Duration in ISO 8601 format (e.g. PT2H for 2 hours) - `time_window` string, duration, required — Duration in ISO 8601 format (e.g. PT2H for 2 hours) - `id` integer, required - `train_schedule_set_id` integer, required ## Other responses - `404` — Timetable not found --- [API](https://skmtc.net/openrailassociation/apis/osrd-editoast.md) · [All operations](https://skmtc.net/openrailassociation/apis/osrd-editoast/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openrailassociation/osrd-editoast/versions/1840dbbd64ac/schema)