POST api/Vehicles/RetrieveVehiclePosition

Retrieves a list of vehicles.

Request Information

Parameters

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

Request body formats

application/json, text/json

Sample:

{
  "CreatedDateFrom": "2024-10-16T22:55:41.0034259+02:00",
  "CreatedDateTo": "2024-10-16T22:55:41.0034259+02:00",
  "SortOrder": 1,
  "VehicleIds": [
    1,
    2,
    3
  ],
  "LastReportedDateFrom": "2024-10-16T22:55:41.0034259+02:00",
  "LastReportedDateTo": "2024-10-16T22:55:41.0034259+02:00",
  "DriverIds": [
    1,
    2,
    3
  ],
  "Status": true,
  "ComponentID": 2,
  "EntityIds": [
    1,
    2,
    3
  ],
  "WSSessionUID": "sample string 3",
  "Token": "sample string 4",
  "FreeText": "sample string 5",
  "GroupIds": [
    1,
    2,
    3
  ],
  "FromIndex": 6,
  "ToIndex": 7,
  "IsWebCalling": true,
  "RequestMode": "sample string 9",
  "Client": "sample string 10",
  "AppVersion": "sample string 11",
  "AppOperatingSystem": "sample string 12",
  "AppName": "sample string 13",
  "MasterUserID": 14,
  "IsRecurringRequest": true
}

text/html

Sample:

{"CreatedDateFrom":"2024-10-16T22:55:41.0034259+02:00","CreatedDateTo":"2024-10-16T22:55:41.0034259+02:00","SortOrder":1,"VehicleIds":[1,2,3],"LastReportedDateFrom":"2024-10-16T22:55:41.0034259+02:00","LastReportedDateTo":"2024-10-16T22:55:41.0034259+02:00","DriverIds":[1,2,3],"Status":true,"ComponentID":2,"EntityIds":[1,2,3],"WSSessionUID":"sample string 3","Token":"sample string 4","FreeText":"sample string 5","GroupIds":[1,2,3],"FromIndex":6,"ToIndex":7,"IsWebCalling":true,"RequestMode":"sample string 9","Client":"sample string 10","AppVersion":"sample string 11","AppOperatingSystem":"sample string 12","AppName":"sample string 13","MasterUserID":14,"IsRecurringRequest":true}

application/xml, text/xml

Sample:

<APIVehiclePositionRequest 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 13</AppName>
  <AppOperatingSystem xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 12</AppOperatingSystem>
  <AppVersion xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 11</AppVersion>
  <Client xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 10</Client>
  <FreeText xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 5</FreeText>
  <FromIndex xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">6</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">14</MasterUserID>
  <RequestMode xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 9</RequestMode>
  <ToIndex xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">7</ToIndex>
  <Token xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 4</Token>
  <ComponentID>2</ComponentID>
  <CreatedDateFrom>2024-10-16T22:55:41.0034259+02:00</CreatedDateFrom>
  <CreatedDateTo>2024-10-16T22:55:41.0034259+02:00</CreatedDateTo>
  <DriverIds 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>
  </DriverIds>
  <EntityIds 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>
  </EntityIds>
  <LastReportedDateFrom>2024-10-16T22:55:41.0034259+02:00</LastReportedDateFrom>
  <LastReportedDateTo>2024-10-16T22:55:41.0034259+02:00</LastReportedDateTo>
  <SortOrder>1</SortOrder>
  <Status>true</Status>
  <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>
  <WSSessionUID>sample string 3</WSSessionUID>
</APIVehiclePositionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "VehicleData": [
    {
      "ID": 1,
      "DriverID": 2,
      "LatestLatitude": 3.1,
      "LatestLongitude": 4.1,
      "IsVehicleRunning": true,
      "IsImmobilized": true,
      "IsPanicMode": true,
      "StatusText": "sample string 8",
      "LastIncomingMessageOn": "2024-10-16T22:55:41.0210055+02:00",
      "RegistrationNumber": "sample string 9",
      "StatusColor": "sample string 10",
      "StatusPriority": 1,
      "LastHeading": 1.1,
      "IsLastStatusHide": true,
      "LatestStreetAddress": "sample string 11",
      "DriverName": "sample string 12",
      "Make": "sample string 13",
      "Model": "sample string 14",
      "Description": "sample string 15",
      "MarkerColor": "sample string 16"
    },
    {
      "ID": 1,
      "DriverID": 2,
      "LatestLatitude": 3.1,
      "LatestLongitude": 4.1,
      "IsVehicleRunning": true,
      "IsImmobilized": true,
      "IsPanicMode": true,
      "StatusText": "sample string 8",
      "LastIncomingMessageOn": "2024-10-16T22:55:41.0210055+02:00",
      "RegistrationNumber": "sample string 9",
      "StatusColor": "sample string 10",
      "StatusPriority": 1,
      "LastHeading": 1.1,
      "IsLastStatusHide": true,
      "LatestStreetAddress": "sample string 11",
      "DriverName": "sample string 12",
      "Make": "sample string 13",
      "Model": "sample string 14",
      "Description": "sample string 15",
      "MarkerColor": "sample string 16"
    },
    {
      "ID": 1,
      "DriverID": 2,
      "LatestLatitude": 3.1,
      "LatestLongitude": 4.1,
      "IsVehicleRunning": true,
      "IsImmobilized": true,
      "IsPanicMode": true,
      "StatusText": "sample string 8",
      "LastIncomingMessageOn": "2024-10-16T22:55:41.0210055+02:00",
      "RegistrationNumber": "sample string 9",
      "StatusColor": "sample string 10",
      "StatusPriority": 1,
      "LastHeading": 1.1,
      "IsLastStatusHide": true,
      "LatestStreetAddress": "sample string 11",
      "DriverName": "sample string 12",
      "Make": "sample string 13",
      "Model": "sample string 14",
      "Description": "sample string 15",
      "MarkerColor": "sample string 16"
    }
  ],
  "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,"DriverID":2,"LatestLatitude":3.1,"LatestLongitude":4.1,"IsVehicleRunning":true,"IsImmobilized":true,"IsPanicMode":true,"StatusText":"sample string 8","LastIncomingMessageOn":"2024-10-16T22:55:41.0210055+02:00","RegistrationNumber":"sample string 9","StatusColor":"sample string 10","StatusPriority":1,"LastHeading":1.1,"IsLastStatusHide":true,"LatestStreetAddress":"sample string 11","DriverName":"sample string 12","Make":"sample string 13","Model":"sample string 14","Description":"sample string 15","MarkerColor":"sample string 16"},{"ID":1,"DriverID":2,"LatestLatitude":3.1,"LatestLongitude":4.1,"IsVehicleRunning":true,"IsImmobilized":true,"IsPanicMode":true,"StatusText":"sample string 8","LastIncomingMessageOn":"2024-10-16T22:55:41.0210055+02:00","RegistrationNumber":"sample string 9","StatusColor":"sample string 10","StatusPriority":1,"LastHeading":1.1,"IsLastStatusHide":true,"LatestStreetAddress":"sample string 11","DriverName":"sample string 12","Make":"sample string 13","Model":"sample string 14","Description":"sample string 15","MarkerColor":"sample string 16"},{"ID":1,"DriverID":2,"LatestLatitude":3.1,"LatestLongitude":4.1,"IsVehicleRunning":true,"IsImmobilized":true,"IsPanicMode":true,"StatusText":"sample string 8","LastIncomingMessageOn":"2024-10-16T22:55:41.0210055+02:00","RegistrationNumber":"sample string 9","StatusColor":"sample string 10","StatusPriority":1,"LastHeading":1.1,"IsLastStatusHide":true,"LatestStreetAddress":"sample string 11","DriverName":"sample string 12","Make":"sample string 13","Model":"sample string 14","Description":"sample string 15","MarkerColor":"sample string 16"}],"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:

<APIVehiclePositionResponse 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>
    <APIVehiclePositionData>
      <Description>sample string 15</Description>
      <DriverID>2</DriverID>
      <DriverName>sample string 12</DriverName>
      <ID>1</ID>
      <IsImmobilized>true</IsImmobilized>
      <IsLastStatusHide>true</IsLastStatusHide>
      <IsPanicMode>true</IsPanicMode>
      <IsVehicleRunning>true</IsVehicleRunning>
      <LastHeading>1.1</LastHeading>
      <LastIncomingMessageOn>2024-10-16T22:55:41.0210055+02:00</LastIncomingMessageOn>
      <LatestLatitude>3.1</LatestLatitude>
      <LatestLongitude>4.1</LatestLongitude>
      <LatestStreetAddress>sample string 11</LatestStreetAddress>
      <Make>sample string 13</Make>
      <MarkerColor>sample string 16</MarkerColor>
      <Model>sample string 14</Model>
      <RegistrationNumber>sample string 9</RegistrationNumber>
      <StatusColor>sample string 10</StatusColor>
      <StatusPriority>1</StatusPriority>
      <StatusText>sample string 8</StatusText>
    </APIVehiclePositionData>
    <APIVehiclePositionData>
      <Description>sample string 15</Description>
      <DriverID>2</DriverID>
      <DriverName>sample string 12</DriverName>
      <ID>1</ID>
      <IsImmobilized>true</IsImmobilized>
      <IsLastStatusHide>true</IsLastStatusHide>
      <IsPanicMode>true</IsPanicMode>
      <IsVehicleRunning>true</IsVehicleRunning>
      <LastHeading>1.1</LastHeading>
      <LastIncomingMessageOn>2024-10-16T22:55:41.0210055+02:00</LastIncomingMessageOn>
      <LatestLatitude>3.1</LatestLatitude>
      <LatestLongitude>4.1</LatestLongitude>
      <LatestStreetAddress>sample string 11</LatestStreetAddress>
      <Make>sample string 13</Make>
      <MarkerColor>sample string 16</MarkerColor>
      <Model>sample string 14</Model>
      <RegistrationNumber>sample string 9</RegistrationNumber>
      <StatusColor>sample string 10</StatusColor>
      <StatusPriority>1</StatusPriority>
      <StatusText>sample string 8</StatusText>
    </APIVehiclePositionData>
    <APIVehiclePositionData>
      <Description>sample string 15</Description>
      <DriverID>2</DriverID>
      <DriverName>sample string 12</DriverName>
      <ID>1</ID>
      <IsImmobilized>true</IsImmobilized>
      <IsLastStatusHide>true</IsLastStatusHide>
      <IsPanicMode>true</IsPanicMode>
      <IsVehicleRunning>true</IsVehicleRunning>
      <LastHeading>1.1</LastHeading>
      <LastIncomingMessageOn>2024-10-16T22:55:41.0210055+02:00</LastIncomingMessageOn>
      <LatestLatitude>3.1</LatestLatitude>
      <LatestLongitude>4.1</LatestLongitude>
      <LatestStreetAddress>sample string 11</LatestStreetAddress>
      <Make>sample string 13</Make>
      <MarkerColor>sample string 16</MarkerColor>
      <Model>sample string 14</Model>
      <RegistrationNumber>sample string 9</RegistrationNumber>
      <StatusColor>sample string 10</StatusColor>
      <StatusPriority>1</StatusPriority>
      <StatusText>sample string 8</StatusText>
    </APIVehiclePositionData>
  </VehicleData>
</APIVehiclePositionResponse>