POST api/Vehicles/RetrieveVehiclesWithSummary
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:56:07.3793633+02:00",
"CreatedDateTo": "2024-10-16T22:56:07.3793633+02:00",
"SortOrder": 1,
"VehicleIds": [
1,
2,
3
],
"LastReportedDateFrom": "2024-10-16T22:56:07.3793633+02:00",
"LastReportedDateTo": "2024-10-16T22:56:07.3803395+02:00",
"PoisIds": [
1,
2,
3
],
"CurrentStatusId": 2,
"ComponentID": 3,
"RequestForExportToExcel": true,
"IsSummaryDataIncluded": true,
"IsVehicleDataIncluded": true,
"Token": "sample string 7",
"FreeText": "sample string 8",
"GroupIds": [
1,
2,
3
],
"FromIndex": 9,
"ToIndex": 10,
"IsWebCalling": true,
"RequestMode": "sample string 12",
"Client": "sample string 13",
"AppVersion": "sample string 14",
"AppOperatingSystem": "sample string 15",
"AppName": "sample string 16",
"MasterUserID": 17,
"IsRecurringRequest": true
}
text/html
Sample:
{"CreatedDateFrom":"2024-10-16T22:56:07.3793633+02:00","CreatedDateTo":"2024-10-16T22:56:07.3793633+02:00","SortOrder":1,"VehicleIds":[1,2,3],"LastReportedDateFrom":"2024-10-16T22:56:07.3793633+02:00","LastReportedDateTo":"2024-10-16T22:56:07.3803395+02:00","PoisIds":[1,2,3],"CurrentStatusId":2,"ComponentID":3,"RequestForExportToExcel":true,"IsSummaryDataIncluded":true,"IsVehicleDataIncluded":true,"Token":"sample string 7","FreeText":"sample string 8","GroupIds":[1,2,3],"FromIndex":9,"ToIndex":10,"IsWebCalling":true,"RequestMode":"sample string 12","Client":"sample string 13","AppVersion":"sample string 14","AppOperatingSystem":"sample string 15","AppName":"sample string 16","MasterUserID":17,"IsRecurringRequest":true}
application/xml, text/xml
Sample:
<APIVehicleWithSummaryRequest 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 16</AppName>
<AppOperatingSystem xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 15</AppOperatingSystem>
<AppVersion xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 14</AppVersion>
<Client xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 13</Client>
<FreeText xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 8</FreeText>
<FromIndex xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">9</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">17</MasterUserID>
<RequestMode xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 12</RequestMode>
<ToIndex xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">10</ToIndex>
<Token xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 7</Token>
<ComponentID>3</ComponentID>
<CreatedDateFrom>2024-10-16T22:56:07.3793633+02:00</CreatedDateFrom>
<CreatedDateTo>2024-10-16T22:56:07.3793633+02:00</CreatedDateTo>
<CurrentStatusId>2</CurrentStatusId>
<IsSummaryDataIncluded>true</IsSummaryDataIncluded>
<IsVehicleDataIncluded>true</IsVehicleDataIncluded>
<LastReportedDateFrom>2024-10-16T22:56:07.3793633+02:00</LastReportedDateFrom>
<LastReportedDateTo>2024-10-16T22:56:07.3803395+02:00</LastReportedDateTo>
<PoisIds 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>
</PoisIds>
<RequestForExportToExcel>true</RequestForExportToExcel>
<SortOrder>1</SortOrder>
<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>
</APIVehicleWithSummaryRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Response body formats
application/json, text/json
Sample:
{
"VehicleData": [
{
"ID": 1,
"RegistrationNumber": "sample string 2",
"Description": "sample string 3",
"Model": "sample string 4",
"Make": "sample string 5",
"ODO": 6.1,
"ChassisNumber": "sample string 7",
"LatestStreetAddress": "sample string 8",
"CurrentDriverName": "sample string 9",
"CurrentDriverId": 10,
"LatestStatusCode": "sample string 11",
"LastUpdatedOnToDisplay": "sample string 12",
"LastIncomingMessageOnToDisplay": "sample string 13",
"ImageName": "sample string 14",
"AccessRights": {
"HasRetrieveAccess": true,
"HasUpdateAccess": true,
"HasDeleteAccess": true,
"HasCreateAccess": true
},
"AccessRightIdCSV": "sample string 15"
},
{
"ID": 1,
"RegistrationNumber": "sample string 2",
"Description": "sample string 3",
"Model": "sample string 4",
"Make": "sample string 5",
"ODO": 6.1,
"ChassisNumber": "sample string 7",
"LatestStreetAddress": "sample string 8",
"CurrentDriverName": "sample string 9",
"CurrentDriverId": 10,
"LatestStatusCode": "sample string 11",
"LastUpdatedOnToDisplay": "sample string 12",
"LastIncomingMessageOnToDisplay": "sample string 13",
"ImageName": "sample string 14",
"AccessRights": {
"HasRetrieveAccess": true,
"HasUpdateAccess": true,
"HasDeleteAccess": true,
"HasCreateAccess": true
},
"AccessRightIdCSV": "sample string 15"
},
{
"ID": 1,
"RegistrationNumber": "sample string 2",
"Description": "sample string 3",
"Model": "sample string 4",
"Make": "sample string 5",
"ODO": 6.1,
"ChassisNumber": "sample string 7",
"LatestStreetAddress": "sample string 8",
"CurrentDriverName": "sample string 9",
"CurrentDriverId": 10,
"LatestStatusCode": "sample string 11",
"LastUpdatedOnToDisplay": "sample string 12",
"LastIncomingMessageOnToDisplay": "sample string 13",
"ImageName": "sample string 14",
"AccessRights": {
"HasRetrieveAccess": true,
"HasUpdateAccess": true,
"HasDeleteAccess": true,
"HasCreateAccess": true
},
"AccessRightIdCSV": "sample string 15"
}
],
"SummaryData": {
"AverageSpeed": 1.1,
"AverageDrivingTime": 2.1,
"AverageStopTime": 3.1,
"TotalVehicles": 4
},
"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","Description":"sample string 3","Model":"sample string 4","Make":"sample string 5","ODO":6.1,"ChassisNumber":"sample string 7","LatestStreetAddress":"sample string 8","CurrentDriverName":"sample string 9","CurrentDriverId":10,"LatestStatusCode":"sample string 11","LastUpdatedOnToDisplay":"sample string 12","LastIncomingMessageOnToDisplay":"sample string 13","ImageName":"sample string 14","AccessRights":{"HasRetrieveAccess":true,"HasUpdateAccess":true,"HasDeleteAccess":true,"HasCreateAccess":true},"AccessRightIdCSV":"sample string 15"},{"ID":1,"RegistrationNumber":"sample string 2","Description":"sample string 3","Model":"sample string 4","Make":"sample string 5","ODO":6.1,"ChassisNumber":"sample string 7","LatestStreetAddress":"sample string 8","CurrentDriverName":"sample string 9","CurrentDriverId":10,"LatestStatusCode":"sample string 11","LastUpdatedOnToDisplay":"sample string 12","LastIncomingMessageOnToDisplay":"sample string 13","ImageName":"sample string 14","AccessRights":{"HasRetrieveAccess":true,"HasUpdateAccess":true,"HasDeleteAccess":true,"HasCreateAccess":true},"AccessRightIdCSV":"sample string 15"},{"ID":1,"RegistrationNumber":"sample string 2","Description":"sample string 3","Model":"sample string 4","Make":"sample string 5","ODO":6.1,"ChassisNumber":"sample string 7","LatestStreetAddress":"sample string 8","CurrentDriverName":"sample string 9","CurrentDriverId":10,"LatestStatusCode":"sample string 11","LastUpdatedOnToDisplay":"sample string 12","LastIncomingMessageOnToDisplay":"sample string 13","ImageName":"sample string 14","AccessRights":{"HasRetrieveAccess":true,"HasUpdateAccess":true,"HasDeleteAccess":true,"HasCreateAccess":true},"AccessRightIdCSV":"sample string 15"}],"SummaryData":{"AverageSpeed":1.1,"AverageDrivingTime":2.1,"AverageStopTime":3.1,"TotalVehicles":4},"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:
<APIVehicleWithSummaryResponse 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>
<SummaryData>
<AverageDrivingTime>2.1</AverageDrivingTime>
<AverageSpeed>1.1</AverageSpeed>
<AverageStopTime>3.1</AverageStopTime>
<TotalVehicles>4</TotalVehicles>
</SummaryData>
<VehicleData>
<APIVehicleWithSummaryData>
<AccessRightIdCSV>sample string 15</AccessRightIdCSV>
<AccessRights xmlns:d4p1="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
<d4p1:HasCreateAccess>true</d4p1:HasCreateAccess>
<d4p1:HasDeleteAccess>true</d4p1:HasDeleteAccess>
<d4p1:HasRetrieveAccess>true</d4p1:HasRetrieveAccess>
<d4p1:HasUpdateAccess>true</d4p1:HasUpdateAccess>
</AccessRights>
<ChassisNumber>sample string 7</ChassisNumber>
<ColumnsForExport>sample string 17</ColumnsForExport>
<CurrentDriverId>10</CurrentDriverId>
<CurrentDriverName>sample string 9</CurrentDriverName>
<Description>sample string 3</Description>
<ExportFileDateTimeText>sample string 19</ExportFileDateTimeText>
<ExportFileHeaderNameText>sample string 18</ExportFileHeaderNameText>
<ID>1</ID>
<ImageName>sample string 14</ImageName>
<LastIncomingMessageOn>2024-10-16T22:56:07.4096343+02:00</LastIncomingMessageOn>
<LastIncomingMessageOnToDisplay>sample string 13</LastIncomingMessageOnToDisplay>
<LastUpdatedOn>2024-10-16T22:56:07.4096343+02:00</LastUpdatedOn>
<LastUpdatedOnToDisplay>sample string 12</LastUpdatedOnToDisplay>
<LatestStatusCode>sample string 11</LatestStatusCode>
<LatestStreetAddress>sample string 8</LatestStreetAddress>
<Make>sample string 5</Make>
<Model>sample string 4</Model>
<ODO>6.1</ODO>
<RegistrationNumber>sample string 2</RegistrationNumber>
<TotalDriveTime>16</TotalDriveTime>
</APIVehicleWithSummaryData>
<APIVehicleWithSummaryData>
<AccessRightIdCSV>sample string 15</AccessRightIdCSV>
<AccessRights xmlns:d4p1="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
<d4p1:HasCreateAccess>true</d4p1:HasCreateAccess>
<d4p1:HasDeleteAccess>true</d4p1:HasDeleteAccess>
<d4p1:HasRetrieveAccess>true</d4p1:HasRetrieveAccess>
<d4p1:HasUpdateAccess>true</d4p1:HasUpdateAccess>
</AccessRights>
<ChassisNumber>sample string 7</ChassisNumber>
<ColumnsForExport>sample string 17</ColumnsForExport>
<CurrentDriverId>10</CurrentDriverId>
<CurrentDriverName>sample string 9</CurrentDriverName>
<Description>sample string 3</Description>
<ExportFileDateTimeText>sample string 19</ExportFileDateTimeText>
<ExportFileHeaderNameText>sample string 18</ExportFileHeaderNameText>
<ID>1</ID>
<ImageName>sample string 14</ImageName>
<LastIncomingMessageOn>2024-10-16T22:56:07.4096343+02:00</LastIncomingMessageOn>
<LastIncomingMessageOnToDisplay>sample string 13</LastIncomingMessageOnToDisplay>
<LastUpdatedOn>2024-10-16T22:56:07.4096343+02:00</LastUpdatedOn>
<LastUpdatedOnToDisplay>sample string 12</LastUpdatedOnToDisplay>
<LatestStatusCode>sample string 11</LatestStatusCode>
<LatestStreetAddress>sample string 8</LatestStreetAddress>
<Make>sample string 5</Make>
<Model>sample string 4</Model>
<ODO>6.1</ODO>
<RegistrationNumber>sample string 2</RegistrationNumber>
<TotalDriveTime>16</TotalDriveTime>
</APIVehicleWithSummaryData>
<APIVehicleWithSummaryData>
<AccessRightIdCSV>sample string 15</AccessRightIdCSV>
<AccessRights xmlns:d4p1="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
<d4p1:HasCreateAccess>true</d4p1:HasCreateAccess>
<d4p1:HasDeleteAccess>true</d4p1:HasDeleteAccess>
<d4p1:HasRetrieveAccess>true</d4p1:HasRetrieveAccess>
<d4p1:HasUpdateAccess>true</d4p1:HasUpdateAccess>
</AccessRights>
<ChassisNumber>sample string 7</ChassisNumber>
<ColumnsForExport>sample string 17</ColumnsForExport>
<CurrentDriverId>10</CurrentDriverId>
<CurrentDriverName>sample string 9</CurrentDriverName>
<Description>sample string 3</Description>
<ExportFileDateTimeText>sample string 19</ExportFileDateTimeText>
<ExportFileHeaderNameText>sample string 18</ExportFileHeaderNameText>
<ID>1</ID>
<ImageName>sample string 14</ImageName>
<LastIncomingMessageOn>2024-10-16T22:56:07.4096343+02:00</LastIncomingMessageOn>
<LastIncomingMessageOnToDisplay>sample string 13</LastIncomingMessageOnToDisplay>
<LastUpdatedOn>2024-10-16T22:56:07.4096343+02:00</LastUpdatedOn>
<LastUpdatedOnToDisplay>sample string 12</LastUpdatedOnToDisplay>
<LatestStatusCode>sample string 11</LatestStatusCode>
<LatestStreetAddress>sample string 8</LatestStreetAddress>
<Make>sample string 5</Make>
<Model>sample string 4</Model>
<ODO>6.1</ODO>
<RegistrationNumber>sample string 2</RegistrationNumber>
<TotalDriveTime>16</TotalDriveTime>
</APIVehicleWithSummaryData>
</VehicleData>
</APIVehicleWithSummaryResponse>