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

# \OnDemandServicesApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_availabilities_continuous_services**](OnDemandServicesApi.md#get_availabilities_continuous_services) | **POST** /availabilities/on-demand-services | Get availabilities of an on-demand service.
[**get_continuous_service_usage_id**](OnDemandServicesApi.md#get_continuous_service_usage_id) | **GET** /fulfillments/{fulfillmentId}/continuous-service-usage/{continuousServiceUsageId} | return the continuous service usage including latest updates
[**patch_continuous_service_usage_id**](OnDemandServicesApi.md#patch_continuous_service_usage_id) | **PATCH** /fulfillments/{fulfillmentId}/continuous-service-usage/{continuousServiceUsageId} | start or end the usage of a continuous service of an demand vehicle



## 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_continuous_service_usage_id

> models::ContinuousServiceUsage get_continuous_service_usage_id(fulfillment_id, continuous_service_usage_id, requestor, accept_language, traceparent, tracestate, x_accept_namespace)
return the continuous service usage including latest updates

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fulfillment_id** | **String** | id of the fulfillment to get.  | [required] |
**continuous_service_usage_id** | **String** | id of the continuous service usage 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::ContinuousServiceUsage**](ContinuousServiceUsage.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)


## patch_continuous_service_usage_id

> models::ContinuousServiceUsage patch_continuous_service_usage_id(fulfillment_id, continuous_service_usage_id, continuous_service_usage_patch_request, requestor, accept_language, traceparent, tracestate, idempotency_key, x_accept_namespace)
start or end the usage of a continuous service of an demand vehicle

start or end the usage of a continuous service of an demand vehicle 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fulfillment_id** | **String** |  | [required] |
**continuous_service_usage_id** | **String** | id of the continuous service usage to get.  | [required] |
**continuous_service_usage_patch_request** | [**ContinuousServiceUsagePatchRequest**](ContinuousServiceUsagePatchRequest.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).  |  |
**idempotency_key** | Option<**uuid::Uuid**> | The HTTP Idempotency request header field can be used to carry idempotency key in order to make non-idempotent HTTP methods such as POST or PATCH fault-tolerant. Servers should keep the idempotency key for as long as the result of the underlying operation is valid. Idempotency keys should be  globally unique.  |  |
**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::ContinuousServiceUsage**](ContinuousServiceUsage.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)