POST Api/TaskEx/GetTasks

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ClientID	globally unique identifier	None.
DriverID	globally unique identifier	None.
DriverCode	string	None.
FromDate	date	None.
ToDate	date	None.
TaskStatus	Collection of integer	None.
GroupID	globally unique identifier	None.
StopTypes	Collection of integer	None.
SubClientID	globally unique identifier	None.
TerritoryFenceID	globally unique identifier	None.
MerchantID	globally unique identifier	None.
TimeWindowID	globally unique identifier	None.
SearchText	string	None.
TimeWindowFilter	Collection of globally unique identifier	None.
IsGetPendingTasks	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientID": "a4c87140-a8be-412a-af2e-36614e66fdf2",
  "DriverID": "6392513b-4d7d-438a-8feb-f708513819bc",
  "DriverCode": "sample string 3",
  "FromDate": "2025-08-08T15:33:40.1122078+04:00",
  "ToDate": "2025-08-08T15:33:40.1122078+04:00",
  "TaskStatus": [
    1,
    2
  ],
  "GroupID": "40fa2633-0040-4264-902d-052912122036",
  "StopTypes": [
    1,
    2
  ],
  "SubClientID": "06c8172e-c05b-4da1-8105-2daa5fbdc3e5",
  "TerritoryFenceID": "a787427e-d17a-4bb8-9d72-3a11d4b606eb",
  "MerchantID": "104d0fbb-9e6d-4fde-9eec-154f6c5166bd",
  "TimeWindowID": "054268fa-9df9-486c-8d79-0a908ee9192d",
  "SearchText": "sample string 11",
  "TimeWindowFilter": [
    "01099f47-7e8b-47e8-99f3-e3f32f94f56f",
    "7b89672a-8c61-417e-b3aa-79e361164a28"
  ],
  "IsGetPendingTasks": true
}

application/xml, text/xml

Sample:

<TaskParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fleetroot.Entity.Tasks">
  <ClientID>a4c87140-a8be-412a-af2e-36614e66fdf2</ClientID>
  <DriverCode>sample string 3</DriverCode>
  <DriverID>6392513b-4d7d-438a-8feb-f708513819bc</DriverID>
  <FromDate>2025-08-08T15:33:40.1122078+04:00</FromDate>
  <GroupID>40fa2633-0040-4264-902d-052912122036</GroupID>
  <IsGetPendingTasks>true</IsGetPendingTasks>
  <MerchantID>104d0fbb-9e6d-4fde-9eec-154f6c5166bd</MerchantID>
  <SearchText>sample string 11</SearchText>
  <StopTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </StopTypes>
  <SubClientID>06c8172e-c05b-4da1-8105-2daa5fbdc3e5</SubClientID>
  <TaskStatus xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </TaskStatus>
  <TerritoryFenceID>a787427e-d17a-4bb8-9d72-3a11d4b606eb</TerritoryFenceID>
  <TimeWindowFilter xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>01099f47-7e8b-47e8-99f3-e3f32f94f56f</d2p1:guid>
    <d2p1:guid>7b89672a-8c61-417e-b3aa-79e361164a28</d2p1:guid>
  </TimeWindowFilter>
  <TimeWindowID>054268fa-9df9-486c-8d79-0a908ee9192d</TimeWindowID>
  <ToDate>2025-08-08T15:33:40.1122078+04:00</ToDate>
</TaskParameter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of TaskViewModel

Name	Type	Additional information
TaskID	globally unique identifier	None.
TaskOn	date	None.
CreatedOn	date	None.
Name	string	None.
Description	string	None.
RoutePoint	Collection of RoutePointInTask	None.
TimeWindow	TimeWindowViewModel	None.
TaskTracking	TaskTrackingViewModel	None.
ExpectedStartOn	time interval	None.
ExpectedEndOn	time interval	None.
Driver	DriverAssigned	None.
Vehicle	VehicleAssigned	None.
Priority	RoutePointPriority	None.
CategorySummary	Collection of CategorySummary	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "TaskID": "7d6aedef-9663-4f51-88ae-28dc1b473f0e",
    "TaskOn": "2025-08-08T15:33:40.1122078+04:00",
    "CreatedOn": "2025-08-08T15:33:40.1122078+04:00",
    "Name": "sample string 4",
    "Description": "sample string 5",
    "RoutePoint": [
      {
        "Id": "bd3afd59-8dbc-48c2-82d7-677e494158a8",
        "RoutePointName": "sample string 2",
        "RoutePointStatus": 0,
        "POIName": "sample string 3",
        "City": "sample string 4",
        "RoutePointInfo": {
          "Contact": {
            "Name": "sample string 1"
          },
          "Order": {
            "OrderID": "sample string 1"
          }
        },
        "TimeWindow": {
          "Name": "sample string 1",
          "FromTime": "00:00:00.1234567"
        },
        "ExpEndTime": "2025-08-08T15:33:40.1122078+04:00",
        "ActualEndTime": "2025-08-08T15:33:40.1122078+04:00",
        "ExpStartTime": "2025-08-08T15:33:40.1122078+04:00",
        "ActualStartTime": "2025-08-08T15:33:40.1122078+04:00",
        "QRCode": "sample string 9",
        "CurrentLat": 10.1,
        "CurrentLon": 11.1,
        "StopType": 0,
        "ParcelPlace": {
          "ParcelCount": 1,
          "PlaceType1": 0,
          "PlaceType2": 0,
          "PlaceType3": 0
        },
        "Priority": 0
      },
      {
        "Id": "bd3afd59-8dbc-48c2-82d7-677e494158a8",
        "RoutePointName": "sample string 2",
        "RoutePointStatus": 0,
        "POIName": "sample string 3",
        "City": "sample string 4",
        "RoutePointInfo": {
          "Contact": {
            "Name": "sample string 1"
          },
          "Order": {
            "OrderID": "sample string 1"
          }
        },
        "TimeWindow": {
          "Name": "sample string 1",
          "FromTime": "00:00:00.1234567"
        },
        "ExpEndTime": "2025-08-08T15:33:40.1122078+04:00",
        "ActualEndTime": "2025-08-08T15:33:40.1122078+04:00",
        "ExpStartTime": "2025-08-08T15:33:40.1122078+04:00",
        "ActualStartTime": "2025-08-08T15:33:40.1122078+04:00",
        "QRCode": "sample string 9",
        "CurrentLat": 10.1,
        "CurrentLon": 11.1,
        "StopType": 0,
        "ParcelPlace": {
          "ParcelCount": 1,
          "PlaceType1": 0,
          "PlaceType2": 0,
          "PlaceType3": 0
        },
        "Priority": 0
      }
    ],
    "TimeWindow": {
      "Name": "sample string 1",
      "FromTime": "00:00:00.1234567"
    },
    "TaskTracking": {
      "Status": 0,
      "TotalDistance": 1.1,
      "TotalExpTime": "00:00:00.1234567",
      "ActStartOn": "2025-08-08T15:33:40.1122078+04:00",
      "ActEndOn": "2025-08-08T15:33:40.1122078+04:00"
    },
    "ExpectedStartOn": "00:00:00.1234567",
    "ExpectedEndOn": "00:00:00.1234567",
    "Driver": {
      "DriverID": "3098ab78-15a3-4666-aa83-d4ab3f2ec30f",
      "Name": "sample string 2",
      "DriverCode": "sample string 3",
      "MobileNo": "sample string 4"
    },
    "Vehicle": {
      "VehicleID": "e72a969f-2dd0-41b7-afe6-c53a548acf60",
      "VehicleNo": "sample string 2"
    },
    "Priority": 0,
    "CategorySummary": [
      {
        "Name": "sample string 1",
        "Qty": 2
      },
      {
        "Name": "sample string 1",
        "Qty": 2
      }
    ]
  },
  {
    "TaskID": "7d6aedef-9663-4f51-88ae-28dc1b473f0e",
    "TaskOn": "2025-08-08T15:33:40.1122078+04:00",
    "CreatedOn": "2025-08-08T15:33:40.1122078+04:00",
    "Name": "sample string 4",
    "Description": "sample string 5",
    "RoutePoint": [
      {
        "Id": "bd3afd59-8dbc-48c2-82d7-677e494158a8",
        "RoutePointName": "sample string 2",
        "RoutePointStatus": 0,
        "POIName": "sample string 3",
        "City": "sample string 4",
        "RoutePointInfo": {
          "Contact": {
            "Name": "sample string 1"
          },
          "Order": {
            "OrderID": "sample string 1"
          }
        },
        "TimeWindow": {
          "Name": "sample string 1",
          "FromTime": "00:00:00.1234567"
        },
        "ExpEndTime": "2025-08-08T15:33:40.1122078+04:00",
        "ActualEndTime": "2025-08-08T15:33:40.1122078+04:00",
        "ExpStartTime": "2025-08-08T15:33:40.1122078+04:00",
        "ActualStartTime": "2025-08-08T15:33:40.1122078+04:00",
        "QRCode": "sample string 9",
        "CurrentLat": 10.1,
        "CurrentLon": 11.1,
        "StopType": 0,
        "ParcelPlace": {
          "ParcelCount": 1,
          "PlaceType1": 0,
          "PlaceType2": 0,
          "PlaceType3": 0
        },
        "Priority": 0
      },
      {
        "Id": "bd3afd59-8dbc-48c2-82d7-677e494158a8",
        "RoutePointName": "sample string 2",
        "RoutePointStatus": 0,
        "POIName": "sample string 3",
        "City": "sample string 4",
        "RoutePointInfo": {
          "Contact": {
            "Name": "sample string 1"
          },
          "Order": {
            "OrderID": "sample string 1"
          }
        },
        "TimeWindow": {
          "Name": "sample string 1",
          "FromTime": "00:00:00.1234567"
        },
        "ExpEndTime": "2025-08-08T15:33:40.1122078+04:00",
        "ActualEndTime": "2025-08-08T15:33:40.1122078+04:00",
        "ExpStartTime": "2025-08-08T15:33:40.1122078+04:00",
        "ActualStartTime": "2025-08-08T15:33:40.1122078+04:00",
        "QRCode": "sample string 9",
        "CurrentLat": 10.1,
        "CurrentLon": 11.1,
        "StopType": 0,
        "ParcelPlace": {
          "ParcelCount": 1,
          "PlaceType1": 0,
          "PlaceType2": 0,
          "PlaceType3": 0
        },
        "Priority": 0
      }
    ],
    "TimeWindow": {
      "Name": "sample string 1",
      "FromTime": "00:00:00.1234567"
    },
    "TaskTracking": {
      "Status": 0,
      "TotalDistance": 1.1,
      "TotalExpTime": "00:00:00.1234567",
      "ActStartOn": "2025-08-08T15:33:40.1122078+04:00",
      "ActEndOn": "2025-08-08T15:33:40.1122078+04:00"
    },
    "ExpectedStartOn": "00:00:00.1234567",
    "ExpectedEndOn": "00:00:00.1234567",
    "Driver": {
      "DriverID": "3098ab78-15a3-4666-aa83-d4ab3f2ec30f",
      "Name": "sample string 2",
      "DriverCode": "sample string 3",
      "MobileNo": "sample string 4"
    },
    "Vehicle": {
      "VehicleID": "e72a969f-2dd0-41b7-afe6-c53a548acf60",
      "VehicleNo": "sample string 2"
    },
    "Priority": 0,
    "CategorySummary": [
      {
        "Name": "sample string 1",
        "Qty": 2
      },
      {
        "Name": "sample string 1",
        "Qty": 2
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfTaskViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FleetrootDriver.Service.Models">
  <TaskViewModel>
    <CategorySummary xmlns:d3p1="http://schemas.datacontract.org/2004/07/Fleetroot.Entity.Tasks">
      <d3p1:CategorySummary>
        <d3p1:Name>sample string 1</d3p1:Name>
        <d3p1:Qty>2</d3p1:Qty>
      </d3p1:CategorySummary>
      <d3p1:CategorySummary>
        <d3p1:Name>sample string 1</d3p1:Name>
        <d3p1:Qty>2</d3p1:Qty>
      </d3p1:CategorySummary>
    </CategorySummary>
    <CreatedOn>2025-08-08T15:33:40.1122078+04:00</CreatedOn>
    <Description>sample string 5</Description>
    <Driver>
      <DriverCode>sample string 3</DriverCode>
      <DriverID>3098ab78-15a3-4666-aa83-d4ab3f2ec30f</DriverID>
      <MobileNo>sample string 4</MobileNo>
      <Name>sample string 2</Name>
    </Driver>
    <ExpectedEndOn>PT0.1234567S</ExpectedEndOn>
    <ExpectedStartOn>PT0.1234567S</ExpectedStartOn>
    <Name>sample string 4</Name>
    <RoutePoint>
      <RoutePointInTask>
        <ActualEndTime>2025-08-08T15:33:40.1122078+04:00</ActualEndTime>
        <ActualStartTime>2025-08-08T15:33:40.1122078+04:00</ActualStartTime>
        <City>sample string 4</City>
        <CurrentLat>10.1</CurrentLat>
        <CurrentLon>11.1</CurrentLon>
        <ExpEndTime>2025-08-08T15:33:40.1122078+04:00</ExpEndTime>
        <ExpStartTime>2025-08-08T15:33:40.1122078+04:00</ExpStartTime>
        <Id>bd3afd59-8dbc-48c2-82d7-677e494158a8</Id>
        <POIName>sample string 3</POIName>
        <ParcelPlace xmlns:d5p1="http://schemas.datacontract.org/2004/07/Fleetroot.Entity">
          <d5p1:ParcelCount>1</d5p1:ParcelCount>
          <d5p1:PlaceType1>None</d5p1:PlaceType1>
          <d5p1:PlaceType2>None</d5p1:PlaceType2>
          <d5p1:PlaceType3>None</d5p1:PlaceType3>
        </ParcelPlace>
        <Priority>Standard</Priority>
        <QRCode>sample string 9</QRCode>
        <RoutePointInfo>
          <Contact>
            <Name>sample string 1</Name>
          </Contact>
          <Order>
            <OrderID>sample string 1</OrderID>
          </Order>
        </RoutePointInfo>
        <RoutePointName>sample string 2</RoutePointName>
        <RoutePointStatus>None</RoutePointStatus>
        <StopType>None</StopType>
        <TimeWindow>
          <FromTime>PT0.1234567S</FromTime>
          <Name>sample string 1</Name>
        </TimeWindow>
      </RoutePointInTask>
      <RoutePointInTask>
        <ActualEndTime>2025-08-08T15:33:40.1122078+04:00</ActualEndTime>
        <ActualStartTime>2025-08-08T15:33:40.1122078+04:00</ActualStartTime>
        <City>sample string 4</City>
        <CurrentLat>10.1</CurrentLat>
        <CurrentLon>11.1</CurrentLon>
        <ExpEndTime>2025-08-08T15:33:40.1122078+04:00</ExpEndTime>
        <ExpStartTime>2025-08-08T15:33:40.1122078+04:00</ExpStartTime>
        <Id>bd3afd59-8dbc-48c2-82d7-677e494158a8</Id>
        <POIName>sample string 3</POIName>
        <ParcelPlace xmlns:d5p1="http://schemas.datacontract.org/2004/07/Fleetroot.Entity">
          <d5p1:ParcelCount>1</d5p1:ParcelCount>
          <d5p1:PlaceType1>None</d5p1:PlaceType1>
          <d5p1:PlaceType2>None</d5p1:PlaceType2>
          <d5p1:PlaceType3>None</d5p1:PlaceType3>
        </ParcelPlace>
        <Priority>Standard</Priority>
        <QRCode>sample string 9</QRCode>
        <RoutePointInfo>
          <Contact>
            <Name>sample string 1</Name>
          </Contact>
          <Order>
            <OrderID>sample string 1</OrderID>
          </Order>
        </RoutePointInfo>
        <RoutePointName>sample string 2</RoutePointName>
        <RoutePointStatus>None</RoutePointStatus>
        <StopType>None</StopType>
        <TimeWindow>
          <FromTime>PT0.1234567S</FromTime>
          <Name>sample string 1</Name>
        </TimeWindow>
      </RoutePointInTask>
    </RoutePoint>
    <TaskID>7d6aedef-9663-4f51-88ae-28dc1b473f0e</TaskID>
    <TaskOn>2025-08-08T15:33:40.1122078+04:00</TaskOn>
    <TaskTracking>
      <ActEndOn>2025-08-08T15:33:40.1122078+04:00</ActEndOn>
      <ActStartOn>2025-08-08T15:33:40.1122078+04:00</ActStartOn>
      <Status>Unassigned</Status>
      <TotalDistance>1.1</TotalDistance>
      <TotalExpTime>PT0.1234567S</TotalExpTime>
    </TaskTracking>
    <TimeWindow>
      <FromTime>PT0.1234567S</FromTime>
      <Name>sample string 1</Name>
    </TimeWindow>
    <Vehicle>
      <VehicleID>e72a969f-2dd0-41b7-afe6-c53a548acf60</VehicleID>
      <VehicleNo>sample string 2</VehicleNo>
    </Vehicle>
  </TaskViewModel>
  <TaskViewModel>
    <CategorySummary xmlns:d3p1="http://schemas.datacontract.org/2004/07/Fleetroot.Entity.Tasks">
      <d3p1:CategorySummary>
        <d3p1:Name>sample string 1</d3p1:Name>
        <d3p1:Qty>2</d3p1:Qty>
      </d3p1:CategorySummary>
      <d3p1:CategorySummary>
        <d3p1:Name>sample string 1</d3p1:Name>
        <d3p1:Qty>2</d3p1:Qty>
      </d3p1:CategorySummary>
    </CategorySummary>
    <CreatedOn>2025-08-08T15:33:40.1122078+04:00</CreatedOn>
    <Description>sample string 5</Description>
    <Driver>
      <DriverCode>sample string 3</DriverCode>
      <DriverID>3098ab78-15a3-4666-aa83-d4ab3f2ec30f</DriverID>
      <MobileNo>sample string 4</MobileNo>
      <Name>sample string 2</Name>
    </Driver>
    <ExpectedEndOn>PT0.1234567S</ExpectedEndOn>
    <ExpectedStartOn>PT0.1234567S</ExpectedStartOn>
    <Name>sample string 4</Name>
    <RoutePoint>
      <RoutePointInTask>
        <ActualEndTime>2025-08-08T15:33:40.1122078+04:00</ActualEndTime>
        <ActualStartTime>2025-08-08T15:33:40.1122078+04:00</ActualStartTime>
        <City>sample string 4</City>
        <CurrentLat>10.1</CurrentLat>
        <CurrentLon>11.1</CurrentLon>
        <ExpEndTime>2025-08-08T15:33:40.1122078+04:00</ExpEndTime>
        <ExpStartTime>2025-08-08T15:33:40.1122078+04:00</ExpStartTime>
        <Id>bd3afd59-8dbc-48c2-82d7-677e494158a8</Id>
        <POIName>sample string 3</POIName>
        <ParcelPlace xmlns:d5p1="http://schemas.datacontract.org/2004/07/Fleetroot.Entity">
          <d5p1:ParcelCount>1</d5p1:ParcelCount>
          <d5p1:PlaceType1>None</d5p1:PlaceType1>
          <d5p1:PlaceType2>None</d5p1:PlaceType2>
          <d5p1:PlaceType3>None</d5p1:PlaceType3>
        </ParcelPlace>
        <Priority>Standard</Priority>
        <QRCode>sample string 9</QRCode>
        <RoutePointInfo>
          <Contact>
            <Name>sample string 1</Name>
          </Contact>
          <Order>
            <OrderID>sample string 1</OrderID>
          </Order>
        </RoutePointInfo>
        <RoutePointName>sample string 2</RoutePointName>
        <RoutePointStatus>None</RoutePointStatus>
        <StopType>None</StopType>
        <TimeWindow>
          <FromTime>PT0.1234567S</FromTime>
          <Name>sample string 1</Name>
        </TimeWindow>
      </RoutePointInTask>
      <RoutePointInTask>
        <ActualEndTime>2025-08-08T15:33:40.1122078+04:00</ActualEndTime>
        <ActualStartTime>2025-08-08T15:33:40.1122078+04:00</ActualStartTime>
        <City>sample string 4</City>
        <CurrentLat>10.1</CurrentLat>
        <CurrentLon>11.1</CurrentLon>
        <ExpEndTime>2025-08-08T15:33:40.1122078+04:00</ExpEndTime>
        <ExpStartTime>2025-08-08T15:33:40.1122078+04:00</ExpStartTime>
        <Id>bd3afd59-8dbc-48c2-82d7-677e494158a8</Id>
        <POIName>sample string 3</POIName>
        <ParcelPlace xmlns:d5p1="http://schemas.datacontract.org/2004/07/Fleetroot.Entity">
          <d5p1:ParcelCount>1</d5p1:ParcelCount>
          <d5p1:PlaceType1>None</d5p1:PlaceType1>
          <d5p1:PlaceType2>None</d5p1:PlaceType2>
          <d5p1:PlaceType3>None</d5p1:PlaceType3>
        </ParcelPlace>
        <Priority>Standard</Priority>
        <QRCode>sample string 9</QRCode>
        <RoutePointInfo>
          <Contact>
            <Name>sample string 1</Name>
          </Contact>
          <Order>
            <OrderID>sample string 1</OrderID>
          </Order>
        </RoutePointInfo>
        <RoutePointName>sample string 2</RoutePointName>
        <RoutePointStatus>None</RoutePointStatus>
        <StopType>None</StopType>
        <TimeWindow>
          <FromTime>PT0.1234567S</FromTime>
          <Name>sample string 1</Name>
        </TimeWindow>
      </RoutePointInTask>
    </RoutePoint>
    <TaskID>7d6aedef-9663-4f51-88ae-28dc1b473f0e</TaskID>
    <TaskOn>2025-08-08T15:33:40.1122078+04:00</TaskOn>
    <TaskTracking>
      <ActEndOn>2025-08-08T15:33:40.1122078+04:00</ActEndOn>
      <ActStartOn>2025-08-08T15:33:40.1122078+04:00</ActStartOn>
      <Status>Unassigned</Status>
      <TotalDistance>1.1</TotalDistance>
      <TotalExpTime>PT0.1234567S</TotalExpTime>
    </TaskTracking>
    <TimeWindow>
      <FromTime>PT0.1234567S</FromTime>
      <Name>sample string 1</Name>
    </TimeWindow>
    <Vehicle>
      <VehicleID>e72a969f-2dd0-41b7-afe6-c53a548acf60</VehicleID>
      <VehicleNo>sample string 2</VehicleNo>
    </Vehicle>
  </TaskViewModel>
</ArrayOfTaskViewModel>

Api Documentation

POST Api/TaskEx/GetTasks

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml