Click or drag to resize

RemoteVehicleInformationService Class

OFV Kjøretøydata service

This service delivers information about vehicles to third-party remote customers.

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.ServiceRemoteVehicleInformationService

Namespace:  OfvVehicleData.Service
Assembly:  OfvVehicleData.Service (in OfvVehicleData.Service.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
C#
public class RemoteVehicleInformationService

The RemoteVehicleInformationService type exposes the following members.

Constructors
  NameDescription
Public methodRemoteVehicleInformationService
Initializes a new instance of the RemoteVehicleInformationService class
Top
Methods
  NameDescription
Public methodCode exampleFilterSearch
Search with filter values.

Returns resultset of brand, model and variant based on searchfilter.

Public methodCode exampleGetAvailableFilters
Get available filter that it is possible to use as search options when doing FilterSearch.
Public methodCode exampleGetTax
Get tax for vehicle.
Public methodCode exampleGetVehicle
Get vehicle information.

Returns complete resulset based on BrandDTO object-tree, which describes a complete vehicle.

Public methodCode exampleLimits
Get limits specified in WEB.CONFIG
Public methodCode exampleSearchByBrandAndModel
Search for vehicles

Returns resultset of brand, model and variant based on brand- and model-input.

Public methodCode exampleSearchByDate
Search for new/changed vehicles since date.

Returns resultset of brand, model and variant, with technical data, based on date-input.

Public methodCode exampleSimpleSearch
Simple search for vehicle.

Returns list of brand, model, modelsplit and variant that match search string applied.

Public methodCode exampleSimpleSearchHist
Simple search for vehicle in specified year.

Returns list of brand, model, modelsplit and variant that match search string applied.

Public methodCode exampleTemplate
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://remote.kjoretoydata.no/RemoteCustomer/help

Below is a simple example, that shows how to call the service [!:RemoteCustomer.SimpleSearch].

Call webservice from JavaScript using JQuery
function runSimpleSearch() {
    var userObject = { "username": "your username", "password": "md5 password", "ipAddress": "your ip address" };
    var url = "https://remote.kjoretoydata.no/RemoteCustomer/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); }
    });
}
See Also