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. |
|
| City | string |
None. |
|
| CityAndAreaID | globally unique identifier |
None. |
|
| IsGetPendingTasks | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"ClientID": "a51a95de-7184-4f86-a18f-aa118016005e",
"DriverID": "bb124953-3a2c-4d82-bd21-ce761b5dd17c",
"DriverCode": "sample string 3",
"FromDate": "2026-07-09T14:56:40.3584186+04:00",
"ToDate": "2026-07-09T14:56:40.3584186+04:00",
"TaskStatus": [
1,
2
],
"GroupID": "528e805a-73cb-43c7-9529-7fddb2166571",
"StopTypes": [
1,
2
],
"SubClientID": "15a0426d-15ea-415b-b32d-cdfe63d5f44e",
"TerritoryFenceID": "cad7de40-66b9-43d9-841a-c02f19304991",
"MerchantID": "b1922df3-5b5a-4890-b3e1-471e53f4d170",
"TimeWindowID": "f6f8d8d1-2e9c-4f45-8d12-8ac6b922609d",
"SearchText": "sample string 11",
"TimeWindowFilter": [
"8bb14de1-ef13-4428-b068-6d28d28d4385",
"af9d85f6-d3b9-4e68-984b-b24eb69188eb"
],
"City": "sample string 12",
"CityAndAreaID": "2347ac0e-c77f-42bb-816d-9887885e02d8",
"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">
<City>sample string 12</City>
<CityAndAreaID>2347ac0e-c77f-42bb-816d-9887885e02d8</CityAndAreaID>
<ClientID>a51a95de-7184-4f86-a18f-aa118016005e</ClientID>
<DriverCode>sample string 3</DriverCode>
<DriverID>bb124953-3a2c-4d82-bd21-ce761b5dd17c</DriverID>
<FromDate>2026-07-09T14:56:40.3584186+04:00</FromDate>
<GroupID>528e805a-73cb-43c7-9529-7fddb2166571</GroupID>
<IsGetPendingTasks>true</IsGetPendingTasks>
<MerchantID>b1922df3-5b5a-4890-b3e1-471e53f4d170</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>15a0426d-15ea-415b-b32d-cdfe63d5f44e</SubClientID>
<TaskStatus xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</TaskStatus>
<TerritoryFenceID>cad7de40-66b9-43d9-841a-c02f19304991</TerritoryFenceID>
<TimeWindowFilter xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>8bb14de1-ef13-4428-b068-6d28d28d4385</d2p1:guid>
<d2p1:guid>af9d85f6-d3b9-4e68-984b-b24eb69188eb</d2p1:guid>
</TimeWindowFilter>
<TimeWindowID>f6f8d8d1-2e9c-4f45-8d12-8ac6b922609d</TimeWindowID>
<ToDate>2026-07-09T14:56:40.3584186+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": "e9d4329e-79fe-4643-9d3d-f595332cc16f",
"TaskOn": "2026-07-09T14:56:40.3584186+04:00",
"CreatedOn": "2026-07-09T14:56:40.3584186+04:00",
"Name": "sample string 4",
"Description": "sample string 5",
"RoutePoint": [
{
"Id": "0b9f1006-0743-468d-a336-02d004b946bc",
"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": "2026-07-09T14:56:40.3584186+04:00",
"ActualEndTime": "2026-07-09T14:56:40.3584186+04:00",
"ExpStartTime": "2026-07-09T14:56:40.3584186+04:00",
"ActualStartTime": "2026-07-09T14:56:40.3584186+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": "0b9f1006-0743-468d-a336-02d004b946bc",
"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": "2026-07-09T14:56:40.3584186+04:00",
"ActualEndTime": "2026-07-09T14:56:40.3584186+04:00",
"ExpStartTime": "2026-07-09T14:56:40.3584186+04:00",
"ActualStartTime": "2026-07-09T14:56:40.3584186+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": "2026-07-09T14:56:40.3584186+04:00",
"ActEndOn": "2026-07-09T14:56:40.3584186+04:00"
},
"ExpectedStartOn": "00:00:00.1234567",
"ExpectedEndOn": "00:00:00.1234567",
"Driver": {
"DriverID": "c8c60499-aca4-46af-ac5d-7c3988a4fdfa",
"Name": "sample string 2",
"DriverCode": "sample string 3",
"MobileNo": "sample string 4"
},
"Vehicle": {
"VehicleID": "014bd390-3c79-4009-a232-b83edb5f61ae",
"VehicleNo": "sample string 2"
},
"Priority": 0,
"CategorySummary": [
{
"Name": "sample string 1",
"Qty": 2
},
{
"Name": "sample string 1",
"Qty": 2
}
]
},
{
"TaskID": "e9d4329e-79fe-4643-9d3d-f595332cc16f",
"TaskOn": "2026-07-09T14:56:40.3584186+04:00",
"CreatedOn": "2026-07-09T14:56:40.3584186+04:00",
"Name": "sample string 4",
"Description": "sample string 5",
"RoutePoint": [
{
"Id": "0b9f1006-0743-468d-a336-02d004b946bc",
"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": "2026-07-09T14:56:40.3584186+04:00",
"ActualEndTime": "2026-07-09T14:56:40.3584186+04:00",
"ExpStartTime": "2026-07-09T14:56:40.3584186+04:00",
"ActualStartTime": "2026-07-09T14:56:40.3584186+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": "0b9f1006-0743-468d-a336-02d004b946bc",
"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": "2026-07-09T14:56:40.3584186+04:00",
"ActualEndTime": "2026-07-09T14:56:40.3584186+04:00",
"ExpStartTime": "2026-07-09T14:56:40.3584186+04:00",
"ActualStartTime": "2026-07-09T14:56:40.3584186+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": "2026-07-09T14:56:40.3584186+04:00",
"ActEndOn": "2026-07-09T14:56:40.3584186+04:00"
},
"ExpectedStartOn": "00:00:00.1234567",
"ExpectedEndOn": "00:00:00.1234567",
"Driver": {
"DriverID": "c8c60499-aca4-46af-ac5d-7c3988a4fdfa",
"Name": "sample string 2",
"DriverCode": "sample string 3",
"MobileNo": "sample string 4"
},
"Vehicle": {
"VehicleID": "014bd390-3c79-4009-a232-b83edb5f61ae",
"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>2026-07-09T14:56:40.3584186+04:00</CreatedOn>
<Description>sample string 5</Description>
<Driver>
<DriverCode>sample string 3</DriverCode>
<DriverID>c8c60499-aca4-46af-ac5d-7c3988a4fdfa</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>2026-07-09T14:56:40.3584186+04:00</ActualEndTime>
<ActualStartTime>2026-07-09T14:56:40.3584186+04:00</ActualStartTime>
<City>sample string 4</City>
<CurrentLat>10.1</CurrentLat>
<CurrentLon>11.1</CurrentLon>
<ExpEndTime>2026-07-09T14:56:40.3584186+04:00</ExpEndTime>
<ExpStartTime>2026-07-09T14:56:40.3584186+04:00</ExpStartTime>
<Id>0b9f1006-0743-468d-a336-02d004b946bc</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>2026-07-09T14:56:40.3584186+04:00</ActualEndTime>
<ActualStartTime>2026-07-09T14:56:40.3584186+04:00</ActualStartTime>
<City>sample string 4</City>
<CurrentLat>10.1</CurrentLat>
<CurrentLon>11.1</CurrentLon>
<ExpEndTime>2026-07-09T14:56:40.3584186+04:00</ExpEndTime>
<ExpStartTime>2026-07-09T14:56:40.3584186+04:00</ExpStartTime>
<Id>0b9f1006-0743-468d-a336-02d004b946bc</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>e9d4329e-79fe-4643-9d3d-f595332cc16f</TaskID>
<TaskOn>2026-07-09T14:56:40.3584186+04:00</TaskOn>
<TaskTracking>
<ActEndOn>2026-07-09T14:56:40.3584186+04:00</ActEndOn>
<ActStartOn>2026-07-09T14:56:40.3584186+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>014bd390-3c79-4009-a232-b83edb5f61ae</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>2026-07-09T14:56:40.3584186+04:00</CreatedOn>
<Description>sample string 5</Description>
<Driver>
<DriverCode>sample string 3</DriverCode>
<DriverID>c8c60499-aca4-46af-ac5d-7c3988a4fdfa</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>2026-07-09T14:56:40.3584186+04:00</ActualEndTime>
<ActualStartTime>2026-07-09T14:56:40.3584186+04:00</ActualStartTime>
<City>sample string 4</City>
<CurrentLat>10.1</CurrentLat>
<CurrentLon>11.1</CurrentLon>
<ExpEndTime>2026-07-09T14:56:40.3584186+04:00</ExpEndTime>
<ExpStartTime>2026-07-09T14:56:40.3584186+04:00</ExpStartTime>
<Id>0b9f1006-0743-468d-a336-02d004b946bc</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>2026-07-09T14:56:40.3584186+04:00</ActualEndTime>
<ActualStartTime>2026-07-09T14:56:40.3584186+04:00</ActualStartTime>
<City>sample string 4</City>
<CurrentLat>10.1</CurrentLat>
<CurrentLon>11.1</CurrentLon>
<ExpEndTime>2026-07-09T14:56:40.3584186+04:00</ExpEndTime>
<ExpStartTime>2026-07-09T14:56:40.3584186+04:00</ExpStartTime>
<Id>0b9f1006-0743-468d-a336-02d004b946bc</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>e9d4329e-79fe-4643-9d3d-f595332cc16f</TaskID>
<TaskOn>2026-07-09T14:56:40.3584186+04:00</TaskOn>
<TaskTracking>
<ActEndOn>2026-07-09T14:56:40.3584186+04:00</ActEndOn>
<ActStartOn>2026-07-09T14:56:40.3584186+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>014bd390-3c79-4009-a232-b83edb5f61ae</VehicleID>
<VehicleNo>sample string 2</VehicleNo>
</Vehicle>
</TaskViewModel>
</ArrayOfTaskViewModel>