POST apioauth/v5/vehiclescore
Get vehicle score
Request Information
URI Parameters
None.
Body Parameters
OAuthVehicleScoreRequestModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ServiceIDList |
A list of service ids being requested |
Collection of unsigned integer |
None. |
| StartDate |
The start date being queried |
date |
None. |
| EndDate |
The end date being queried |
date |
None. |
| ScoreType |
The type of score being queried |
ScoreType |
None. |
| ScorePeriod |
The period of score being queried |
ScorePeriod |
None. |
Request Formats
application/json, text/json
Sample:
{
"ServiceIDList": [
1,
2
],
"StartDate": "2025-04-27T16:20:51.1155722+00:00",
"EndDate": "2025-04-27T16:20:51.1155722+00:00",
"ScoreType": 0,
"ScorePeriod": 0
}
application/xml, text/xml
Sample:
<OAuthVehicleScoreRequestModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ServiceIDList>
<unsignedLong>1</unsignedLong>
<unsignedLong>2</unsignedLong>
</ServiceIDList>
<StartDate>2025-04-27T16:20:51.1155722+00:00</StartDate>
<EndDate>2025-04-27T16:20:51.1155722+00:00</EndDate>
<ScoreType>fuel</ScoreType>
<ScorePeriod>journey</ScorePeriod>
</OAuthVehicleScoreRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
A list of VehicleScores
Collection of VehicleScoreResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ServiceID |
The service id of the scores |
unsigned integer |
None. |
| ScoreList |
A list of scores for the vehicle |
Collection of VehicleScore |
None. |
| Vin |
The vin |
string |
None. |
| Usdot |
The usdot |
string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"ServiceID": 1,
"ScoreList": [
{
"sys_service_id": 1,
"score_period": 0,
"score_type": 0,
"sys_service_id_type_period": "sample string 2",
"start_date": "2025-04-27T16:20:51.1155722+00:00",
"end_date": "2025-04-27T16:20:51.1155722+00:00",
"last_journey_end_time": "2025-04-27T16:20:51.1155722+00:00",
"journey_count": 6,
"distance": 7,
"duration": 8,
"overall_score": 9,
"urban_score": 10,
"urban_distance": 11,
"urban_duration": 12,
"night_time_score": 13,
"night_time_distance": 14,
"night_time_duration": 15,
"idling_score": 16,
"idling_duration": 17,
"longest_idling_instance": 18,
"speed_ideal": 19.1,
"speed_exceeded": 20.1,
"speed_score": 21,
"speeding_event_count": 22,
"speeding_duration": 23,
"max_speed": 24.1,
"speed_15_count": 25,
"speed_45_count": 26,
"speed_55_count": 27,
"speed_65_count": 28,
"speed_20_count": 29,
"speed_30_count": 30,
"speed_40_count": 31,
"speed_50_count": 32,
"speed_60_count": 33,
"speed_70_count": 34,
"acceleration_score": 35,
"acceleration_event_count": 36,
"acceleration_level_1_events": 37,
"acceleration_level_2_events": 38,
"acceleration_level_3_events": 39,
"acceleration_max": 40.1,
"deceleration_score": 41,
"deceleration_event_count": 42,
"deceleration_level_1_events": 43,
"deceleration_level_2_events": 44,
"deceleration_level_3_events": 45,
"deceleration_max": 46.1,
"local_start_date": "2025-04-27T16:20:51.1155722+00:00",
"local_end_date": "2025-04-27T16:20:51.1155722+00:00",
"timezone": "sample string 49",
"idling_event_count": 50,
"extended_idling_event_count": 51,
"distance_score": 52,
"high_distance_journeys": 53,
"low_distance_journeys": 54,
"combined_distance": 55,
"extra_urban_distance": 56,
"ideal_fuel_used": 57.1,
"actual_fuel_used": 58.1
},
{
"sys_service_id": 1,
"score_period": 0,
"score_type": 0,
"sys_service_id_type_period": "sample string 2",
"start_date": "2025-04-27T16:20:51.1155722+00:00",
"end_date": "2025-04-27T16:20:51.1155722+00:00",
"last_journey_end_time": "2025-04-27T16:20:51.1155722+00:00",
"journey_count": 6,
"distance": 7,
"duration": 8,
"overall_score": 9,
"urban_score": 10,
"urban_distance": 11,
"urban_duration": 12,
"night_time_score": 13,
"night_time_distance": 14,
"night_time_duration": 15,
"idling_score": 16,
"idling_duration": 17,
"longest_idling_instance": 18,
"speed_ideal": 19.1,
"speed_exceeded": 20.1,
"speed_score": 21,
"speeding_event_count": 22,
"speeding_duration": 23,
"max_speed": 24.1,
"speed_15_count": 25,
"speed_45_count": 26,
"speed_55_count": 27,
"speed_65_count": 28,
"speed_20_count": 29,
"speed_30_count": 30,
"speed_40_count": 31,
"speed_50_count": 32,
"speed_60_count": 33,
"speed_70_count": 34,
"acceleration_score": 35,
"acceleration_event_count": 36,
"acceleration_level_1_events": 37,
"acceleration_level_2_events": 38,
"acceleration_level_3_events": 39,
"acceleration_max": 40.1,
"deceleration_score": 41,
"deceleration_event_count": 42,
"deceleration_level_1_events": 43,
"deceleration_level_2_events": 44,
"deceleration_level_3_events": 45,
"deceleration_max": 46.1,
"local_start_date": "2025-04-27T16:20:51.1155722+00:00",
"local_end_date": "2025-04-27T16:20:51.1155722+00:00",
"timezone": "sample string 49",
"idling_event_count": 50,
"extended_idling_event_count": 51,
"distance_score": 52,
"high_distance_journeys": 53,
"low_distance_journeys": 54,
"combined_distance": 55,
"extra_urban_distance": 56,
"ideal_fuel_used": 57.1,
"actual_fuel_used": 58.1
}
],
"Vin": "sample string 2",
"Usdot": "sample string 3"
},
{
"ServiceID": 1,
"ScoreList": [
{
"sys_service_id": 1,
"score_period": 0,
"score_type": 0,
"sys_service_id_type_period": "sample string 2",
"start_date": "2025-04-27T16:20:51.1155722+00:00",
"end_date": "2025-04-27T16:20:51.1155722+00:00",
"last_journey_end_time": "2025-04-27T16:20:51.1155722+00:00",
"journey_count": 6,
"distance": 7,
"duration": 8,
"overall_score": 9,
"urban_score": 10,
"urban_distance": 11,
"urban_duration": 12,
"night_time_score": 13,
"night_time_distance": 14,
"night_time_duration": 15,
"idling_score": 16,
"idling_duration": 17,
"longest_idling_instance": 18,
"speed_ideal": 19.1,
"speed_exceeded": 20.1,
"speed_score": 21,
"speeding_event_count": 22,
"speeding_duration": 23,
"max_speed": 24.1,
"speed_15_count": 25,
"speed_45_count": 26,
"speed_55_count": 27,
"speed_65_count": 28,
"speed_20_count": 29,
"speed_30_count": 30,
"speed_40_count": 31,
"speed_50_count": 32,
"speed_60_count": 33,
"speed_70_count": 34,
"acceleration_score": 35,
"acceleration_event_count": 36,
"acceleration_level_1_events": 37,
"acceleration_level_2_events": 38,
"acceleration_level_3_events": 39,
"acceleration_max": 40.1,
"deceleration_score": 41,
"deceleration_event_count": 42,
"deceleration_level_1_events": 43,
"deceleration_level_2_events": 44,
"deceleration_level_3_events": 45,
"deceleration_max": 46.1,
"local_start_date": "2025-04-27T16:20:51.1155722+00:00",
"local_end_date": "2025-04-27T16:20:51.1155722+00:00",
"timezone": "sample string 49",
"idling_event_count": 50,
"extended_idling_event_count": 51,
"distance_score": 52,
"high_distance_journeys": 53,
"low_distance_journeys": 54,
"combined_distance": 55,
"extra_urban_distance": 56,
"ideal_fuel_used": 57.1,
"actual_fuel_used": 58.1
},
{
"sys_service_id": 1,
"score_period": 0,
"score_type": 0,
"sys_service_id_type_period": "sample string 2",
"start_date": "2025-04-27T16:20:51.1155722+00:00",
"end_date": "2025-04-27T16:20:51.1155722+00:00",
"last_journey_end_time": "2025-04-27T16:20:51.1155722+00:00",
"journey_count": 6,
"distance": 7,
"duration": 8,
"overall_score": 9,
"urban_score": 10,
"urban_distance": 11,
"urban_duration": 12,
"night_time_score": 13,
"night_time_distance": 14,
"night_time_duration": 15,
"idling_score": 16,
"idling_duration": 17,
"longest_idling_instance": 18,
"speed_ideal": 19.1,
"speed_exceeded": 20.1,
"speed_score": 21,
"speeding_event_count": 22,
"speeding_duration": 23,
"max_speed": 24.1,
"speed_15_count": 25,
"speed_45_count": 26,
"speed_55_count": 27,
"speed_65_count": 28,
"speed_20_count": 29,
"speed_30_count": 30,
"speed_40_count": 31,
"speed_50_count": 32,
"speed_60_count": 33,
"speed_70_count": 34,
"acceleration_score": 35,
"acceleration_event_count": 36,
"acceleration_level_1_events": 37,
"acceleration_level_2_events": 38,
"acceleration_level_3_events": 39,
"acceleration_max": 40.1,
"deceleration_score": 41,
"deceleration_event_count": 42,
"deceleration_level_1_events": 43,
"deceleration_level_2_events": 44,
"deceleration_level_3_events": 45,
"deceleration_max": 46.1,
"local_start_date": "2025-04-27T16:20:51.1155722+00:00",
"local_end_date": "2025-04-27T16:20:51.1155722+00:00",
"timezone": "sample string 49",
"idling_event_count": 50,
"extended_idling_event_count": 51,
"distance_score": 52,
"high_distance_journeys": 53,
"low_distance_journeys": 54,
"combined_distance": 55,
"extra_urban_distance": 56,
"ideal_fuel_used": 57.1,
"actual_fuel_used": 58.1
}
],
"Vin": "sample string 2",
"Usdot": "sample string 3"
}
]
application/xml, text/xml
Sample:
<ArrayOfVehicleScoreResponseModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<VehicleScoreResponseModel>
<ServiceID>1</ServiceID>
<ScoreList>
<VehicleScore>
<sys_service_id>1</sys_service_id>
<score_period>journey</score_period>
<score_type>fuel</score_type>
<sys_service_id_type_period>sample string 2</sys_service_id_type_period>
<start_date>2025-04-27T16:20:51.1155722+00:00</start_date>
<end_date>2025-04-27T16:20:51.1155722+00:00</end_date>
<last_journey_end_time>2025-04-27T16:20:51.1155722+00:00</last_journey_end_time>
<journey_count>6</journey_count>
<distance>7</distance>
<duration>8</duration>
<overall_score>9</overall_score>
<urban_score>10</urban_score>
<urban_distance>11</urban_distance>
<urban_duration>12</urban_duration>
<night_time_score>13</night_time_score>
<night_time_distance>14</night_time_distance>
<night_time_duration>15</night_time_duration>
<idling_score>16</idling_score>
<idling_duration>17</idling_duration>
<longest_idling_instance>18</longest_idling_instance>
<speed_ideal>19.1</speed_ideal>
<speed_exceeded>20.1</speed_exceeded>
<speed_score>21</speed_score>
<speeding_event_count>22</speeding_event_count>
<speeding_duration>23</speeding_duration>
<max_speed>24.1</max_speed>
<speed_15_count>25</speed_15_count>
<speed_45_count>26</speed_45_count>
<speed_55_count>27</speed_55_count>
<speed_65_count>28</speed_65_count>
<speed_20_count>29</speed_20_count>
<speed_30_count>30</speed_30_count>
<speed_40_count>31</speed_40_count>
<speed_50_count>32</speed_50_count>
<speed_60_count>33</speed_60_count>
<speed_70_count>34</speed_70_count>
<acceleration_score>35</acceleration_score>
<acceleration_event_count>36</acceleration_event_count>
<acceleration_level_1_events>37</acceleration_level_1_events>
<acceleration_level_2_events>38</acceleration_level_2_events>
<acceleration_level_3_events>39</acceleration_level_3_events>
<acceleration_max>40.1</acceleration_max>
<deceleration_score>41</deceleration_score>
<deceleration_event_count>42</deceleration_event_count>
<deceleration_level_1_events>43</deceleration_level_1_events>
<deceleration_level_2_events>44</deceleration_level_2_events>
<deceleration_level_3_events>45</deceleration_level_3_events>
<deceleration_max>46.1</deceleration_max>
<local_start_date>2025-04-27T16:20:51.1155722+00:00</local_start_date>
<local_end_date>2025-04-27T16:20:51.1155722+00:00</local_end_date>
<timezone>sample string 49</timezone>
<idling_event_count>50</idling_event_count>
<extended_idling_event_count>51</extended_idling_event_count>
<distance_score>52</distance_score>
<high_distance_journeys>53</high_distance_journeys>
<low_distance_journeys>54</low_distance_journeys>
<combined_distance>55</combined_distance>
<extra_urban_distance>56</extra_urban_distance>
<ideal_fuel_used>57.1</ideal_fuel_used>
<actual_fuel_used>58.1</actual_fuel_used>
</VehicleScore>
<VehicleScore>
<sys_service_id>1</sys_service_id>
<score_period>journey</score_period>
<score_type>fuel</score_type>
<sys_service_id_type_period>sample string 2</sys_service_id_type_period>
<start_date>2025-04-27T16:20:51.1155722+00:00</start_date>
<end_date>2025-04-27T16:20:51.1155722+00:00</end_date>
<last_journey_end_time>2025-04-27T16:20:51.1155722+00:00</last_journey_end_time>
<journey_count>6</journey_count>
<distance>7</distance>
<duration>8</duration>
<overall_score>9</overall_score>
<urban_score>10</urban_score>
<urban_distance>11</urban_distance>
<urban_duration>12</urban_duration>
<night_time_score>13</night_time_score>
<night_time_distance>14</night_time_distance>
<night_time_duration>15</night_time_duration>
<idling_score>16</idling_score>
<idling_duration>17</idling_duration>
<longest_idling_instance>18</longest_idling_instance>
<speed_ideal>19.1</speed_ideal>
<speed_exceeded>20.1</speed_exceeded>
<speed_score>21</speed_score>
<speeding_event_count>22</speeding_event_count>
<speeding_duration>23</speeding_duration>
<max_speed>24.1</max_speed>
<speed_15_count>25</speed_15_count>
<speed_45_count>26</speed_45_count>
<speed_55_count>27</speed_55_count>
<speed_65_count>28</speed_65_count>
<speed_20_count>29</speed_20_count>
<speed_30_count>30</speed_30_count>
<speed_40_count>31</speed_40_count>
<speed_50_count>32</speed_50_count>
<speed_60_count>33</speed_60_count>
<speed_70_count>34</speed_70_count>
<acceleration_score>35</acceleration_score>
<acceleration_event_count>36</acceleration_event_count>
<acceleration_level_1_events>37</acceleration_level_1_events>
<acceleration_level_2_events>38</acceleration_level_2_events>
<acceleration_level_3_events>39</acceleration_level_3_events>
<acceleration_max>40.1</acceleration_max>
<deceleration_score>41</deceleration_score>
<deceleration_event_count>42</deceleration_event_count>
<deceleration_level_1_events>43</deceleration_level_1_events>
<deceleration_level_2_events>44</deceleration_level_2_events>
<deceleration_level_3_events>45</deceleration_level_3_events>
<deceleration_max>46.1</deceleration_max>
<local_start_date>2025-04-27T16:20:51.1155722+00:00</local_start_date>
<local_end_date>2025-04-27T16:20:51.1155722+00:00</local_end_date>
<timezone>sample string 49</timezone>
<idling_event_count>50</idling_event_count>
<extended_idling_event_count>51</extended_idling_event_count>
<distance_score>52</distance_score>
<high_distance_journeys>53</high_distance_journeys>
<low_distance_journeys>54</low_distance_journeys>
<combined_distance>55</combined_distance>
<extra_urban_distance>56</extra_urban_distance>
<ideal_fuel_used>57.1</ideal_fuel_used>
<actual_fuel_used>58.1</actual_fuel_used>
</VehicleScore>
</ScoreList>
<Vin>sample string 2</Vin>
<Usdot>sample string 3</Usdot>
</VehicleScoreResponseModel>
<VehicleScoreResponseModel>
<ServiceID>1</ServiceID>
<ScoreList>
<VehicleScore>
<sys_service_id>1</sys_service_id>
<score_period>journey</score_period>
<score_type>fuel</score_type>
<sys_service_id_type_period>sample string 2</sys_service_id_type_period>
<start_date>2025-04-27T16:20:51.1155722+00:00</start_date>
<end_date>2025-04-27T16:20:51.1155722+00:00</end_date>
<last_journey_end_time>2025-04-27T16:20:51.1155722+00:00</last_journey_end_time>
<journey_count>6</journey_count>
<distance>7</distance>
<duration>8</duration>
<overall_score>9</overall_score>
<urban_score>10</urban_score>
<urban_distance>11</urban_distance>
<urban_duration>12</urban_duration>
<night_time_score>13</night_time_score>
<night_time_distance>14</night_time_distance>
<night_time_duration>15</night_time_duration>
<idling_score>16</idling_score>
<idling_duration>17</idling_duration>
<longest_idling_instance>18</longest_idling_instance>
<speed_ideal>19.1</speed_ideal>
<speed_exceeded>20.1</speed_exceeded>
<speed_score>21</speed_score>
<speeding_event_count>22</speeding_event_count>
<speeding_duration>23</speeding_duration>
<max_speed>24.1</max_speed>
<speed_15_count>25</speed_15_count>
<speed_45_count>26</speed_45_count>
<speed_55_count>27</speed_55_count>
<speed_65_count>28</speed_65_count>
<speed_20_count>29</speed_20_count>
<speed_30_count>30</speed_30_count>
<speed_40_count>31</speed_40_count>
<speed_50_count>32</speed_50_count>
<speed_60_count>33</speed_60_count>
<speed_70_count>34</speed_70_count>
<acceleration_score>35</acceleration_score>
<acceleration_event_count>36</acceleration_event_count>
<acceleration_level_1_events>37</acceleration_level_1_events>
<acceleration_level_2_events>38</acceleration_level_2_events>
<acceleration_level_3_events>39</acceleration_level_3_events>
<acceleration_max>40.1</acceleration_max>
<deceleration_score>41</deceleration_score>
<deceleration_event_count>42</deceleration_event_count>
<deceleration_level_1_events>43</deceleration_level_1_events>
<deceleration_level_2_events>44</deceleration_level_2_events>
<deceleration_level_3_events>45</deceleration_level_3_events>
<deceleration_max>46.1</deceleration_max>
<local_start_date>2025-04-27T16:20:51.1155722+00:00</local_start_date>
<local_end_date>2025-04-27T16:20:51.1155722+00:00</local_end_date>
<timezone>sample string 49</timezone>
<idling_event_count>50</idling_event_count>
<extended_idling_event_count>51</extended_idling_event_count>
<distance_score>52</distance_score>
<high_distance_journeys>53</high_distance_journeys>
<low_distance_journeys>54</low_distance_journeys>
<combined_distance>55</combined_distance>
<extra_urban_distance>56</extra_urban_distance>
<ideal_fuel_used>57.1</ideal_fuel_used>
<actual_fuel_used>58.1</actual_fuel_used>
</VehicleScore>
<VehicleScore>
<sys_service_id>1</sys_service_id>
<score_period>journey</score_period>
<score_type>fuel</score_type>
<sys_service_id_type_period>sample string 2</sys_service_id_type_period>
<start_date>2025-04-27T16:20:51.1155722+00:00</start_date>
<end_date>2025-04-27T16:20:51.1155722+00:00</end_date>
<last_journey_end_time>2025-04-27T16:20:51.1155722+00:00</last_journey_end_time>
<journey_count>6</journey_count>
<distance>7</distance>
<duration>8</duration>
<overall_score>9</overall_score>
<urban_score>10</urban_score>
<urban_distance>11</urban_distance>
<urban_duration>12</urban_duration>
<night_time_score>13</night_time_score>
<night_time_distance>14</night_time_distance>
<night_time_duration>15</night_time_duration>
<idling_score>16</idling_score>
<idling_duration>17</idling_duration>
<longest_idling_instance>18</longest_idling_instance>
<speed_ideal>19.1</speed_ideal>
<speed_exceeded>20.1</speed_exceeded>
<speed_score>21</speed_score>
<speeding_event_count>22</speeding_event_count>
<speeding_duration>23</speeding_duration>
<max_speed>24.1</max_speed>
<speed_15_count>25</speed_15_count>
<speed_45_count>26</speed_45_count>
<speed_55_count>27</speed_55_count>
<speed_65_count>28</speed_65_count>
<speed_20_count>29</speed_20_count>
<speed_30_count>30</speed_30_count>
<speed_40_count>31</speed_40_count>
<speed_50_count>32</speed_50_count>
<speed_60_count>33</speed_60_count>
<speed_70_count>34</speed_70_count>
<acceleration_score>35</acceleration_score>
<acceleration_event_count>36</acceleration_event_count>
<acceleration_level_1_events>37</acceleration_level_1_events>
<acceleration_level_2_events>38</acceleration_level_2_events>
<acceleration_level_3_events>39</acceleration_level_3_events>
<acceleration_max>40.1</acceleration_max>
<deceleration_score>41</deceleration_score>
<deceleration_event_count>42</deceleration_event_count>
<deceleration_level_1_events>43</deceleration_level_1_events>
<deceleration_level_2_events>44</deceleration_level_2_events>
<deceleration_level_3_events>45</deceleration_level_3_events>
<deceleration_max>46.1</deceleration_max>
<local_start_date>2025-04-27T16:20:51.1155722+00:00</local_start_date>
<local_end_date>2025-04-27T16:20:51.1155722+00:00</local_end_date>
<timezone>sample string 49</timezone>
<idling_event_count>50</idling_event_count>
<extended_idling_event_count>51</extended_idling_event_count>
<distance_score>52</distance_score>
<high_distance_journeys>53</high_distance_journeys>
<low_distance_journeys>54</low_distance_journeys>
<combined_distance>55</combined_distance>
<extra_urban_distance>56</extra_urban_distance>
<ideal_fuel_used>57.1</ideal_fuel_used>
<actual_fuel_used>58.1</actual_fuel_used>
</VehicleScore>
</ScoreList>
<Vin>sample string 2</Vin>
<Usdot>sample string 3</Usdot>
</VehicleScoreResponseModel>
</ArrayOfVehicleScoreResponseModel>