POST api/Vehicles/RetrieveClosestVehicles

Retrieves vehicles along with distance and time from given point.

Request Information

Parameters

Name	Description	Additional information
request	Request Obj	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "StartLatitude": 1.1,
  "StartLongitude": 2.1,
  "EndLatitude": 1.1,
  "EndLongitude": 1.1,
  "VehicleIds": [
    1,
    2,
    3
  ],
  "Token": "sample string 3",
  "FreeText": "sample string 4",
  "GroupIds": [
    1,
    2,
    3
  ],
  "FromIndex": 5,
  "ToIndex": 6,
  "IsWebCalling": true,
  "RequestMode": "sample string 8",
  "Client": "sample string 9",
  "AppVersion": "sample string 10",
  "AppOperatingSystem": "sample string 11",
  "AppName": "sample string 12",
  "MasterUserID": 13,
  "IsRecurringRequest": true
}

text/html

Sample:

{"StartLatitude":1.1,"StartLongitude":2.1,"EndLatitude":1.1,"EndLongitude":1.1,"VehicleIds":[1,2,3],"Token":"sample string 3","FreeText":"sample string 4","GroupIds":[1,2,3],"FromIndex":5,"ToIndex":6,"IsWebCalling":true,"RequestMode":"sample string 8","Client":"sample string 9","AppVersion":"sample string 10","AppOperatingSystem":"sample string 11","AppName":"sample string 12","MasterUserID":13,"IsRecurringRequest":true}

application/xml, text/xml

Sample:

<APIClosestVehicleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Model.APIModels">
  <AppName xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 12</AppName>
  <AppOperatingSystem xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 11</AppOperatingSystem>
  <AppVersion xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 10</AppVersion>
  <Client xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 9</Client>
  <FreeText xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 4</FreeText>
  <FromIndex xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">5</FromIndex>
  <GroupIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </GroupIds>
  <IsRecurringRequest xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">true</IsRecurringRequest>
  <IsWebCalling xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">true</IsWebCalling>
  <MasterUserID xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">13</MasterUserID>
  <RequestMode xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 8</RequestMode>
  <ToIndex xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">6</ToIndex>
  <Token xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 3</Token>
  <EndLatitude>1.1</EndLatitude>
  <EndLongitude>1.1</EndLongitude>
  <StartLatitude>1.1</StartLatitude>
  <StartLongitude>2.1</StartLongitude>
  <VehicleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </VehicleIds>
</APIClosestVehicleRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Vehicles

Response body formats

application/json, text/json

Sample:

{
  "VehicleData": [
    {
      "ID": 1,
      "RegistrationNumber": "sample string 2",
      "Make": "sample string 3",
      "Model": "sample string 4",
      "Distance": 5.1,
      "SecondsAway": 6.1,
      "LatestLatitude": 7.1,
      "LatestLongitude": 8.1,
      "DriverID": 1,
      "DriverName": "sample string 9",
      "IsVehicleRunning": true,
      "IsImmobilized": true,
      "IsPanicMode": true,
      "StatusText": "sample string 13",
      "LastReportedOn": "2024-10-16T22:57:19.7772156+02:00",
      "StatusColor": "sample string 14",
      "StatusPriority": 1,
      "LastHeading": 1.1
    },
    {
      "ID": 1,
      "RegistrationNumber": "sample string 2",
      "Make": "sample string 3",
      "Model": "sample string 4",
      "Distance": 5.1,
      "SecondsAway": 6.1,
      "LatestLatitude": 7.1,
      "LatestLongitude": 8.1,
      "DriverID": 1,
      "DriverName": "sample string 9",
      "IsVehicleRunning": true,
      "IsImmobilized": true,
      "IsPanicMode": true,
      "StatusText": "sample string 13",
      "LastReportedOn": "2024-10-16T22:57:19.7772156+02:00",
      "StatusColor": "sample string 14",
      "StatusPriority": 1,
      "LastHeading": 1.1
    },
    {
      "ID": 1,
      "RegistrationNumber": "sample string 2",
      "Make": "sample string 3",
      "Model": "sample string 4",
      "Distance": 5.1,
      "SecondsAway": 6.1,
      "LatestLatitude": 7.1,
      "LatestLongitude": 8.1,
      "DriverID": 1,
      "DriverName": "sample string 9",
      "IsVehicleRunning": true,
      "IsImmobilized": true,
      "IsPanicMode": true,
      "StatusText": "sample string 13",
      "LastReportedOn": "2024-10-16T22:57:19.7772156+02:00",
      "StatusColor": "sample string 14",
      "StatusPriority": 1,
      "LastHeading": 1.1
    }
  ],
  "Success": true,
  "ErrorMessage": "sample string 2",
  "MenuAccessData": {
    "HasAccessToMap": true,
    "HasAccessToVehicle": true,
    "HasAccessToVehicleAdministration": true,
    "HasAccessToDriver": true,
    "HasAccessToPOI": true,
    "HasAccessToReports": true,
    "HasAccessToSettings": true,
    "HasAccessToTrips": true,
    "HasAccessToTranslations": true,
    "HasAccessToDashboard": true,
    "HasAccessToLogBook": true,
    "HasAccessToGroup": true,
    "HasAccessToTemplate": true,
    "HasAccessToUnit": true,
    "HasAccessToUser": true,
    "HasAccessToTicket": true,
    "HasAccessToContract": true,
    "HasAccessToSIM": true,
    "HasAccessToCommand": true,
    "HasAccessToUnitProfile": true,
    "HasAccessToProfileTrigger": true,
    "HasAccessToScript": true,
    "HasAccessToTriggerSchedule": true
  },
  "StatusCode": 3,
  "ComponentFilterIds": [
    1,
    2,
    3
  ]
}

text/html

Sample:

{"VehicleData":[{"ID":1,"RegistrationNumber":"sample string 2","Make":"sample string 3","Model":"sample string 4","Distance":5.1,"SecondsAway":6.1,"LatestLatitude":7.1,"LatestLongitude":8.1,"DriverID":1,"DriverName":"sample string 9","IsVehicleRunning":true,"IsImmobilized":true,"IsPanicMode":true,"StatusText":"sample string 13","LastReportedOn":"2024-10-16T22:57:19.7772156+02:00","StatusColor":"sample string 14","StatusPriority":1,"LastHeading":1.1},{"ID":1,"RegistrationNumber":"sample string 2","Make":"sample string 3","Model":"sample string 4","Distance":5.1,"SecondsAway":6.1,"LatestLatitude":7.1,"LatestLongitude":8.1,"DriverID":1,"DriverName":"sample string 9","IsVehicleRunning":true,"IsImmobilized":true,"IsPanicMode":true,"StatusText":"sample string 13","LastReportedOn":"2024-10-16T22:57:19.7772156+02:00","StatusColor":"sample string 14","StatusPriority":1,"LastHeading":1.1},{"ID":1,"RegistrationNumber":"sample string 2","Make":"sample string 3","Model":"sample string 4","Distance":5.1,"SecondsAway":6.1,"LatestLatitude":7.1,"LatestLongitude":8.1,"DriverID":1,"DriverName":"sample string 9","IsVehicleRunning":true,"IsImmobilized":true,"IsPanicMode":true,"StatusText":"sample string 13","LastReportedOn":"2024-10-16T22:57:19.7772156+02:00","StatusColor":"sample string 14","StatusPriority":1,"LastHeading":1.1}],"Success":true,"ErrorMessage":"sample string 2","MenuAccessData":{"HasAccessToMap":true,"HasAccessToVehicle":true,"HasAccessToVehicleAdministration":true,"HasAccessToDriver":true,"HasAccessToPOI":true,"HasAccessToReports":true,"HasAccessToSettings":true,"HasAccessToTrips":true,"HasAccessToTranslations":true,"HasAccessToDashboard":true,"HasAccessToLogBook":true,"HasAccessToGroup":true,"HasAccessToTemplate":true,"HasAccessToUnit":true,"HasAccessToUser":true,"HasAccessToTicket":true,"HasAccessToContract":true,"HasAccessToSIM":true,"HasAccessToCommand":true,"HasAccessToUnitProfile":true,"HasAccessToProfileTrigger":true,"HasAccessToScript":true,"HasAccessToTriggerSchedule":true},"StatusCode":3,"ComponentFilterIds":[1,2,3]}

application/xml, text/xml

Sample:

<APIClosestVehicleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Model.APIModels">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Model.Transport">Success</ResponseCode>
  <ComponentFilterIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </ComponentFilterIds>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 2</ErrorMessage>
  <MenuAccessData xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
    <HasAccessToCommand>true</HasAccessToCommand>
    <HasAccessToContract>true</HasAccessToContract>
    <HasAccessToDashboard>true</HasAccessToDashboard>
    <HasAccessToDriver>true</HasAccessToDriver>
    <HasAccessToGroup>true</HasAccessToGroup>
    <HasAccessToLogBook>true</HasAccessToLogBook>
    <HasAccessToMap>true</HasAccessToMap>
    <HasAccessToPOI>true</HasAccessToPOI>
    <HasAccessToProfileTrigger>true</HasAccessToProfileTrigger>
    <HasAccessToReports>true</HasAccessToReports>
    <HasAccessToSIM>true</HasAccessToSIM>
    <HasAccessToScript>true</HasAccessToScript>
    <HasAccessToSettings>true</HasAccessToSettings>
    <HasAccessToTemplate>true</HasAccessToTemplate>
    <HasAccessToTicket>true</HasAccessToTicket>
    <HasAccessToTranslations>true</HasAccessToTranslations>
    <HasAccessToTriggerSchedule>true</HasAccessToTriggerSchedule>
    <HasAccessToTrips>true</HasAccessToTrips>
    <HasAccessToUnit>true</HasAccessToUnit>
    <HasAccessToUnitProfile>true</HasAccessToUnitProfile>
    <HasAccessToUser>true</HasAccessToUser>
    <HasAccessToVehicle>true</HasAccessToVehicle>
    <HasAccessToVehicleAdministration>true</HasAccessToVehicleAdministration>
  </MenuAccessData>
  <StatusCode xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">3</StatusCode>
  <Success xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">true</Success>
  <VehicleData>
    <APIClosestVehicleData>
      <Distance>5.1</Distance>
      <DriverID>1</DriverID>
      <DriverName>sample string 9</DriverName>
      <ID>1</ID>
      <IsImmobilized>true</IsImmobilized>
      <IsPanicMode>true</IsPanicMode>
      <IsVehicleRunning>true</IsVehicleRunning>
      <LastHeading>1.1</LastHeading>
      <LastReportedOn>2024-10-16T22:57:19.7772156+02:00</LastReportedOn>
      <LatestLatitude>7.1</LatestLatitude>
      <LatestLongitude>8.1</LatestLongitude>
      <Make>sample string 3</Make>
      <Model>sample string 4</Model>
      <RegistrationNumber>sample string 2</RegistrationNumber>
      <SecondsAway>6.1</SecondsAway>
      <StatusColor>sample string 14</StatusColor>
      <StatusPriority>1</StatusPriority>
      <StatusText>sample string 13</StatusText>
    </APIClosestVehicleData>
    <APIClosestVehicleData>
      <Distance>5.1</Distance>
      <DriverID>1</DriverID>
      <DriverName>sample string 9</DriverName>
      <ID>1</ID>
      <IsImmobilized>true</IsImmobilized>
      <IsPanicMode>true</IsPanicMode>
      <IsVehicleRunning>true</IsVehicleRunning>
      <LastHeading>1.1</LastHeading>
      <LastReportedOn>2024-10-16T22:57:19.7772156+02:00</LastReportedOn>
      <LatestLatitude>7.1</LatestLatitude>
      <LatestLongitude>8.1</LatestLongitude>
      <Make>sample string 3</Make>
      <Model>sample string 4</Model>
      <RegistrationNumber>sample string 2</RegistrationNumber>
      <SecondsAway>6.1</SecondsAway>
      <StatusColor>sample string 14</StatusColor>
      <StatusPriority>1</StatusPriority>
      <StatusText>sample string 13</StatusText>
    </APIClosestVehicleData>
    <APIClosestVehicleData>
      <Distance>5.1</Distance>
      <DriverID>1</DriverID>
      <DriverName>sample string 9</DriverName>
      <ID>1</ID>
      <IsImmobilized>true</IsImmobilized>
      <IsPanicMode>true</IsPanicMode>
      <IsVehicleRunning>true</IsVehicleRunning>
      <LastHeading>1.1</LastHeading>
      <LastReportedOn>2024-10-16T22:57:19.7772156+02:00</LastReportedOn>
      <LatestLatitude>7.1</LatestLatitude>
      <LatestLongitude>8.1</LatestLongitude>
      <Make>sample string 3</Make>
      <Model>sample string 4</Model>
      <RegistrationNumber>sample string 2</RegistrationNumber>
      <SecondsAway>6.1</SecondsAway>
      <StatusColor>sample string 14</StatusColor>
      <StatusPriority>1</StatusPriority>
      <StatusText>sample string 13</StatusText>
    </APIClosestVehicleData>
  </VehicleData>
</APIClosestVehicleResponse>