com.networkcar.webservices
Class NetworkcarWebservice

java.lang.Object
  com.networkcar.webservices.NetworkcarWebservice

public class NetworkcarWebservice
extends java.lang.Object

Constructor Summary

NetworkcarWebservice()

NetworkcarWebservice(java.lang.String userName, java.lang.String password)

Method Summary

java.lang.String	getAlertDataXml(java.lang.String vin) Get and return the requested Vehicle Alert List.
java.lang.String	getCustomerCarListXml(java.lang.String username, java.lang.String password) Get and return the requested Customer Car List.
java.lang.String	getCustomerInfoXml(int customerId) Gets detailed Customer Info for a given Customer ID.
java.lang.String	getDiagnosticDataXml(java.lang.String vin, java.lang.String... mlds) Get and return the specified Mid Level Diagnostic Code List.
java.lang.String	getDrivingStatisticsXml(java.lang.String vin, java.lang.String histType, java.lang.String fromDate, java.lang.String toDate) Get and return the requested histogram (driving stats) data.
java.lang.String	getFleetDiagnosticsXml(java.lang.String... mlds) Get and return the requested Fleet Diagnostic data specidifed by the Mid Level Diagnostic Code List
java.lang.String	getFleetGpsInfoXml() Get the latest GPS information for a fleet
java.lang.String	getFleetMpgAverageXml(java.lang.String fromDate, java.lang.String toDate) Get and return the requested Fleet MPG Average Data for the period specified.
java.lang.String	getGpsInfoXml(java.lang.String vin) Get the latest GPS information for the supplied VIN.
java.lang.String	getGpsTrackAdvancedXml(java.lang.String vin, java.lang.String fromDate, java.lang.String toDate, java.lang.String keyOffFlag, int fixCount, java.lang.String sortDirection) Get the GPS Track information for the supplied VIN, date range and other qualifying data, including the number of points (30 max) and the sort order (ascending or descending).
java.lang.String	getGpsTrackXml(java.lang.String vin, java.lang.String fromDate, java.lang.String toDate, java.lang.String keyOffFlag) Get the GPS Track information for the supplied VIN, date range and other qualifying data.
java.lang.String	getInspectionDataXml(java.lang.String vin) Get and return the requested Vehicle Inspection Data List.
java.lang.String	getMpgAverageXml(java.lang.String vin, java.lang.String fromDate, java.lang.String toDate) Get and return the requested Vehicle MPG Average Data for the period specified.
java.lang.String	getMpgHistoryXml(java.lang.String username, java.lang.String password, java.lang.String vin, java.lang.String fromDate, java.lang.String toDate) Get and return the requested Vehicle MPG History Data for the period specified.
java.lang.String	getServiceHistoryXml() Get and return the requested Service History List.
java.lang.String	getServiceRecordXml(int workOrderId) Get and return the requested Service Record.
java.lang.String	getVehicleDataXml(java.lang.String vin) Get and return the requested Vehicle Diagnostic List.
java.lang.String	updateOdometerXml(java.lang.String vin, java.lang.String odo, boolean isAbsoluteOdo, boolean odoUnitsInMiles) Update the odometer field for any vehicle by specifying either an absolute value or an offset to be applied to the existing value (base).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NetworkcarWebservice

public NetworkcarWebservice()

NetworkcarWebservice

public NetworkcarWebservice(java.lang.String userName,
                            java.lang.String password)

Method Detail

getGpsInfoXml

public java.lang.String getGpsInfoXml(java.lang.String vin)
                               throws java.rmi.RemoteException

Get the latest GPS information for the supplied VIN.

Parameters:

vin - String Vehicle Identification Number.

Returns:

String Gps Info (Lat, Lon, etc).

Throws:

java.rmi.RemoteException - if there is a communications or systems failure

getGpsTrackXml

public java.lang.String getGpsTrackXml(java.lang.String vin,
                                       java.lang.String fromDate,
                                       java.lang.String toDate,
                                       java.lang.String keyOffFlag)
                                throws java.rmi.RemoteException

Get the GPS Track information for the supplied VIN, date range and other qualifying data.

Parameters:

String - Vehicle Identification Number.

String - From Date in format "YYYY-MM-DD HH:MM:SS".

String - To Date in format "YYYY-MM-DD HH:MM:SS".

String - KeyOff Flag "Y" or "N" (returns only Stop locs if "Y").

Returns:

String XML payload of Gps Info (Lat, Lon, etc).

Throws:

java.rmi.RemoteException - if there is a communications or systems failure.

getGpsTrackAdvancedXml

public java.lang.String getGpsTrackAdvancedXml(java.lang.String vin,
                                               java.lang.String fromDate,
                                               java.lang.String toDate,
                                               java.lang.String keyOffFlag,
                                               int fixCount,
                                               java.lang.String sortDirection)
                                        throws java.rmi.RemoteException

Get the GPS Track information for the supplied VIN, date range and other qualifying data, including the number of points (30 max) and the sort order (ascending or descending). This method allows one to retrieve a set of points originating from the "fromDate" as opposed to the "toDate".

Parameters:

String - Vehicle Identification Number.

String - From Date in format "YYYY-MM-DD HH:MM:SS".

String - To Date in format "YYYY-MM-DD HH:MM:SS".

String - KeyOff Flag "Y" or "N" (returns only Stop locs if "Y").

int - Number of GPS Fix locations to return (default = 30)

String - Sort direction of data ('A'scending or 'D'escending)

Returns:

String XML payload of Gps Info (Lat, Lon, etc).

Throws:

java.rmi.RemoteException - if there is a communications or systems failure.

getFleetGpsInfoXml

public java.lang.String getFleetGpsInfoXml()
                                    throws java.rmi.RemoteException

Get the latest GPS information for a fleet

Returns:

String XML payload of Fleet Gps Info (Lat, Lon, etc).

Throws:

java.rmi.RemoteException - if there is a communications or systems failure.

getVehicleDataXml

public java.lang.String getVehicleDataXml(java.lang.String vin)
                                   throws java.rmi.RemoteException

Get and return the requested Vehicle Diagnostic List.

Parameters:

VIN - String Vehicle Identification Number.

Returns:

String XML Payload of Mid Level Diagnostic data.

Throws:

java.rmi.RemoteException - if there is an authentication failure

getAlertDataXml

public java.lang.String getAlertDataXml(java.lang.String vin)
                                 throws java.rmi.RemoteException

Get and return the requested Vehicle Alert List.

Parameters:

VIN - String Vehicle Identification Number.

Returns:

String XML Payload of Vehicle Alert data.

Throws:

java.rmi.RemoteException - if there is an authentication failure

getDiagnosticDataXml

public java.lang.String getDiagnosticDataXml(java.lang.String vin,
                                             java.lang.String... mlds)
                                      throws java.rmi.RemoteException

Get and return the specified Mid Level Diagnostic Code List.

Parameters:

VIN - String Vehicle Identification Number.

MLDs - String[] List of MLD codes to report (optional).

Returns:

String XML Payload of Mid Level Diagnostic data.

Throws:

java.rmi.RemoteException - if there is an authentication failure

getInspectionDataXml

public java.lang.String getInspectionDataXml(java.lang.String vin)
                                      throws java.rmi.RemoteException

Get and return the requested Vehicle Inspection Data List.

Parameters:

VIN - String Vehicle Identification Number.

Returns:

String XML Payload of Vehicle Inspection (Emissions) data.

Throws:

java.rmi.RemoteException - if there is an authentication failure

getServiceHistoryXml

public java.lang.String getServiceHistoryXml()
                                      throws java.rmi.RemoteException

Get and return the requested Service History List.

Returns:

String XML Payload of Service History List

Throws:

java.rmi.RemoteException - if there is an authentication failure

getServiceRecordXml

public java.lang.String getServiceRecordXml(int workOrderId)
                                     throws java.rmi.RemoteException

Get and return the requested Service Record.

Parameters:

workorderId - Int Work Order ID

Returns:

String XML Payload of the Service Record

Throws:

java.rmi.RemoteException - if there is an authentication failure

getMpgAverageXml

public java.lang.String getMpgAverageXml(java.lang.String vin,
                                         java.lang.String fromDate,
                                         java.lang.String toDate)
                                  throws java.rmi.RemoteException

Get and return the requested Vehicle MPG Average Data for the period specified. Specified period may not exceed 90 days and must be within the past 90 days.

Parameters:

VIN - String Vehicle Identification Number.

fromDate - String From Date in format "YYYY-MM-DD HH:MM:SS".

toDate - String To Date in format "YYYY-MM-DD HH:MM:SS".

Returns:

String XML Payload of Vehicle MPG Average data.

Throws:

java.rmi.RemoteException - if there is an authentication failure

getMpgHistoryXml

public java.lang.String getMpgHistoryXml(java.lang.String username,
                                         java.lang.String password,
                                         java.lang.String vin,
                                         java.lang.String fromDate,
                                         java.lang.String toDate)
                                  throws java.rmi.RemoteException

Get and return the requested Vehicle MPG History Data for the period specified. Specified period may not exceed 30 days and must be within the past 90 days.

Parameters:

Username - String Database username.

Password - String Database password.

VIN - String Vehicle Identification Number.

fromDate - String From Date in format "YYYY-MM-DD HH:MM:SS".

toDate - String To Date in format "YYYY-MM-DD HH:MM:SS".

Returns:

String XML Payload of Vehicle MPG History data.

Throws:

java.rmi.RemoteException - if there is an authentication failure

getFleetDiagnosticsXml

public java.lang.String getFleetDiagnosticsXml(java.lang.String... mlds)
                                        throws java.rmi.RemoteException

Get and return the requested Fleet Diagnostic data specidifed by the Mid Level Diagnostic Code List

Parameters:

MLD - List String[] List of MLD codes to report.

Returns:

String XML Payload of Fleet MPG Average data.

Throws:

java.rmi.RemoteException - if there is an authentication failure

getFleetMpgAverageXml

public java.lang.String getFleetMpgAverageXml(java.lang.String fromDate,
                                              java.lang.String toDate)
                                       throws java.rmi.RemoteException

Get and return the requested Fleet MPG Average Data for the period specified. Specified period may not exceed 30 days and must be within the past 90 days.

Parameters:

VIN - String Vehicle Identification Number.

fromDate - String From Date in format "YYYY-MM-DD HH:MM:SS".

toDate - String To Date in format "YYYY-MM-DD HH:MM:SS".

Returns:

String XML Payload of Fleet MPG Average data.

Throws:

java.rmi.RemoteException - if there is an authentication failure

updateOdometerXml

public java.lang.String updateOdometerXml(java.lang.String vin,
                                          java.lang.String odo,
                                          boolean isAbsoluteOdo,
                                          boolean odoUnitsInMiles)
                                   throws java.rmi.RemoteException

Update the odometer field for any vehicle by specifying either an absolute value or an offset to be applied to the existing value (base). Absolute values must be positive integers, no more than seven digits long. Offset values can be positive or negative integers so long as the resulting baseOdo is not less than zero and not longer than seven digits. The boolean variable defines the update type (absolute or offset).

Parameters:

VIN - String Vehicle Identification Number.

Odo - String Odometer value used to update vehmld table.

IsAbsoluteOdo - Boolean Sets update value type (absolute or offset).

odoUnitsInMiles - Boolean Specifies input units in Miles or Kilometers.

Returns:

String XML Payload of Fleet MPG Average data.

Throws:

java.rmi.RemoteException - if there is an authentication failure

getDrivingStatisticsXml

public java.lang.String getDrivingStatisticsXml(java.lang.String vin,
                                                java.lang.String histType,
                                                java.lang.String fromDate,
                                                java.lang.String toDate)
                                         throws java.rmi.RemoteException

Get and return the requested histogram (driving stats) data. Possible histTypes are VSS, RPM, and LOAD (as of August 2005). NOTE: Passing an asterisk "*" character or the string, "ALL" in the histType field will retrieve data for all histogram types.

Parameters:

VIN - String Vehicle Identification Number.

histType - String Histogram Type. See "NOTE" section above.

fromDate - String From Date in format "YYYY-MM-DD HH:MM:SS".

toDate - String To Date in format "YYYY-MM-DD HH:MM:SS".

Returns:

String XML Payload of Vehicle Driving Statistics data.

Throws:

java.rmi.RemoteException - if there is an authentication failure

getCustomerInfoXml

public java.lang.String getCustomerInfoXml(int customerId)
                                    throws java.rmi.RemoteException

Gets detailed Customer Info for a given Customer ID.

Parameters:

customerId - int Customer ID.

Returns:

String XML Payload of Customer Info

Throws:

java.rmi.RemoteException - if there is a communications or systems failure

getCustomerCarListXml

public java.lang.String getCustomerCarListXml(java.lang.String username,
                                              java.lang.String password)
                                       throws java.rmi.RemoteException

Get and return the requested Customer Car List.

Parameters:

Username - String Database username.

Password - String Database password.

Returns:

String XML Payload of Customer Car List

Throws:

java.rmi.RemoteException - if there is an authentication failure