POST Api/TaskEx/GetTasks
Request Information
URI Parameters
None.
Body Parameters
TaskParameter| Name | Description | 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": "6b591843-017a-473f-b8aa-187ae48f87e2",
"DriverID": "94dacfcd-06a4-434e-ac27-9be3e6000d95",
"DriverCode": "sample string 3",
"FromDate": "2025-09-16T19:34:56.211673+04:00",
"ToDate": "2025-09-16T19:34:56.211673+04:00",
"TaskStatus": [
1,
2
],
"GroupID": "da7929c3-335f-4bb2-b73b-59b3b7bd6366",
"StopTypes": [
1,
2
],
"SubClientID": "8e69d976-0ab3-47cb-88ec-05583e3fc4de",
"TerritoryFenceID": "09e40202-20d1-43c4-b4b4-8a549972f62b",
"MerchantID": "d17ebc0e-c839-470c-bb80-b23b67f3404f",
"TimeWindowID": "0975a6dc-92d8-434b-a3e6-4f0dd94ea86a",
"SearchText": "sample string 11",
"TimeWindowFilter": [
"ff3cfd94-ff0f-4696-9ec8-d3a789d76623",
"1f81c75b-92a2-4de0-8e18-fdb50f7f4f50"
],
"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>6b591843-017a-473f-b8aa-187ae48f87e2</ClientID>
<DriverCode>sample string 3</DriverCode>
<DriverID>94dacfcd-06a4-434e-ac27-9be3e6000d95</DriverID>
<FromDate>2025-09-16T19:34:56.211673+04:00</FromDate>
<GroupID>da7929c3-335f-4bb2-b73b-59b3b7bd6366</GroupID>
<IsGetPendingTasks>true</IsGetPendingTasks>
<MerchantID>d17ebc0e-c839-470c-bb80-b23b67f3404f</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>8e69d976-0ab3-47cb-88ec-05583e3fc4de</SubClientID>
<TaskStatus xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</TaskStatus>
<TerritoryFenceID>09e40202-20d1-43c4-b4b4-8a549972f62b</TerritoryFenceID>
<TimeWindowFilter xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>ff3cfd94-ff0f-4696-9ec8-d3a789d76623</d2p1:guid>
<d2p1:guid>1f81c75b-92a2-4de0-8e18-fdb50f7f4f50</d2p1:guid>
</TimeWindowFilter>
<TimeWindowID>0975a6dc-92d8-434b-a3e6-4f0dd94ea86a</TimeWindowID>
<ToDate>2025-09-16T19:34:56.211673+04:00</ToDate>
</TaskParameter>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of TaskViewModel| Name | Description | 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": "f9976138-4d31-4354-8620-22de04ae2614",
"TaskOn": "2025-09-16T19:34:56.211673+04:00",
"CreatedOn": "2025-09-16T19:34:56.211673+04:00",
"Name": "sample string 4",
"Description": "sample string 5",
"RoutePoint": [
{
"Id": "de4e4240-4d8b-43dd-b799-d660e303a9c9",
"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-09-16T19:34:56.211673+04:00",
"ActualEndTime": "2025-09-16T19:34:56.211673+04:00",
"ExpStartTime": "2025-09-16T19:34:56.211673+04:00",
"ActualStartTime": "2025-09-16T19:34:56.211673+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": "de4e4240-4d8b-43dd-b799-d660e303a9c9",
"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-09-16T19:34:56.211673+04:00",
"ActualEndTime": "2025-09-16T19:34:56.211673+04:00",
"ExpStartTime": "2025-09-16T19:34:56.211673+04:00",
"ActualStartTime": "2025-09-16T19:34:56.211673+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-09-16T19:34:56.211673+04:00",
"ActEndOn": "2025-09-16T19:34:56.211673+04:00"
},
"ExpectedStartOn": "00:00:00.1234567",
"ExpectedEndOn": "00:00:00.1234567",
"Driver": {
"DriverID": "b2208e4d-1bfe-4d83-b0a2-41bfe3fd4a98",
"Name": "sample string 2",
"DriverCode": "sample string 3",
"MobileNo": "sample string 4"
},
"Vehicle": {
"VehicleID": "ab71b945-6588-4c52-9557-955c48c7a1ae",
"VehicleNo": "sample string 2"
},
"Priority": 0,
"CategorySummary": [
{
"Name": "sample string 1",
"Qty": 2
},
{
"Name": "sample string 1",
"Qty": 2
}
]
},
{
"TaskID": "f9976138-4d31-4354-8620-22de04ae2614",
"TaskOn": "2025-09-16T19:34:56.211673+04:00",
"CreatedOn": "2025-09-16T19:34:56.211673+04:00",
"Name": "sample string 4",
"Description": "sample string 5",
"RoutePoint": [
{
"Id": "de4e4240-4d8b-43dd-b799-d660e303a9c9",
"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-09-16T19:34:56.211673+04:00",
"ActualEndTime": "2025-09-16T19:34:56.211673+04:00",
"ExpStartTime": "2025-09-16T19:34:56.211673+04:00",
"ActualStartTime": "2025-09-16T19:34:56.211673+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": "de4e4240-4d8b-43dd-b799-d660e303a9c9",
"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-09-16T19:34:56.211673+04:00",
"ActualEndTime": "2025-09-16T19:34:56.211673+04:00",
"ExpStartTime": "2025-09-16T19:34:56.211673+04:00",
"ActualStartTime": "2025-09-16T19:34:56.211673+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-09-16T19:34:56.211673+04:00",
"ActEndOn": "2025-09-16T19:34:56.211673+04:00"
},
"ExpectedStartOn": "00:00:00.1234567",
"ExpectedEndOn": "00:00:00.1234567",
"Driver": {
"DriverID": "b2208e4d-1bfe-4d83-b0a2-41bfe3fd4a98",
"Name": "sample string 2",
"DriverCode": "sample string 3",
"MobileNo": "sample string 4"
},
"Vehicle": {
"VehicleID": "ab71b945-6588-4c52-9557-955c48c7a1ae",
"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-09-16T19:34:56.211673+04:00</CreatedOn>
<Description>sample string 5</Description>
<Driver>
<DriverCode>sample string 3</DriverCode>
<DriverID>b2208e4d-1bfe-4d83-b0a2-41bfe3fd4a98</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-09-16T19:34:56.211673+04:00</ActualEndTime>
<ActualStartTime>2025-09-16T19:34:56.211673+04:00</ActualStartTime>
<City>sample string 4</City>
<CurrentLat>10.1</CurrentLat>
<CurrentLon>11.1</CurrentLon>
<ExpEndTime>2025-09-16T19:34:56.211673+04:00</ExpEndTime>
<ExpStartTime>2025-09-16T19:34:56.211673+04:00</ExpStartTime>
<Id>de4e4240-4d8b-43dd-b799-d660e303a9c9</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-09-16T19:34:56.211673+04:00</ActualEndTime>
<ActualStartTime>2025-09-16T19:34:56.211673+04:00</ActualStartTime>
<City>sample string 4</City>
<CurrentLat>10.1</CurrentLat>
<CurrentLon>11.1</CurrentLon>
<ExpEndTime>2025-09-16T19:34:56.211673+04:00</ExpEndTime>
<ExpStartTime>2025-09-16T19:34:56.211673+04:00</ExpStartTime>
<Id>de4e4240-4d8b-43dd-b799-d660e303a9c9</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>f9976138-4d31-4354-8620-22de04ae2614</TaskID>
<TaskOn>2025-09-16T19:34:56.211673+04:00</TaskOn>
<TaskTracking>
<ActEndOn>2025-09-16T19:34:56.211673+04:00</ActEndOn>
<ActStartOn>2025-09-16T19:34:56.211673+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>ab71b945-6588-4c52-9557-955c48c7a1ae</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-09-16T19:34:56.211673+04:00</CreatedOn>
<Description>sample string 5</Description>
<Driver>
<DriverCode>sample string 3</DriverCode>
<DriverID>b2208e4d-1bfe-4d83-b0a2-41bfe3fd4a98</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-09-16T19:34:56.211673+04:00</ActualEndTime>
<ActualStartTime>2025-09-16T19:34:56.211673+04:00</ActualStartTime>
<City>sample string 4</City>
<CurrentLat>10.1</CurrentLat>
<CurrentLon>11.1</CurrentLon>
<ExpEndTime>2025-09-16T19:34:56.211673+04:00</ExpEndTime>
<ExpStartTime>2025-09-16T19:34:56.211673+04:00</ExpStartTime>
<Id>de4e4240-4d8b-43dd-b799-d660e303a9c9</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-09-16T19:34:56.211673+04:00</ActualEndTime>
<ActualStartTime>2025-09-16T19:34:56.211673+04:00</ActualStartTime>
<City>sample string 4</City>
<CurrentLat>10.1</CurrentLat>
<CurrentLon>11.1</CurrentLon>
<ExpEndTime>2025-09-16T19:34:56.211673+04:00</ExpEndTime>
<ExpStartTime>2025-09-16T19:34:56.211673+04:00</ExpStartTime>
<Id>de4e4240-4d8b-43dd-b799-d660e303a9c9</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>f9976138-4d31-4354-8620-22de04ae2614</TaskID>
<TaskOn>2025-09-16T19:34:56.211673+04:00</TaskOn>
<TaskTracking>
<ActEndOn>2025-09-16T19:34:56.211673+04:00</ActEndOn>
<ActStartOn>2025-09-16T19:34:56.211673+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>ab71b945-6588-4c52-9557-955c48c7a1ae</VehicleID>
<VehicleNo>sample string 2</VehicleNo>
</Vehicle>
</TaskViewModel>
</ArrayOfTaskViewModel>