osdm-sys 0.1.0-alpha.1

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

Rust API client for OSDM

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:

For more information, please visit https://osdm.io

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 3.7.0
  • Generator version: 7.17.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Documentation for API Endpoints

Class Method HTTP request Description
AvailabilitiesApi get_availabilities_continuous_services POST /availabilities/on-demand-services Get availabilities of an on-demand service.
AvailabilitiesApi get_availabilities_nearby GET /availabilities/nearby Get availabilities nearby a given place.
AvailabilitiesApi get_availabilities_place_map GET /availabilities/place-map Get place map including availabilities.
AvailabilitiesApi get_availabilities_place_maps POST /availabilities/place-map Get multiple place maps including availabilities.
AvailabilitiesApi get_availabilities_preferences GET /availabilities/preferences Get availabilities for a set of preferences.
AvailabilitiesApi get_availabilities_vehicle_place_map POST /availabilities/vehicle-place-map Get a place map for a requested vehicle including availabilities.
BookedOffersApi delete_booking_booked_offers_id DELETE /bookings/{bookingId}/booked-offers/{bookedOfferId} Delete a bookedOffer from a booking.
BookedOffersApi delete_booking_booked_offers_id_passenger_id DELETE /bookings/{bookingId}/booked-offers/{offerId}/passengers/{passengerId} Delete a passenger from bookedOffer of a booking.
BookedOffersApi get_booking_booked_offers_id GET /bookings/{bookingId}/booked-offers/{bookedOfferId} Gets a bookedOffer of a booking.
BookedOffersApi post_booking_booked_offers POST /bookings/{bookingId}/booked-offers Creates bookedOffers from offers and adds them in a booking.
BookingDocumentsApi create_documents POST /bookings/{bookingId}/documents Allows adding a document to a booking.
BookingDocumentsApi delete_bookings_documents_id DELETE /bookings/{bookingId}/documents/{documentId} Delete a document from a booking.
BookingDocumentsApi get_document GET /bookings/{bookingId}/documents/{documentId} Returns a booking document.
BookingPartApi create_booking_booked_offers_ancillaries POST /bookings/{bookingId}/booked-offers/{bookedOfferId}/ancillaries Adds an ancillary not previously added from offer to a booking.
BookingPartApi create_booking_booked_offers_parts POST /bookings/{bookingId}/booked-offers/{bookedOfferId}/offer-parts Adds a reservation or ancillary not previously added from offer to a booking.
BookingPartApi create_booking_booked_offers_reservations POST /bookings/{bookingId}/booked-offers/{bookedOfferId}/reservations Adds a reservation not previously added from offer to a booking.
BookingPartApi delete_booking_booked_offers_admission DELETE /bookings/{bookingId}/booked-offers/{bookedOfferId}/admissions/{admissionId} Removes an admission from a booking. In case the admission is not confirmed. On a confirmed admission use the refund.
BookingPartApi delete_booking_booked_offers_ancillary DELETE /bookings/{bookingId}/booked-offers/{bookedOfferId}/ancillaries/{ancillaryId} Removes an ancillary from a booking in case the ancillary is not jet confirmed. On confirmed ancillaries use the refund.
BookingPartApi delete_booking_booked_offers_parts DELETE /bookings/{bookingId}/booked-offers/{bookedOfferId}/offer-parts Removes reservations or ancillaries from a booking in case the parts were not yet confirmed. On confirmed reservations use the refund.
BookingPartApi delete_booking_booked_offers_reservations DELETE /bookings/{bookingId}/booked-offers/{bookedOfferId}/reservations/{reservationId} Removes a reservation from a booking in case the reservation was not yet confirmed. On confirmed reservations use the refund.
BookingsApi delete_bookings_id DELETE /bookings/{bookingId} Deletes a booking.
BookingsApi get_bookings_id GET /bookings/{bookingId} Returns a booking.
BookingsApi get_bookings_id_history GET /bookings/{bookingId}/history Returns the history of changes to a booking.
BookingsApi post_booking_cleanup POST /bookings/{bookingId}/cleanup Performs a complete cleanup of a booking in a single step
BookingsApi post_bookings POST /bookings Creates a booking based on a previously requested offer.
BookingsApi update_booking PATCH /bookings/{bookingId} Updates a booking but does not confirm the booking.
BookingsSearchApi search_bookings POST /bookings-search Search for bookings based on search parameters.
BookingsSplitApi split_bookings POST /bookings/{bookingId}/split Split a booking into multiple bookings.
CancelFulfillmentsApi delete_cancel_fulfillment_offers DELETE /bookings/{bookingId}/cancel-fulfillments-offers/{cancelFulfillmentsOfferId} Deletes a cancel fulfillments offer without waiting for expiry.
CancelFulfillmentsApi get_cancel_fulfillment_offers GET /bookings/{bookingId}/cancel-fulfillments-offers/{cancelFulfillmentsOfferId} Returns the cancel fulfillments offer for the ids provided.
CancelFulfillmentsApi patch_cancel_fulfillments_offers PATCH /bookings/{bookingId}/cancel-fulfillments-offers/{cancelFulfillmentsOfferId} Allows to accept and confirm a cancel fulfillments offer.
CancelFulfillmentsApi post_cancel_fulfillments_offers POST /bookings/{bookingId}/cancel-fulfillments-offers Initiates a cancel fulfillments process
ComplaintManagementApi create_complaint POST /complaints Allows adding a complaint.
ComplaintManagementApi get_complaint GET /complaints/{complaintId} Returns a complaint.
ComplaintManagementApi patch_complaint PATCH /complaints/{complaintId} Allows updating a complaint.
ExchangeApi create_bookings_exchange_operations POST /bookings/{bookingId}/exchange-operations Pre-books an exchangeOffer as part of an exchange operation.
ExchangeApi create_exchange_offers_collection POST /bookings/{bookingId}/exchange-offers Returns exchange offers for specified fulfillments
ExchangeApi delete_bookings_exchange_operation DELETE /bookings/{bookingId}/exchange-operations/{exchangeOperationId} Cancels an ongoing exchange operation in provisional state.
ExchangeApi get_bookings_exchange_operations GET /bookings/{bookingId}/exchange-operations/{exchangeOperationId} Returns the exchange operation with the id provided.
ExchangeApi update_bookings_exchange_operations PATCH /bookings/{bookingId}/exchange-operations/{exchangeOperationId} Allows to update an ongoing exchange operation.
FulfillmentsApi finalize_fulfillments PATCH /bookings/{bookingId}/fulfillments Optionally finalizes the fulfillments in asynchronous mode.
FulfillmentsApi get_check_fulfillments GET /bookings/{bookingId}/fulfillment-check Verification step (step 1 in a two phase commit process) to run before the effective fulfillment endpoint. Provider do all checks to "guarantee" that fullfillment will work.
FulfillmentsApi get_continuous_service_usage_id GET /fulfillments/{fulfillmentId}/continuous-service-usage/{continuousServiceUsageId} return the continuous service usage including latest updates
FulfillmentsApi get_fulfillment_id GET /fulfillments/{fulfillmentId} Returns the fulfillment, aka. ticket for the provided id.
FulfillmentsApi 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
FulfillmentsApi patch_fulfillment_id PATCH /fulfillments/{fulfillmentId} Activates a fulfillment, i.e. changes the status from AVAILABLE to FULFILLED.
FulfillmentsApi post_fulfillments POST /bookings/{bookingId}/fulfillments Confirms the booking a triggers the fulfillment of the booking synchronously or asynchronously.
MasterDataApi get_coach_deck_layout GET /coach-deck-layouts/{layoutId} Returns a coach deck layout for a provided id.
MasterDataApi get_coach_deck_layouts GET /coach-deck-layouts Returns all coach deck layouts.
MasterDataApi get_coach_layouts GET /coach-layouts Returns all coach layouts.
MasterDataApi get_coach_layouts_layout_id GET /coach-layouts/{layoutId} Returns a coach layout for a provided id.
MasterDataApi get_passenger_categories GET /passenger-categories Returns all defined passenger categories.
MasterDataApi get_places GET /places Returns all places.
MasterDataApi get_product_tags GET /product-tags Returns all product tags and their grouping.
MasterDataApi get_products GET /products Returns all products.
MasterDataApi get_products_id GET /products/{productId} Returns a product for the provided id.
MasterDataApi get_reduction_cards GET /reduction-cards Returns all reduction card definitions.
MasterDataApi get_zones GET /zones Returns all zone definitions.
OfferOverviewApi get_offer_overview_route POST /offer-overview-route Returns an overview of prices based on route
OfferOverviewApi get_offer_overview_trip POST /offer-overview-trip Returns an overview of prices based on trips
OffersApi create_offers POST /offers Returns offers for trips or trip search criteria.
OffersApi get_booking_booked_offers_additional_offers GET /bookings/{bookingId}/booked-offers/{bookedOfferId}/additional-offers Get additional offers of booked offer for a given booking. A provider can decide to allow or reject additional offers admissions, reservations or ancillaries on an confirmed booking.
OnDemandServicesApi get_availabilities_continuous_services POST /availabilities/on-demand-services Get availabilities of an on-demand service.
OnDemandServicesApi get_continuous_service_usage_id GET /fulfillments/{fulfillmentId}/continuous-service-usage/{continuousServiceUsageId} return the continuous service usage including latest updates
OnDemandServicesApi 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
OnHoldApi confirm_on_hold_offer PATCH /bookings/{bookingId}/on-hold-offer/{onHoldOfferId} Confirms the on hold offer.
OnHoldApi create_on_hold_offer POST /bookings/{bookingId}/on-hold-offer Creates an on hold offer.
OnHoldApi delete_on_hold_offer DELETE /bookings/{bookingId}/on-hold-offer/{onHoldOfferId} Deletes the on hold offer
PassengerCategoriesApi get_passenger_categories GET /passenger-categories Returns all defined passenger categories.
PassengersApi get_booking_passengers GET /bookings/{bookingId}/passengers Returns all the passenger's in the booking.
PassengersApi get_booking_passengers_id GET /bookings/{bookingId}/passengers/{passengerId} Returns the passenger's information at booking step.
PassengersApi patch_booking_passenger PATCH /bookings/{bookingId}/passengers/{passengerId} Allows updating a passenger's information at booking step.
PassengersApi patch_booking_passengers PATCH /bookings/{bookingId}/passengers Allows updating a set of passengers in a batch at booking step.
PlacesApi get_places_id GET /places/{placeId} returns a place
PlacesApi post_places POST /places returns place information for a given place request
ProductApi get_product_tags GET /product-tags Returns all product tags and their grouping.
ProductApi get_products GET /products Returns all products.
ProductApi get_products_id GET /products/{productId} Returns a product for the provided id.
ProductApi search_products POST /products-search Search for products based on search parameters.
PurchaserApi get_booking_purchaser GET /bookings/{bookingId}/purchaser Returns the purchaser's information at booking step.
PurchaserApi patch_booking_purchaser PATCH /bookings/{bookingId}/purchaser Allows updating a purchaser's information at booking step.
PurchaserApi post_booking_purchaser POST /bookings/{bookingId}/purchaser Allows creating a purchaser for a booking already existing.
RefundApi delete_refund_offers DELETE /bookings/{bookingId}/refund-offers/{refundOfferId} Deletes a refundOffer without waiting for expiry.
RefundApi get_refund_offers GET /bookings/{bookingId}/refund-offers/{refundOfferId} Returns the refund offer for the ids provided.
RefundApi patch_refund_offers PATCH /bookings/{bookingId}/refund-offers/{refundOfferId} Allows to accept and confirm a refund offer.
RefundApi post_prepare_refund_offers GET /bookings/{bookingId}/refund-offers/{refundOfferId}/confirmation-check Validation step (step 1 in a two phase commit process) to run before the effective patch endpoint. Provider do all checks to "guarantee" that refund will work.
RefundApi post_refund_offers POST /bookings/{bookingId}/refund-offers Initiates a refund process by creating a refundOffer resource.
ReimbursementManagementApi create_reimbursement POST /bookings/{bookingId}/reimbursements Create reimbursement for a booking.
ReimbursementManagementApi get_reimbursement GET /bookings/{bookingId}/reimbursements/{reimbursementId} Get reimbursement of a booking.
ReimbursementManagementApi update_reimbursement PATCH /bookings/{bookingId}/reimbursements/{reimbursementId} Update reimbursement of a booking.
ReleaseApi delete_release_offers DELETE /bookings/{bookingId}/release-offers/{releaseOfferId} Deletes a release offer without waiting for expiry.
ReleaseApi get_release_offer GET /bookings/{bookingId}/release-offers/{releaseOfferId} Returns the release offer for the ids provided.
ReleaseApi patch_release_offers PATCH /bookings/{bookingId}/release-offers/{releaseOfferId} Allows to accept and confirm a release offer. When accepted, all associated admissions are invalidated and reserved seats are released. The obtain money refund, refund offer must be used at later stage.
ReleaseApi post_release_offers POST /bookings/{bookingId}/release-offers Initiates a release process by creating a releaseOffers resource.
SearchApi search_bookings POST /bookings-search Search for bookings based on search parameters.
SearchApi search_products POST /products-search Search for products based on search parameters.
TravelAccountApi get_travel_accounts GET /travel-accounts Returns a travel account.
TripsApi get_trips_collection_id GET /trips-collections/{tripsCollectionId} Returns a collection of trips.
TripsApi get_trips_id GET /trips/{tripId} Returns a trip element representing a travel trip.
TripsApi post_trips POST /trips-collection returns a collection of trips for a given OJP trip request
TripsApi post_trips_change POST /trips Returns a new trip for given OJP parameters based on an already existing trip
VersionsApi get_versions GET /versions Returns all available versions of the OSDM API.

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

osdm@uic.org