POST api/Driver/RetrieveAllDrivers

Retrieves a list of drivers for drop down list.

Request Information

Parameters

Name	Description	Additional information
driverRequest	No documentation available.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "CreatedDateFrom": "2024-10-16T21:24:45.1234954+02:00",
  "CreatedDateTo": "2024-10-16T21:24:45.1234954+02:00",
  "DriverStatus": 1,
  "SortOrder": 2,
  "DriverIds": [
    1,
    2,
    3
  ],
  "LastReportedDateFrom": "2024-10-16T21:24:45.1234954+02:00",
  "LastReportedDateTo": "2024-10-16T21:24:45.1234954+02:00",
  "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:

{"CreatedDateFrom":"2024-10-16T21:24:45.1234954+02:00","CreatedDateTo":"2024-10-16T21:24:45.1234954+02:00","DriverStatus":1,"SortOrder":2,"DriverIds":[1,2,3],"LastReportedDateFrom":"2024-10-16T21:24:45.1234954+02:00","LastReportedDateTo":"2024-10-16T21:24:45.1234954+02:00","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:

<APIDriverRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
  <AppName>sample string 12</AppName>
  <AppOperatingSystem>sample string 11</AppOperatingSystem>
  <AppVersion>sample string 10</AppVersion>
  <Client>sample string 9</Client>
  <FreeText>sample string 4</FreeText>
  <FromIndex>5</FromIndex>
  <GroupIds 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>
  </GroupIds>
  <IsRecurringRequest>true</IsRecurringRequest>
  <IsWebCalling>true</IsWebCalling>
  <MasterUserID>13</MasterUserID>
  <RequestMode>sample string 8</RequestMode>
  <ToIndex>6</ToIndex>
  <Token>sample string 3</Token>
  <CreatedDateFrom>2024-10-16T21:24:45.1234954+02:00</CreatedDateFrom>
  <CreatedDateTo>2024-10-16T21:24:45.1234954+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>
  <DriverStatus>1</DriverStatus>
  <LastReportedDateFrom>2024-10-16T21:24:45.1234954+02:00</LastReportedDateFrom>
  <LastReportedDateTo>2024-10-16T21:24:45.1234954+02:00</LastReportedDateTo>
  <SortOrder>2</SortOrder>
</APIDriverRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Drivers list with access rights

Response body formats

application/json, text/json

Sample:

{
  "APIDdlBindDataWithGroupsModel": [
    {
      "ID": 1,
      "Name": "sample string 2",
      "GroupIdCsv": "sample string 3",
      "SecurableId": "50cb6c94-98ee-49b5-98bd-94e8291f6504",
      "DeviceVendor": "sample string 4"
    },
    {
      "ID": 1,
      "Name": "sample string 2",
      "GroupIdCsv": "sample string 3",
      "SecurableId": "50cb6c94-98ee-49b5-98bd-94e8291f6504",
      "DeviceVendor": "sample string 4"
    },
    {
      "ID": 1,
      "Name": "sample string 2",
      "GroupIdCsv": "sample string 3",
      "SecurableId": "50cb6c94-98ee-49b5-98bd-94e8291f6504",
      "DeviceVendor": "sample string 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:

{"APIDdlBindDataWithGroupsModel":[{"ID":1,"Name":"sample string 2","GroupIdCsv":"sample string 3","SecurableId":"50cb6c94-98ee-49b5-98bd-94e8291f6504","DeviceVendor":"sample string 4"},{"ID":1,"Name":"sample string 2","GroupIdCsv":"sample string 3","SecurableId":"50cb6c94-98ee-49b5-98bd-94e8291f6504","DeviceVendor":"sample string 4"},{"ID":1,"Name":"sample string 2","GroupIdCsv":"sample string 3","SecurableId":"50cb6c94-98ee-49b5-98bd-94e8291f6504","DeviceVendor":"sample string 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:

<APIDdlBindWithGroupsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.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">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </ComponentFilterIds>
  <ErrorMessage>sample string 2</ErrorMessage>
  <MenuAccessData>
    <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>3</StatusCode>
  <Success>true</Success>
  <APIDdlBindDataWithGroupsModel>
    <APIDdlBindDataWithGroups>
      <DeviceVendor>sample string 4</DeviceVendor>
      <GroupIdCsv>sample string 3</GroupIdCsv>
      <ID>1</ID>
      <Name>sample string 2</Name>
      <SecurableId>50cb6c94-98ee-49b5-98bd-94e8291f6504</SecurableId>
    </APIDdlBindDataWithGroups>
    <APIDdlBindDataWithGroups>
      <DeviceVendor>sample string 4</DeviceVendor>
      <GroupIdCsv>sample string 3</GroupIdCsv>
      <ID>1</ID>
      <Name>sample string 2</Name>
      <SecurableId>50cb6c94-98ee-49b5-98bd-94e8291f6504</SecurableId>
    </APIDdlBindDataWithGroups>
    <APIDdlBindDataWithGroups>
      <DeviceVendor>sample string 4</DeviceVendor>
      <GroupIdCsv>sample string 3</GroupIdCsv>
      <ID>1</ID>
      <Name>sample string 2</Name>
      <SecurableId>50cb6c94-98ee-49b5-98bd-94e8291f6504</SecurableId>
    </APIDdlBindDataWithGroups>
  </APIDdlBindDataWithGroupsModel>
</APIDdlBindWithGroupsResponse>