# \MasterDataApi
All URIs are relative to *https://s3p-osdm.cloud.sqills.com*
[**get_coach_deck_layout**](MasterDataApi.md#get_coach_deck_layout) | **GET** /coach-deck-layouts/{layoutId} | Returns a coach deck layout for a provided id.
[**get_coach_deck_layouts**](MasterDataApi.md#get_coach_deck_layouts) | **GET** /coach-deck-layouts | Returns all coach deck layouts.
[**get_coach_layouts**](MasterDataApi.md#get_coach_layouts) | **GET** /coach-layouts | Returns all coach layouts.
[**get_coach_layouts_layout_id**](MasterDataApi.md#get_coach_layouts_layout_id) | **GET** /coach-layouts/{layoutId} | Returns a coach layout for a provided id.
[**get_passenger_categories**](MasterDataApi.md#get_passenger_categories) | **GET** /passenger-categories | Returns all defined passenger categories.
[**get_places**](MasterDataApi.md#get_places) | **GET** /places | Returns all places.
[**get_product_tags**](MasterDataApi.md#get_product_tags) | **GET** /product-tags | Returns all product tags and their grouping.
[**get_products**](MasterDataApi.md#get_products) | **GET** /products | Returns all products.
[**get_products_id**](MasterDataApi.md#get_products_id) | **GET** /products/{productId} | Returns a product for the provided id.
[**get_reduction_cards**](MasterDataApi.md#get_reduction_cards) | **GET** /reduction-cards | Returns all reduction card definitions.
[**get_zones**](MasterDataApi.md#get_zones) | **GET** /zones | Returns all zone definitions.
## get_coach_deck_layout
> models::CoachDeckLayoutResponse get_coach_deck_layout(layout_id, requestor, traceparent, tracestate, x_accept_namespace)
Returns a coach deck layout for a provided id.
Retrieve a coach layout description needed for graphical reservation for a given layout id.
### Parameters
**layout_id** | **String** | id of the layout | [required] |
**requestor** | Option<**String**> | The requestor header contains detailed information about who is calling the API. It can include information such as channel, organization, sales unit or workstation id and be used to configure e.g. the fare range provided to the caller. The content of the string is part of a bilateral contract by the two parties and not standardized by OSDM. It is recommend to encrypt the information transferred. | |
**traceparent** | Option<**String**> | The traceparent header describes the position of the incoming request in its trace graph in a portable, fixed-length format. Its design focuses on fast parsing. Every tracing tool MUST properly set traceparent even when it only relies on vendor-specific information in tracestate (see W3C Trace Context). | |
**tracestate** | Option<**String**> | The tracestate extends traceparent with vendor-specific data represented by a set of name/value pairs. Storing information in tracestate is optional (see W3C Trace Context). | |
**x_accept_namespace** | Option<**String**> | The x-accept-namespace HTTP header indicates the URN namespace that the client prefers. The provider uses content-negotiation to apply the corresponding namespace(s) where applicable. | |
### Return type
[**models::CoachDeckLayoutResponse**](CoachDeckLayoutResponse.md)
### Authorization
[oAuth2ClientCredentials](../README.md#oAuth2ClientCredentials)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, application/problem+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_coach_deck_layouts
> models::CoachDeckLayoutCollectionResponse get_coach_deck_layouts(requestor, traceparent, tracestate, if_none_match, x_accept_namespace)
Returns all coach deck layouts.
Retrieve the coach layout description needed for graphical reservation. The coach layouts can either be retrieved as a complete list or specificity for a train identified via offerId and reservationId or fareId
### Parameters
**requestor** | Option<**String**> | The requestor header contains detailed information about who is calling the API. It can include information such as channel, organization, sales unit or workstation id and be used to configure e.g. the fare range provided to the caller. The content of the string is part of a bilateral contract by the two parties and not standardized by OSDM. It is recommend to encrypt the information transferred. | |
**traceparent** | Option<**String**> | The traceparent header describes the position of the incoming request in its trace graph in a portable, fixed-length format. Its design focuses on fast parsing. Every tracing tool MUST properly set traceparent even when it only relies on vendor-specific information in tracestate (see W3C Trace Context). | |
**tracestate** | Option<**String**> | The tracestate extends traceparent with vendor-specific data represented by a set of name/value pairs. Storing information in tracestate is optional (see W3C Trace Context). | |
**if_none_match** | Option<**String**> | The HTTP If-None-Match is used to check whether the providing system has a newer version of the requested data. | |
**x_accept_namespace** | Option<**String**> | The x-accept-namespace HTTP header indicates the URN namespace that the client prefers. The provider uses content-negotiation to apply the corresponding namespace(s) where applicable. | |
### Return type
[**models::CoachDeckLayoutCollectionResponse**](CoachDeckLayoutCollectionResponse.md)
### Authorization
[oAuth2ClientCredentials](../README.md#oAuth2ClientCredentials)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, application/problem+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_coach_layouts
> models::CoachLayoutCollectionResponse get_coach_layouts(requestor, accept_language, traceparent, tracestate, x_accept_namespace, page)
Returns all coach layouts.
Retrieve the coach layout description needed for graphical reservation. The coach layouts can either be retrieved as a complete list or specificity for a train identified via offerId and reservationId or fareId. <br><br> Deprecated: Substituted by getCoachDeckLayouts (since: 3.5.0, removed with: 4.0.0)
### Parameters
**requestor** | Option<**String**> | The requestor header contains detailed information about who is calling the API. It can include information such as channel, organization, sales unit or workstation id and be used to configure e.g. the fare range provided to the caller. The content of the string is part of a bilateral contract by the two parties and not standardized by OSDM. It is recommend to encrypt the information transferred. | |
**accept_language** | Option<**String**> | Describes the set of natural languages that are preferred for localized text in the response to the request (see RFC9110). Supporting English (en) is a must. | |
**traceparent** | Option<**String**> | The traceparent header describes the position of the incoming request in its trace graph in a portable, fixed-length format. Its design focuses on fast parsing. Every tracing tool MUST properly set traceparent even when it only relies on vendor-specific information in tracestate (see W3C Trace Context). | |
**tracestate** | Option<**String**> | The tracestate extends traceparent with vendor-specific data represented by a set of name/value pairs. Storing information in tracestate is optional (see W3C Trace Context). | |
**x_accept_namespace** | Option<**String**> | The x-accept-namespace HTTP header indicates the URN namespace that the client prefers. The provider uses content-negotiation to apply the corresponding namespace(s) where applicable. | |
**page** | Option<**String**> | | |
### Return type
[**models::CoachLayoutCollectionResponse**](CoachLayoutCollectionResponse.md)
### Authorization
[oAuth2ClientCredentials](../README.md#oAuth2ClientCredentials)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, application/problem+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_coach_layouts_layout_id
> models::CoachLayoutResponse get_coach_layouts_layout_id(layout_id, requestor, accept_language, traceparent, tracestate, x_accept_namespace)
Returns a coach layout for a provided id.
Retrieve a coach layout description needed for graphical reservation for a given layout id. <br><br> Deprecated: Substituted by getCoachDeckLayout (since: 3.5.0, removed with: 4.0.0)
### Parameters
**layout_id** | **String** | id of the layout | [required] |
**requestor** | Option<**String**> | The requestor header contains detailed information about who is calling the API. It can include information such as channel, organization, sales unit or workstation id and be used to configure e.g. the fare range provided to the caller. The content of the string is part of a bilateral contract by the two parties and not standardized by OSDM. It is recommend to encrypt the information transferred. | |
**accept_language** | Option<**String**> | Describes the set of natural languages that are preferred for localized text in the response to the request (see RFC9110). Supporting English (en) is a must. | |
**traceparent** | Option<**String**> | The traceparent header describes the position of the incoming request in its trace graph in a portable, fixed-length format. Its design focuses on fast parsing. Every tracing tool MUST properly set traceparent even when it only relies on vendor-specific information in tracestate (see W3C Trace Context). | |
**tracestate** | Option<**String**> | The tracestate extends traceparent with vendor-specific data represented by a set of name/value pairs. Storing information in tracestate is optional (see W3C Trace Context). | |
**x_accept_namespace** | Option<**String**> | The x-accept-namespace HTTP header indicates the URN namespace that the client prefers. The provider uses content-negotiation to apply the corresponding namespace(s) where applicable. | |
### Return type
[**models::CoachLayoutResponse**](CoachLayoutResponse.md)
### Authorization
[oAuth2ClientCredentials](../README.md#oAuth2ClientCredentials)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, application/problem+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_passenger_categories
> Vec<models::PassengerCategory> get_passenger_categories(requestor, accept_language, traceparent, tracestate)
Returns all defined passenger categories.
Provider may *optionally* define passenger categories. These are usually intended for frontend (UI) usage instead of full passenger specification entry when provider works with unified list of passenger categories. For precise entry, or when PassengerCategory is not defined, the full passenger specification must always be supported by the provider.
### Parameters
**requestor** | Option<**String**> | The requestor header contains detailed information about who is calling the API. It can include information such as channel, organization, sales unit or workstation id and be used to configure e.g. the fare range provided to the caller. The content of the string is part of a bilateral contract by the two parties and not standardized by OSDM. It is recommend to encrypt the information transferred. | |
**accept_language** | Option<**String**> | Describes the set of natural languages that are preferred for localized text in the response to the request (see RFC9110). Supporting English (en) is a must. | |
**traceparent** | Option<**String**> | The traceparent header describes the position of the incoming request in its trace graph in a portable, fixed-length format. Its design focuses on fast parsing. Every tracing tool MUST properly set traceparent even when it only relies on vendor-specific information in tracestate (see W3C Trace Context). | |
**tracestate** | Option<**String**> | The tracestate extends traceparent with vendor-specific data represented by a set of name/value pairs. Storing information in tracestate is optional (see W3C Trace Context). | |
### Return type
[**Vec<models::PassengerCategory>**](PassengerCategory.md)
### Authorization
[oAuth2ClientCredentials](../README.md#oAuth2ClientCredentials)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, application/problem+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_places
> models::PlaceResponse get_places(requestor, accept_language, traceparent, tracestate, if_none_match, x_accept_namespace, page)
Returns all places.
### Parameters
**requestor** | Option<**String**> | The requestor header contains detailed information about who is calling the API. It can include information such as channel, organization, sales unit or workstation id and be used to configure e.g. the fare range provided to the caller. The content of the string is part of a bilateral contract by the two parties and not standardized by OSDM. It is recommend to encrypt the information transferred. | |
**accept_language** | Option<**String**> | Describes the set of natural languages that are preferred for localized text in the response to the request (see RFC9110). Supporting English (en) is a must. | |
**traceparent** | Option<**String**> | The traceparent header describes the position of the incoming request in its trace graph in a portable, fixed-length format. Its design focuses on fast parsing. Every tracing tool MUST properly set traceparent even when it only relies on vendor-specific information in tracestate (see W3C Trace Context). | |
**tracestate** | Option<**String**> | The tracestate extends traceparent with vendor-specific data represented by a set of name/value pairs. Storing information in tracestate is optional (see W3C Trace Context). | |
**if_none_match** | Option<**String**> | The HTTP If-None-Match is used to check whether the providing system has a newer version of the requested data. | |
**x_accept_namespace** | Option<**String**> | The x-accept-namespace HTTP header indicates the URN namespace that the client prefers. The provider uses content-negotiation to apply the corresponding namespace(s) where applicable. | |
**page** | Option<**String**> | | |
### Return type
[**models::PlaceResponse**](PlaceResponse.md)
### Authorization
[oAuth2ClientCredentials](../README.md#oAuth2ClientCredentials)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, application/problem+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_product_tags
> models::ProductTagsResponse get_product_tags(requestor, accept_language, traceparent, tracestate, x_accept_namespace)
Returns all product tags and their grouping.
### Parameters
**requestor** | Option<**String**> | The requestor header contains detailed information about who is calling the API. It can include information such as channel, organization, sales unit or workstation id and be used to configure e.g. the fare range provided to the caller. The content of the string is part of a bilateral contract by the two parties and not standardized by OSDM. It is recommend to encrypt the information transferred. | |
**accept_language** | Option<**String**> | Describes the set of natural languages that are preferred for localized text in the response to the request (see RFC9110). Supporting English (en) is a must. | |
**traceparent** | Option<**String**> | The traceparent header describes the position of the incoming request in its trace graph in a portable, fixed-length format. Its design focuses on fast parsing. Every tracing tool MUST properly set traceparent even when it only relies on vendor-specific information in tracestate (see W3C Trace Context). | |
**tracestate** | Option<**String**> | The tracestate extends traceparent with vendor-specific data represented by a set of name/value pairs. Storing information in tracestate is optional (see W3C Trace Context). | |
**x_accept_namespace** | Option<**String**> | The x-accept-namespace HTTP header indicates the URN namespace that the client prefers. The provider uses content-negotiation to apply the corresponding namespace(s) where applicable. | |
### Return type
[**models::ProductTagsResponse**](ProductTagsResponse.md)
### Authorization
[oAuth2ClientCredentials](../README.md#oAuth2ClientCredentials)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, application/problem+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_products
> models::ProductCollectionResponse get_products(requestor, accept_language, traceparent, tracestate, x_accept_namespace, page, product_code, issuing_date, travel_date)
Returns all products.
### Parameters
**requestor** | Option<**String**> | The requestor header contains detailed information about who is calling the API. It can include information such as channel, organization, sales unit or workstation id and be used to configure e.g. the fare range provided to the caller. The content of the string is part of a bilateral contract by the two parties and not standardized by OSDM. It is recommend to encrypt the information transferred. | |
**accept_language** | Option<**String**> | Describes the set of natural languages that are preferred for localized text in the response to the request (see RFC9110). Supporting English (en) is a must. | |
**traceparent** | Option<**String**> | The traceparent header describes the position of the incoming request in its trace graph in a portable, fixed-length format. Its design focuses on fast parsing. Every tracing tool MUST properly set traceparent even when it only relies on vendor-specific information in tracestate (see W3C Trace Context). | |
**tracestate** | Option<**String**> | The tracestate extends traceparent with vendor-specific data represented by a set of name/value pairs. Storing information in tracestate is optional (see W3C Trace Context). | |
**x_accept_namespace** | Option<**String**> | The x-accept-namespace HTTP header indicates the URN namespace that the client prefers. The provider uses content-negotiation to apply the corresponding namespace(s) where applicable. | |
**page** | Option<**String**> | | |
**product_code** | Option<**String**> | the product code | |
**issuing_date** | Option<**String**> | To be used in combination with a productCode. Is the issuing date to take into account for product definition. If none is provided, today is assumed. | |
**travel_date** | Option<**String**> | To be used in combination with a productCode. Is the travel date to take into account for product definition. If none is provided, today is assumed. | |
### Return type
[**models::ProductCollectionResponse**](ProductCollectionResponse.md)
### Authorization
[oAuth2ClientCredentials](../README.md#oAuth2ClientCredentials)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, application/problem+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_products_id
> models::ProductResponse get_products_id(product_id, requestor, accept_language, traceparent, tracestate, x_accept_namespace)
Returns a product for the provided id.
### Parameters
**product_id** | **String** | id of the product to get | [required] |
**requestor** | Option<**String**> | The requestor header contains detailed information about who is calling the API. It can include information such as channel, organization, sales unit or workstation id and be used to configure e.g. the fare range provided to the caller. The content of the string is part of a bilateral contract by the two parties and not standardized by OSDM. It is recommend to encrypt the information transferred. | |
**accept_language** | Option<**String**> | Describes the set of natural languages that are preferred for localized text in the response to the request (see RFC9110). Supporting English (en) is a must. | |
**traceparent** | Option<**String**> | The traceparent header describes the position of the incoming request in its trace graph in a portable, fixed-length format. Its design focuses on fast parsing. Every tracing tool MUST properly set traceparent even when it only relies on vendor-specific information in tracestate (see W3C Trace Context). | |
**tracestate** | Option<**String**> | The tracestate extends traceparent with vendor-specific data represented by a set of name/value pairs. Storing information in tracestate is optional (see W3C Trace Context). | |
**x_accept_namespace** | Option<**String**> | The x-accept-namespace HTTP header indicates the URN namespace that the client prefers. The provider uses content-negotiation to apply the corresponding namespace(s) where applicable. | |
### Return type
[**models::ProductResponse**](ProductResponse.md)
### Authorization
[oAuth2ClientCredentials](../README.md#oAuth2ClientCredentials)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, application/problem+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_reduction_cards
> models::ReductionCardCollectionResponse get_reduction_cards(requestor, accept_language, traceparent, tracestate, x_accept_namespace, page)
Returns all reduction card definitions.
returns a collection of reduction card definitions
### Parameters
**requestor** | Option<**String**> | The requestor header contains detailed information about who is calling the API. It can include information such as channel, organization, sales unit or workstation id and be used to configure e.g. the fare range provided to the caller. The content of the string is part of a bilateral contract by the two parties and not standardized by OSDM. It is recommend to encrypt the information transferred. | |
**accept_language** | Option<**String**> | Describes the set of natural languages that are preferred for localized text in the response to the request (see RFC9110). Supporting English (en) is a must. | |
**traceparent** | Option<**String**> | The traceparent header describes the position of the incoming request in its trace graph in a portable, fixed-length format. Its design focuses on fast parsing. Every tracing tool MUST properly set traceparent even when it only relies on vendor-specific information in tracestate (see W3C Trace Context). | |
**tracestate** | Option<**String**> | The tracestate extends traceparent with vendor-specific data represented by a set of name/value pairs. Storing information in tracestate is optional (see W3C Trace Context). | |
**x_accept_namespace** | Option<**String**> | The x-accept-namespace HTTP header indicates the URN namespace that the client prefers. The provider uses content-negotiation to apply the corresponding namespace(s) where applicable. | |
**page** | Option<**String**> | | |
### Return type
[**models::ReductionCardCollectionResponse**](ReductionCardCollectionResponse.md)
### Authorization
[oAuth2ClientCredentials](../README.md#oAuth2ClientCredentials)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, application/problem+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_zones
> models::ZoneCollectionResponse get_zones(requestor, accept_language, traceparent, tracestate, x_accept_namespace, page)
Returns all zone definitions.
### Parameters
**requestor** | Option<**String**> | The requestor header contains detailed information about who is calling the API. It can include information such as channel, organization, sales unit or workstation id and be used to configure e.g. the fare range provided to the caller. The content of the string is part of a bilateral contract by the two parties and not standardized by OSDM. It is recommend to encrypt the information transferred. | |
**accept_language** | Option<**String**> | Describes the set of natural languages that are preferred for localized text in the response to the request (see RFC9110). Supporting English (en) is a must. | |
**traceparent** | Option<**String**> | The traceparent header describes the position of the incoming request in its trace graph in a portable, fixed-length format. Its design focuses on fast parsing. Every tracing tool MUST properly set traceparent even when it only relies on vendor-specific information in tracestate (see W3C Trace Context). | |
**tracestate** | Option<**String**> | The tracestate extends traceparent with vendor-specific data represented by a set of name/value pairs. Storing information in tracestate is optional (see W3C Trace Context). | |
**x_accept_namespace** | Option<**String**> | The x-accept-namespace HTTP header indicates the URN namespace that the client prefers. The provider uses content-negotiation to apply the corresponding namespace(s) where applicable. | |
**page** | Option<**String**> | | |
### Return type
[**models::ZoneCollectionResponse**](ZoneCollectionResponse.md)
### Authorization
[oAuth2ClientCredentials](../README.md#oAuth2ClientCredentials)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, application/problem+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)