VehicleInformationService Class

OFV Kjøretøydata service

This service delivers information about vehicles.

All methods need an UserDTO as input - login user by using Login(UserDTO, TermsDTO, String) to get an UserDTO.

All methods need a format as input (json/xml) - result of request is delivered on format selected.

Inheritance Hierarchy

SystemObject
OfvVehicleData.ServiceVehicleInformationService

Namespace: OfvVehicleData.Service
Assembly: OfvVehicleData.Service (in OfvVehicleData.Service.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

Copy

public class VehicleInformationService

The VehicleInformationService type exposes the following members.

Constructors

	Name	Description
	VehicleInformationService	Initializes a new instance of the VehicleInformationService class

Top

Methods

	Name	Description
	CompareExportByVariantIds	Export compare of vehicles to PDF or CSV. There is restriction on how many vehicles that can be compared - try call "limits()" to get boundaries.
	CompareExportByVariantIdsHist	Export compare of vehicles to PDF or CSV. There is restriction on how many vehicles that can be compared - try call "limits()" to get boundaries.
	Export	Export vehicleinformation by freetext searchstring to PDF document. There is no restrictions, so its possible to export complete set of vehicledata (Bilpriser).
	ExportByVariantIds	Export vehicleinformation for variants to PDF document. There is restriction on how big resultset can be - try call "limits()" to get boundaries.
	ExportFilterSearch	Export filtersearch result to PDF or CSV. There is restriction on how many filters to show and how big resultset can be - try call "limits()" to get boundaries.
	FilterSearch	Search with filter values. Returns resultset of brand, model and variant based on searchfilter.
	GetAvailableFilters	Get available filter that it is possible to use as search options when doing FilterSearch.
	GetAvailableFiltersHist	Get available filter that it is possible to use as search options when doing FilterSearch. Specific version for History!
	GetEnvironmentPoster	Generates the environment poster as a pdf.
	GetEnvironmentPoster2020	Generates the environment poster as a pdf.
	GetTax	Get tax for vehicle.
	GetVehicle	Get vehicle information. Returns complete resulset based on BrandDTO object-tree, which describes a complete vehicle.
	Limits	Get limits specified in WEB.CONFIG
	RegisterError	Register an error in application/service - mail will be sent to provider/owner of service.
	RegisterForSubscription	Register for subscribtion - mail will be sent to provider/owner of service.
	SearchByBrandAndModel	Search for vehicles Returns resultset of brand, model and variant based on brand- and model-input.
	SearchByBrandAndModelHist	Search for vehicles + history Returns resultset of brand, model and variant based on brand- and model-input.
	SearchByDate	Search for new/changed vehicles since date. Returns resultset of brand, model and variant, with technical data, based on date-input.
	SimpleSearch	Simple search for vehicle. Returns list of brand, model, modelsplit and variant that match search string applied.
	SimpleSearchHist	Simple search for vehicle + history. Returns list of brand, model, modelsplit and variant that match search string applied.
	Template	Get template to build uniform data presentation. Delivers a vehicle-object-tree, that together with data for a vehicle, can be used to present a vehicle with data, types, headers and descriptions.

Top

Remarks

The purpose of this service is to expose methods that can be used to gather information about vehicles. The service-methods consist of different calls, some can be used stand-alone and some requires input from another service-call. All (except methods "Limits" and "RegisterForSubscription") services is based on subscription/module-access that a logged in user has been granted.

Examples

Connect to webservice to get help information: https://www.kjoretoydata.no/VehicleInformation/help

Below is a simple example, that shows how to call the service SimpleSearch(UserDTO, String, Int32, Boolean, String, Int32).

Call webservice from JavaScript using JQuery

Copy

function runSimpleSearch() {
    var userObject = { "username": "your username", "token": "token you get from login", "ipAddress": "your ip address" };
    var url = "https://www.kjoretoydata.no/VehicleInformation/SimpleSearch?format=json";
    var input = { "user": userObject, "searchString": "your search string", "vehicleGroup": "the vehiclegroup to work with", "data": true };
    $.ajax({
        type: "POST",
        url: url,
        data: JSON.stringify(input),
        processData: true,
        contentType: "application/json; charset=utf-8",
        dataType: "json",
        success: function (response) { alert('Result: ' + response); }
        , error: function (request, status, error) { alert('Error:' + request.status + ',' + request.statusText + ',' + request.responseText); }
    });
}

Reference

OfvVehicleData.Service Namespace