Class: SynsbasenApi::Vehicle

Inherits:
Resource show all
Extended by:
Findable, Searchable
Defined in:
lib/synsbasen_api/resources/vehicle.rb

Overview

The Vehicle class provides methods for interacting with vehicle-related endpoints in the Synsbasen API. It extends the Client class.

Constant Summary

Constants inherited from Client

Client::DEFAULT_BASE_URL

Class Method Summary collapse

Methods included from Findable

find

Methods included from Searchable

search

Methods inherited from Client

delete, get, post

Class Method Details

.find_by_registration(registration, expand: []) ⇒ ApiResponse

Retrieves information about a vehicle based on its registration number.

Parameters:

  • registration (String) —

    The registration number of the vehicle.

Returns:

  • (ApiResponse) —

    An instance of ApiResponse containing details of the specified vehicle.



18
19
20
21
 
# File 'lib/synsbasen_api/resources/vehicle.rb', line 18

def find_by_registration(registration, expand: [])
  escaped_registration = CGI.escape(registration)
  get("/v1/#{resource_name}/registration/#{escaped_registration}", expand: expand)
end

.find_by_vin(vin, expand: []) ⇒ ApiResponse

Retrieves information about a vehicle based on its VIN (Vehicle Identification Number).

Parameters:

  • vin (String) —

    The VIN of the vehicle.

Returns:

  • (ApiResponse) —

    An instance of ApiResponse containing details of the specified vehicle.



28
29
30
 
# File 'lib/synsbasen_api/resources/vehicle.rb', line 28

def find_by_vin(vin, expand: [])
  get("/v1/#{resource_name}/vin/#{vin}", expand: expand)
end