Skip to content

Latest commit

 

History

History
305 lines (192 loc) · 8.12 KB

VehicleApi.md

File metadata and controls

305 lines (192 loc) · 8.12 KB

RentCentric::VehicleApi

All URIs are relative to https://www6.rentcentric.com:443/Client7020/UpNorthApi

Method HTTP request Description
vehicle_get_available_vehicles POST /api/Vehicle/GetAvailableVehicles
vehicle_get_available_vehicles_search_criteria POST /api/Vehicle/GetAvailableVehiclesSearchCriteria
vehicle_get_locations_by_available_vehicles POST /api/Vehicle/GetLocationsByAvailableVehicles
vehicle_get_vehicle POST /api/Vehicle/GetVehicle
vehicle_get_vehicle_calendar POST /api/Vehicle/GetVehicleCalendar
vehicle_get_vehicles POST /api/Vehicle/GetVehicles

vehicle_get_available_vehicles

ResponseListVehicleDTO vehicle_get_available_vehicles(request, opts)

Example

# load the gem
require 'rent_centric'

api_instance = RentCentric::VehicleApi.new

request = RentCentric::GetAvailableVehiclesRequest.new # GetAvailableVehiclesRequest | 

opts = { 
  authorization: 'authorization_example' # String | {token_type} {access_token}
}

begin
  result = api_instance.vehicle_get_available_vehicles(request, opts)
  p result
rescue RentCentric::ApiError => e
  puts "Exception when calling VehicleApi->vehicle_get_available_vehicles: #{e}"
end

Parameters

Name Type Description Notes
request GetAvailableVehiclesRequest
authorization String {token_type} {access_token} [optional]

Return type

ResponseListVehicleDTO

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

vehicle_get_available_vehicles_search_criteria

ResponseAvailableVehiclesSearchCriteriaDTO vehicle_get_available_vehicles_search_criteria(request, opts)

Example

# load the gem
require 'rent_centric'

api_instance = RentCentric::VehicleApi.new

request = RentCentric::GetAvailableVehiclesSearchCriteriaRequest.new # GetAvailableVehiclesSearchCriteriaRequest | 

opts = { 
  authorization: 'authorization_example' # String | {token_type} {access_token}
}

begin
  result = api_instance.vehicle_get_available_vehicles_search_criteria(request, opts)
  p result
rescue RentCentric::ApiError => e
  puts "Exception when calling VehicleApi->vehicle_get_available_vehicles_search_criteria: #{e}"
end

Parameters

Name Type Description Notes
request GetAvailableVehiclesSearchCriteriaRequest
authorization String {token_type} {access_token} [optional]

Return type

ResponseAvailableVehiclesSearchCriteriaDTO

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

vehicle_get_locations_by_available_vehicles

ResponseListGetLocationsByAvailableVehiclesDTO vehicle_get_locations_by_available_vehicles(request, opts)

Example

# load the gem
require 'rent_centric'

api_instance = RentCentric::VehicleApi.new

request = RentCentric::GetLocationsByAvailableVehiclesRequest.new # GetLocationsByAvailableVehiclesRequest | 

opts = { 
  authorization: 'authorization_example' # String | {token_type} {access_token}
}

begin
  result = api_instance.vehicle_get_locations_by_available_vehicles(request, opts)
  p result
rescue RentCentric::ApiError => e
  puts "Exception when calling VehicleApi->vehicle_get_locations_by_available_vehicles: #{e}"
end

Parameters

Name Type Description Notes
request GetLocationsByAvailableVehiclesRequest
authorization String {token_type} {access_token} [optional]

Return type

ResponseListGetLocationsByAvailableVehiclesDTO

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

vehicle_get_vehicle

ResponseVehicleDTO vehicle_get_vehicle(vehicle_id, opts)

Example

# load the gem
require 'rent_centric'

api_instance = RentCentric::VehicleApi.new

vehicle_id = 56 # Integer | 

opts = { 
  authorization: 'authorization_example' # String | {token_type} {access_token}
}

begin
  result = api_instance.vehicle_get_vehicle(vehicle_id, opts)
  p result
rescue RentCentric::ApiError => e
  puts "Exception when calling VehicleApi->vehicle_get_vehicle: #{e}"
end

Parameters

Name Type Description Notes
vehicle_id Integer
authorization String {token_type} {access_token} [optional]

Return type

ResponseVehicleDTO

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

vehicle_get_vehicle_calendar

ResponseGetVehicleCalendarResponse vehicle_get_vehicle_calendar(request, opts)

Example

# load the gem
require 'rent_centric'

api_instance = RentCentric::VehicleApi.new

request = RentCentric::GetVehicleCalendarRequest.new # GetVehicleCalendarRequest | 

opts = { 
  authorization: 'authorization_example' # String | {token_type} {access_token}
}

begin
  result = api_instance.vehicle_get_vehicle_calendar(request, opts)
  p result
rescue RentCentric::ApiError => e
  puts "Exception when calling VehicleApi->vehicle_get_vehicle_calendar: #{e}"
end

Parameters

Name Type Description Notes
request GetVehicleCalendarRequest
authorization String {token_type} {access_token} [optional]

Return type

ResponseGetVehicleCalendarResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

vehicle_get_vehicles

ResponseListVehicleDTO vehicle_get_vehicles(pickup_location_id, vehicle_type_id, opts)

Example

# load the gem
require 'rent_centric'

api_instance = RentCentric::VehicleApi.new

pickup_location_id = 56 # Integer | 

vehicle_type_id = 56 # Integer | 

opts = { 
  authorization: 'authorization_example' # String | {token_type} {access_token}
}

begin
  result = api_instance.vehicle_get_vehicles(pickup_location_id, vehicle_type_id, opts)
  p result
rescue RentCentric::ApiError => e
  puts "Exception when calling VehicleApi->vehicle_get_vehicles: #{e}"
end

Parameters

Name Type Description Notes
pickup_location_id Integer
vehicle_type_id Integer
authorization String {token_type} {access_token} [optional]

Return type

ResponseListVehicleDTO

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml