POST api/Trips/RetrieveLogBookDrivers
Retrieves the list of trips.
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
req |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{ "Month": 1, "Year": 2, "SortOrder": 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:
{"Month":1,"Year":2,"SortOrder":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:
<APITripLogBookDriversDataRequest 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> <Month>1</Month> <SortOrder>3</SortOrder> <Year>2</Year> </APITripLogBookDriversDataRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Response body formats
application/json, text/json
Sample:
{ "LogBookDriversData": [ { "RowIndex": 1, "DriverID": 2, "MonthValue": "sample string 3", "YearValue": "sample string 4", "DriverName": "sample string 5", "MonthlyTripStatus": "sample string 6", "TotalPrivateDistance": 7.1, "TotalBusinessDistance": 8.1, "TotalDistance": 9.1, "GroupID": 10, "DriverNameInitials": "sample string 11" }, { "RowIndex": 1, "DriverID": 2, "MonthValue": "sample string 3", "YearValue": "sample string 4", "DriverName": "sample string 5", "MonthlyTripStatus": "sample string 6", "TotalPrivateDistance": 7.1, "TotalBusinessDistance": 8.1, "TotalDistance": 9.1, "GroupID": 10, "DriverNameInitials": "sample string 11" }, { "RowIndex": 1, "DriverID": 2, "MonthValue": "sample string 3", "YearValue": "sample string 4", "DriverName": "sample string 5", "MonthlyTripStatus": "sample string 6", "TotalPrivateDistance": 7.1, "TotalBusinessDistance": 8.1, "TotalDistance": 9.1, "GroupID": 10, "DriverNameInitials": "sample string 11" } ], "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:
{"LogBookDriversData":[{"RowIndex":1,"DriverID":2,"MonthValue":"sample string 3","YearValue":"sample string 4","DriverName":"sample string 5","MonthlyTripStatus":"sample string 6","TotalPrivateDistance":7.1,"TotalBusinessDistance":8.1,"TotalDistance":9.1,"GroupID":10,"DriverNameInitials":"sample string 11"},{"RowIndex":1,"DriverID":2,"MonthValue":"sample string 3","YearValue":"sample string 4","DriverName":"sample string 5","MonthlyTripStatus":"sample string 6","TotalPrivateDistance":7.1,"TotalBusinessDistance":8.1,"TotalDistance":9.1,"GroupID":10,"DriverNameInitials":"sample string 11"},{"RowIndex":1,"DriverID":2,"MonthValue":"sample string 3","YearValue":"sample string 4","DriverName":"sample string 5","MonthlyTripStatus":"sample string 6","TotalPrivateDistance":7.1,"TotalBusinessDistance":8.1,"TotalDistance":9.1,"GroupID":10,"DriverNameInitials":"sample string 11"}],"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:
<APITripLogBookDriversDataResponse 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> <LogBookDriversData> <APITripLogBookDriversData> <DriverID>2</DriverID> <DriverName>sample string 5</DriverName> <DriverNameInitials>sample string 11</DriverNameInitials> <GroupID>10</GroupID> <MonthValue>sample string 3</MonthValue> <MonthlyTripStatus>sample string 6</MonthlyTripStatus> <RowIndex>1</RowIndex> <TotalBusinessDistance>8.1</TotalBusinessDistance> <TotalDistance>9.1</TotalDistance> <TotalPrivateDistance>7.1</TotalPrivateDistance> <YearValue>sample string 4</YearValue> </APITripLogBookDriversData> <APITripLogBookDriversData> <DriverID>2</DriverID> <DriverName>sample string 5</DriverName> <DriverNameInitials>sample string 11</DriverNameInitials> <GroupID>10</GroupID> <MonthValue>sample string 3</MonthValue> <MonthlyTripStatus>sample string 6</MonthlyTripStatus> <RowIndex>1</RowIndex> <TotalBusinessDistance>8.1</TotalBusinessDistance> <TotalDistance>9.1</TotalDistance> <TotalPrivateDistance>7.1</TotalPrivateDistance> <YearValue>sample string 4</YearValue> </APITripLogBookDriversData> <APITripLogBookDriversData> <DriverID>2</DriverID> <DriverName>sample string 5</DriverName> <DriverNameInitials>sample string 11</DriverNameInitials> <GroupID>10</GroupID> <MonthValue>sample string 3</MonthValue> <MonthlyTripStatus>sample string 6</MonthlyTripStatus> <RowIndex>1</RowIndex> <TotalBusinessDistance>8.1</TotalBusinessDistance> <TotalDistance>9.1</TotalDistance> <TotalPrivateDistance>7.1</TotalPrivateDistance> <YearValue>sample string 4</YearValue> </APITripLogBookDriversData> </LogBookDriversData> </APITripLogBookDriversDataResponse>