Search
Root Documents Web API Interface (legacy) Tracking Interface ConsumerOBD

consumerobd

Returns requested consumer's OBD data.

Command's fields description:

  • txtUser1 field is the “username” of MyWakes account.

  • txtUser2 field is the “password” of MyWakes account.

  • txtCommand field contains the command: “consumerobd”.

  • txtFormat optional field specifies txtParameters and response formats. more info.

  • txtParameter field contains a structure like this:

<?xml version="1.0" encoding="utf-8" ?>
<consumerobd>
	<consumer>134</consumer>
	<from>20111024000000</from>
	<to>20111025000000</to>
	<dtconly>0</dtconly>
	<maxitem>20</maxitem>
	<time>20111105154013</time>
</consumerobd>

{
  "consumerobd": {
    "consumer": "134",
    "from": "20111024000000",
    "to": "20111025000000",
    "dtconly": "0",
    "maxitem": "20",
    "time": "20111105154013"
  }
}

 

Where

  • <consumer> mandatory. Consumer Id by which search OBD data.

  • <from> optional. The start of interval of OBD data to search. If no value is set the backend server will return all data from the beginning.

  • <to> optional. The end of interval of OBD data to search. If no value is set the backend server will return all data till the end.

  • <minitem> optional. Used for paging results. If set returns tracks greater than this value.

  • <maxitem> optional. Used for paging results. If set returns tracks 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.

  • <dtconly> optional. Show only ODB Data that contains Diagnostic Trouble Codes. Default value is 0 (zero). Can be:

    • 0 (zero) show all OBD reports.
    • 1 (one) Show only ODB Data that contains Diagnostic Trouble Codes.

  • <time> mandatory, date and time in UTC. The accepted format is “yyyyMMddhhmmss”.

  • txtProvider field must contain the application calling ID and generated characters.

  • txtSignature field must contain the signature based on the string made of “Command Name” + “time” + “generated character to 32”.

Looking at the previous example, the string on which calculate the check will be:
“consumerobd20111105154013xxxxxxx”


Therefore the txtProvider field will be:
“76a865d4-fab8-51cd-ba78-2da325f6955xxxxxxx”

Returns a structure like the following:

<?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>

{
  "furesult": {
    "message": "OK",
    "items": {
      "item": [
        {
          "consumer": "27",
          "type": "0",
          "connect": "1",
          "voltage": "12276",
          "rpm": "null",
          "speed": "null",
          "coolanttemp": "null",
          "fuelconsumption": "null",
          "dtccleareddist": "null",
          "milactivateddist": "null",
          "milstatus": "null",
          "throttle": "null",
          "engineload": "null",
          "fuellevel": "null",
          "obdmessagetime": "20110318020346",
          "creationdate": "20110919075518",
          "dtcscount": "0"
        },
        {
          "consumer": "27",
          "type": "0",
          "connect": "1",
          "voltage": "14241",
          "rpm": "986",
          "speed": "13.000000",
          "coolanttemp": "68",
          "fuelconsumption": "51.200000",
          "dtccleareddist": "1516.000",
          "milactivateddist": "99.000",
          "milstatus": "0",
          "throttle": "null",
          "engineload": "34",
          "fuellevel": "null",
          "obdmessagetime": "20110318123727",
          "creationdate": "20111007151728",
          "dtcscount": "2",
          "dtcs": {
            "dtc": [
              "P2263",
              "P3333"
            ]
          }
        }
      ]
    }
  }
}

 

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

If MyWakes server returns an error, the format of this answer is described in the error section.

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
MyWakes - Advanced GPS tracking system