GetConsumerOBDToXml

Returns OBD Data from the requested consumer in XML format

public XmlDocument GetConsumerOBDToXml(bool <byHttps>, string <userName>, string <password>, ConsumerOBDParameters <consumerOBDParameters>, ref char <messageType>, ref string <message>)

Parameters:

bool <byHttps> Set to true if you want to user https protocol otherwise, if you want to use http, set it to false
string <userName> A string containing the username assigned from MyWakes
string <password> A string containing the password for the MyWakes user
ConsumerOBDParameters <consumerOBDParameters> A ConsumerOBDParameters object containing command's specific parameters
ref char <messageType> A string containing output parameter that will return the type of message returned in <message> field: I=information, W=warning, E=error
ref string <message> A string containing output parameter with the message content

ConsumerOBDParameters

UInt32? <Consumer> Consumer Id by which search OBD data
DateTime? <DateTimeFrom> The start of interval of OBD data to search. If no value is set the backend server will return all data from the beginning.
DateTime? <DateTimeTo> The end of interval of OBD data to search. If no value is set the backend server will return all data till the end.
UInt32? <DTConly> Optional. Show only ODB Data that contains Diagnostic Trouble Codes.
UInt32? <MaxItem> Used for paging results. If set returns points less than this value.
Note that order to prevent your system from being flooded with oversized responses, the number of messages that will be returned on a single response is limited to 2000.
UInt32? <MinItem> Used for paging results. If set returns points greater than this value.

Returned Type: XmlDocument

Returns an XML Document with the following structure:

<?xml version="1.0" encoding="utf-8"?>
<furesult>
	<message><![CDATA[OK]]></message>
	<items>
		<item>
			<consumer>27</consumer>
			<type>0</type>
			<connect>1</connect>
			<voltage>12276</voltage>
			<rpm>null</rpm>
			<speed>null</speed>
			<coolanttemp>null</coolanttemp>
			<fuelconsumption>null</fuelconsumption>
			<dtccleareddist>null</dtccleareddist>
			<milactivateddist>null</milactivateddist>
			<milstatus>null</milstatus>
			<throttle>null</throttle>
			<engineload>null</engineload>
			<fuellevel>null</fuellevel>
			<obdmessagetime>20110318020346</obdmessagetime>
			<creationdate>20110919075518</creationdate>
			<dtcscount>0</dtcscount>
		</item>
		<item>
			<consumer>27</consumer>
			<type>0</type>
			<connect>1</connect>
			<voltage>14241</voltage>
			<rpm>986</rpm>
			<speed>13.000000</speed>
			<coolanttemp>68</coolanttemp>
			<fuelconsumption>51.200000</fuelconsumption>
			<dtccleareddist>1516.000</dtccleareddist>
			<milactivateddist>99.000</milactivateddist>
			<milstatus>0</milstatus>
			<throttle>null</throttle>
			<engineload>34</engineload>
			<fuellevel>null</fuellevel>
			<obdmessagetime>20110318123727</obdmessagetime>
			<creationdate>20111007151728</creationdate>
			<dtcscount>2</dtcscount>
			<dtcs>
				<dtc>P2263</dtc>
				<dtc>P3333</dtc>
			</dtcs>
		</item>
	</items>
</furesult>

 

Where

  • <message> contains OK or Error description
  • <items> se il comando è andato a buon fine ed il tag <message> contiene OK questo tag è presente e contiene la lista dei dati OBD con i seguenti tag:
    • <item> elemento della lista. Può essere ripetuto n volte. Contenente i seguenti tag:
    • <consumer> contains the Id of the consumer
    • <type> contains the type of report:
      • 0 (zero) – periodical report
      • 1 (one) – real time report
    • <connect> reports if the device is connected to the vehicle:
      • 0 (zero) – not connected
      • 1 (one) – connected
    • <voltage> reports the power voltage coming from the vehicle to the OBD interface
    • <rpm> reports the engine RPM (Revolutions per minute)
    • <speed> contains the vehicle speed
    • <coolanttemp> reports the engine coolant temperature
    • <fuelconsumption> reports the engine fuel consumption in real time
    • <dtccleareddist> reports the distance traveled since last DTC deletion
    • <milactivateddist> reports the distance traveled since DTC activation
    • <milstatus> reports the malfunctioning LED status:
      • 0 (zero): off.
      • 1 (one): on
    • <throttle> the value of throttle position percentage
    • <engineload> engine load percentage
    • <fuellevel> the value of fuel level input percentage
    • <obdmessagetime> UCT date and time of OBD sampling in yyyyMMddhhmmss format
    • <creationdate> UCT date and time of OBD message creation in yyyyMMddhhmmss format
    • <dtcscount> total number of DTCs (Diagnostic Trouble Codes) found in OBD sampling
    • <dtcs> if the OBD message contains one or more DTC codes, this node will contain <dtc> sub nodes containing one code each
      • <dtc> contains a DTC (Diagnostic Trouble Code) value
Terms Of Use | Privacy Statement | Company info
  • © Cedac Sistemi srl
  • Head office: Via Toscana, 3 40035 Castiglione dei Pepoli (Italy) Tel.: +39 0534-93811 Fax: +39 0534-93899
  • Branch office: Via del Lavoro, 47 40033 Casalecchio di Reno (Italy)
  • Branch office: Via Parini, 1 40033 Casalecchio di Reno (Italy)
  • Share capital Euro 26,000.00 - Company Register of Bologna / VAT no / fiscal code 01695261204