osdm-sys 0.1.0-alpha.3

Specifications for the OSDM API standard. The OSDM specification supports two modes of operation: Retailer Mode and Distributor Mode. The API works identically in both modes, except that in distributor mode the API also returns fare information. The following resources are key to get started: - [Processes](https://osdm.io/spec/processes/) - [Models](https://osdm.io/spec/models/) - [Getting started](https://osdm.io/spec/getting-started/)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234

# \AvailabilitiesApi

All URIs are relative to *https://s3p-osdm.cloud.sqills.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_availabilities_continuous_services**](AvailabilitiesApi.md#get_availabilities_continuous_services) | **POST** /availabilities/on-demand-services | Get availabilities of an on-demand service.
[**get_availabilities_nearby**](AvailabilitiesApi.md#get_availabilities_nearby) | **GET** /availabilities/nearby | Get availabilities nearby a given place.
[**get_availabilities_place_map**](AvailabilitiesApi.md#get_availabilities_place_map) | **GET** /availabilities/place-map | Get place map including availabilities.
[**get_availabilities_place_maps**](AvailabilitiesApi.md#get_availabilities_place_maps) | **POST** /availabilities/place-map | Get multiple place maps including availabilities.
[**get_availabilities_preferences**](AvailabilitiesApi.md#get_availabilities_preferences) | **GET** /availabilities/preferences | Get availabilities for a set of preferences.
[**get_availabilities_vehicle_place_map**](AvailabilitiesApi.md#get_availabilities_vehicle_place_map) | **POST** /availabilities/vehicle-place-map | Get a place map for a requested vehicle including availabilities.



## get_availabilities_continuous_services

> models::ContinuousServicesAvailabilityResponse get_availabilities_continuous_services(context_id, context_type, resource_id, resource_type, continuous_service_availability_scope, requestor, accept_language, traceparent, tracestate)
Get availabilities of an on-demand service.

Get availabilities of an on-demand services. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**context_id** | **String** |  | [required] |
**context_type** | [**ContextType**](.md) |  | [required] |
**resource_id** | **String** |  | [required] |
**resource_type** | [**ResourceType**](.md) |  | [required] |
**continuous_service_availability_scope** | [**ContinuousServiceAvailabilityScope**](ContinuousServiceAvailabilityScope.md) |  | [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).  |  |

### Return type

[**models::ContinuousServicesAvailabilityResponse**](ContinuousServicesAvailabilityResponse.md)

### Authorization

[oAuth2ClientCredentials](../README.md#oAuth2ClientCredentials)

### HTTP request headers

- **Content-Type**: application/json
- **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_availabilities_nearby

> models::PlaceAvailabilityCollectionResponse get_availabilities_nearby(context_id, context_type, resource_id, resource_type, coach_number, place_number, requestor, accept_language, traceparent, tracestate)
Get availabilities nearby a given place.

Get availabilities nearby a given place. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**context_id** | **String** | denotes the offerId when contextType is OFFER, bookingId when contextType is BOOKING  | [required] |
**context_type** | [**ContextType**](.md) |  | [required] |
**resource_id** | **String** | denotes the reservationId wen resourceType is RESERVATION, fareId when resourceType is FARE  | [required] |
**resource_type** | [**ResourceType**](.md) |  | [required] |
**coach_number** | **String** | coach number of the referenced place  | [required] |
**place_number** | **String** | place number of the referenced place  | [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).  |  |

### Return type

[**models::PlaceAvailabilityCollectionResponse**](PlaceAvailabilityCollectionResponse.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_availabilities_place_map

> models::PlaceAvailabilityResponse get_availabilities_place_map(context_id, context_type, resource_id, resource_type, requestor, accept_language, traceparent, tracestate)
Get place map including availabilities.

Get place map including availabilities. <br><br> Deprecated: Substituted by getAvailabilitiesVehiclePlaceMap (since: 3.5.0, removed with: 4.0.0) 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**context_id** | **String** |  | [required] |
**context_type** | [**ContextType**](.md) |  | [required] |
**resource_id** | **String** |  | [required] |
**resource_type** | [**ResourceType**](.md) |  | [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).  |  |

### Return type

[**models::PlaceAvailabilityResponse**](PlaceAvailabilityResponse.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_availabilities_place_maps

> Vec<models::PlaceAvailability> get_availabilities_place_maps(availability_scope, requestor, accept_language, traceparent, tracestate)
Get multiple place maps including availabilities.

Get multiple place maps including availabilities. <br><br> Deprecated: Substituted by getAvailabilitiesVehiclePlaceMap (since: 3.5.0, removed with: 4.0.0) 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**availability_scope** | [**AvailabilityScope**](AvailabilityScope.md) |  | [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).  |  |

### Return type

[**Vec<models::PlaceAvailability>**](PlaceAvailability.md)

### Authorization

[oAuth2ClientCredentials](../README.md#oAuth2ClientCredentials)

### HTTP request headers

- **Content-Type**: application/json
- **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_availabilities_preferences

> models::PlaceAvailabilityCollectionResponse get_availabilities_preferences(context_id, context_type, resource_id, resource_type, requestor, accept_language, traceparent, tracestate)
Get availabilities for a set of preferences.

Get availabilities for a set of preferences. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**context_id** | **String** |  | [required] |
**context_type** | [**ContextType**](.md) |  | [required] |
**resource_id** | **String** |  | [required] |
**resource_type** | [**ResourceType**](.md) |  | [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).  |  |

### Return type

[**models::PlaceAvailabilityCollectionResponse**](PlaceAvailabilityCollectionResponse.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_availabilities_vehicle_place_map

> models::PlaceAvailabilityMapResponse get_availabilities_vehicle_place_map(place_availability_map_request, requestor, accept_language, traceparent, tracestate, x_accept_namespace)
Get a place map for a requested vehicle including availabilities.

Get a vehicle map including availabilities. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**place_availability_map_request** | [**PlaceAvailabilityMapRequest**](PlaceAvailabilityMapRequest.md) |  | [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::PlaceAvailabilityMapResponse**](PlaceAvailabilityMapResponse.md)

### Authorization

[oAuth2ClientCredentials](../README.md#oAuth2ClientCredentials)

### HTTP request headers

- **Content-Type**: application/json
- **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)