Back to index

CreateFuelPurchasedRecord_v1

This method allows you to create a fuel purchase record, including a vehicle id, timestamp, and the amount and type of fuel.

Parameters:

[in] usn The user-name that you need to use to authenticate on this interface.
[in] pwd The password that you need to use to authenticate on this interface.
[in] options String parameter. This is currently unused and reserved for future versions of the API. Pass in an empty string.
[in] vehicleID Int parameter. The Vehicle ID of the vehicle the fuel is being purchased for.
[in] timeStamp DateTime parameter. The time the fuel was purchased in UTC.
[in] amount Float parameter. This is the amount of fuel purchased in Liters.
[in] fuelTypeID Int parameter. This specifies the fuel type.


Fuel Type IDDescription
1Diesel
2Gasoline
3Bio-Ethanol
4Bio-Fuel
[in] locationDescription String parameter. (Optional) A description of the fuel purchase location, if this is null the address will be resolved according to the timestamp and vehicle ID.
[in] userData String parameter. (Optional) User data for the fuel purchase.
[in] juristiction String parameter. (Optional) The Juristiction for the fuel purchase.
[in] countryISO String parameter. (Optional) The Alpha-2 ISO 3166-1 code for the fuel purchase country, e.g. "US" for the United States, "DE" for Germany, see ISO_3166-1 Country Codes.
[in] replaceExisting Boolean parameter. Whether to replace any existing record at the same time for the same vehicle. N.B. If this is set to false, existing records will not be overwritten if they have the same timestamp and vehicle ID as the new record.
[out] errorMessage If an error happpens this string contains the error message. In case an error has happened (this variable contains a valid non-empty string) then the return value will not contain any usable data, do not try to parse it as xml.
return value If the errorMessage variable is null or empty then the returned string contains the created data in xml format. The xml has the following structure:
<?xml version="1.0" encoding="utf-16"?>
<root>
<fuelpurchasedrecords>
  <fuelpurchasedrecord vehicleID="1" timeStamp="2018-02-01T15:11:03" amount="545.112"
    fuelTypeID="1" locationDescription="null" userData="null"
    juristiction="null countryISO="null" replaceExisting="True"/>
</fuelpurchasedrecords>
</root>
Please note this.

Remarks

Minimum R-COM Database version

0.862

Error messages

Please see this page.