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. |
Request Formats
application/json, text/json
Sample:
{
"ClientID": "2fe2dc82-6319-4121-afea-d6fda482a7b7",
"DriverID": "522a0f69-fb51-4df4-9359-ff9cb00aad8a",
"DriverCode": "sample string 3",
"FromDate": "2025-05-20T21:13:02.2575242+04:00",
"ToDate": "2025-05-20T21:13:02.2575242+04:00",
"TaskStatus": [
1,
2
],
"GroupID": "5a9afa37-6d97-4231-bc00-04d152c6ca20",
"StopTypes": [
1,
2
],
"SubClientID": "7603a233-69e2-4644-ada2-cff95290f6cf",
"TerritoryFenceID": "bb8781aa-93a8-4575-9947-d1870bfcd56b",
"MerchantID": "4805c145-b4bb-487b-8448-9e1915488c82",
"TimeWindowID": "3b98b08a-d10e-45b8-829f-0a2b8272d3d3",
"SearchText": "sample string 11",
"TimeWindowFilter": [
"7eaa2e1f-063e-4bcd-851d-9120293b74d1",
"309345d5-555f-4b9e-bbd6-c7f0d6f5cfc0"
]
}
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>2fe2dc82-6319-4121-afea-d6fda482a7b7</ClientID>
<DriverCode>sample string 3</DriverCode>
<DriverID>522a0f69-fb51-4df4-9359-ff9cb00aad8a</DriverID>
<FromDate>2025-05-20T21:13:02.2575242+04:00</FromDate>
<GroupID>5a9afa37-6d97-4231-bc00-04d152c6ca20</GroupID>
<MerchantID>4805c145-b4bb-487b-8448-9e1915488c82</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>7603a233-69e2-4644-ada2-cff95290f6cf</SubClientID>
<TaskStatus xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</TaskStatus>
<TerritoryFenceID>bb8781aa-93a8-4575-9947-d1870bfcd56b</TerritoryFenceID>
<TimeWindowFilter xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>7eaa2e1f-063e-4bcd-851d-9120293b74d1</d2p1:guid>
<d2p1:guid>309345d5-555f-4b9e-bbd6-c7f0d6f5cfc0</d2p1:guid>
</TimeWindowFilter>
<TimeWindowID>3b98b08a-d10e-45b8-829f-0a2b8272d3d3</TimeWindowID>
<ToDate>2025-05-20T21:13:02.2575242+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. |
Response Formats
application/json, text/json
Sample:
[
{
"TaskID": "c3f0eb64-dc08-4886-bd13-93b5b0ce49f6",
"TaskOn": "2025-05-20T21:13:02.2575242+04:00",
"CreatedOn": "2025-05-20T21:13:02.2575242+04:00",
"Name": "sample string 4",
"Description": "sample string 5",
"RoutePoint": [
{
"Id": "908d4a99-7cb4-478a-b01a-defd270fe3ac",
"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-05-20T21:13:02.2575242+04:00",
"ActualEndTime": "2025-05-20T21:13:02.2575242+04:00",
"ExpStartTime": "2025-05-20T21:13:02.2575242+04:00",
"ActualStartTime": "2025-05-20T21:13:02.2575242+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": "908d4a99-7cb4-478a-b01a-defd270fe3ac",
"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-05-20T21:13:02.2575242+04:00",
"ActualEndTime": "2025-05-20T21:13:02.2575242+04:00",
"ExpStartTime": "2025-05-20T21:13:02.2575242+04:00",
"ActualStartTime": "2025-05-20T21:13:02.2575242+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-05-20T21:13:02.2575242+04:00",
"ActEndOn": "2025-05-20T21:13:02.2575242+04:00"
},
"ExpectedStartOn": "00:00:00.1234567",
"ExpectedEndOn": "00:00:00.1234567",
"Driver": {
"DriverID": "8eb18745-1d89-4a6a-8699-f7088e522428",
"Name": "sample string 2",
"DriverCode": "sample string 3",
"MobileNo": "sample string 4"
},
"Vehicle": {
"VehicleID": "2d4e015d-e920-4cf8-b446-ae29a791dfb9",
"VehicleNo": "sample string 2"
},
"Priority": 0
},
{
"TaskID": "c3f0eb64-dc08-4886-bd13-93b5b0ce49f6",
"TaskOn": "2025-05-20T21:13:02.2575242+04:00",
"CreatedOn": "2025-05-20T21:13:02.2575242+04:00",
"Name": "sample string 4",
"Description": "sample string 5",
"RoutePoint": [
{
"Id": "908d4a99-7cb4-478a-b01a-defd270fe3ac",
"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-05-20T21:13:02.2575242+04:00",
"ActualEndTime": "2025-05-20T21:13:02.2575242+04:00",
"ExpStartTime": "2025-05-20T21:13:02.2575242+04:00",
"ActualStartTime": "2025-05-20T21:13:02.2575242+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": "908d4a99-7cb4-478a-b01a-defd270fe3ac",
"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-05-20T21:13:02.2575242+04:00",
"ActualEndTime": "2025-05-20T21:13:02.2575242+04:00",
"ExpStartTime": "2025-05-20T21:13:02.2575242+04:00",
"ActualStartTime": "2025-05-20T21:13:02.2575242+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-05-20T21:13:02.2575242+04:00",
"ActEndOn": "2025-05-20T21:13:02.2575242+04:00"
},
"ExpectedStartOn": "00:00:00.1234567",
"ExpectedEndOn": "00:00:00.1234567",
"Driver": {
"DriverID": "8eb18745-1d89-4a6a-8699-f7088e522428",
"Name": "sample string 2",
"DriverCode": "sample string 3",
"MobileNo": "sample string 4"
},
"Vehicle": {
"VehicleID": "2d4e015d-e920-4cf8-b446-ae29a791dfb9",
"VehicleNo": "sample string 2"
},
"Priority": 0
}
]
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>
<CreatedOn>2025-05-20T21:13:02.2575242+04:00</CreatedOn>
<Description>sample string 5</Description>
<Driver>
<DriverCode>sample string 3</DriverCode>
<DriverID>8eb18745-1d89-4a6a-8699-f7088e522428</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-05-20T21:13:02.2575242+04:00</ActualEndTime>
<ActualStartTime>2025-05-20T21:13:02.2575242+04:00</ActualStartTime>
<City>sample string 4</City>
<CurrentLat>10.1</CurrentLat>
<CurrentLon>11.1</CurrentLon>
<ExpEndTime>2025-05-20T21:13:02.2575242+04:00</ExpEndTime>
<ExpStartTime>2025-05-20T21:13:02.2575242+04:00</ExpStartTime>
<Id>908d4a99-7cb4-478a-b01a-defd270fe3ac</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-05-20T21:13:02.2575242+04:00</ActualEndTime>
<ActualStartTime>2025-05-20T21:13:02.2575242+04:00</ActualStartTime>
<City>sample string 4</City>
<CurrentLat>10.1</CurrentLat>
<CurrentLon>11.1</CurrentLon>
<ExpEndTime>2025-05-20T21:13:02.2575242+04:00</ExpEndTime>
<ExpStartTime>2025-05-20T21:13:02.2575242+04:00</ExpStartTime>
<Id>908d4a99-7cb4-478a-b01a-defd270fe3ac</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>c3f0eb64-dc08-4886-bd13-93b5b0ce49f6</TaskID>
<TaskOn>2025-05-20T21:13:02.2575242+04:00</TaskOn>
<TaskTracking>
<ActEndOn>2025-05-20T21:13:02.2575242+04:00</ActEndOn>
<ActStartOn>2025-05-20T21:13:02.2575242+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>2d4e015d-e920-4cf8-b446-ae29a791dfb9</VehicleID>
<VehicleNo>sample string 2</VehicleNo>
</Vehicle>
</TaskViewModel>
<TaskViewModel>
<CreatedOn>2025-05-20T21:13:02.2575242+04:00</CreatedOn>
<Description>sample string 5</Description>
<Driver>
<DriverCode>sample string 3</DriverCode>
<DriverID>8eb18745-1d89-4a6a-8699-f7088e522428</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-05-20T21:13:02.2575242+04:00</ActualEndTime>
<ActualStartTime>2025-05-20T21:13:02.2575242+04:00</ActualStartTime>
<City>sample string 4</City>
<CurrentLat>10.1</CurrentLat>
<CurrentLon>11.1</CurrentLon>
<ExpEndTime>2025-05-20T21:13:02.2575242+04:00</ExpEndTime>
<ExpStartTime>2025-05-20T21:13:02.2575242+04:00</ExpStartTime>
<Id>908d4a99-7cb4-478a-b01a-defd270fe3ac</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-05-20T21:13:02.2575242+04:00</ActualEndTime>
<ActualStartTime>2025-05-20T21:13:02.2575242+04:00</ActualStartTime>
<City>sample string 4</City>
<CurrentLat>10.1</CurrentLat>
<CurrentLon>11.1</CurrentLon>
<ExpEndTime>2025-05-20T21:13:02.2575242+04:00</ExpEndTime>
<ExpStartTime>2025-05-20T21:13:02.2575242+04:00</ExpStartTime>
<Id>908d4a99-7cb4-478a-b01a-defd270fe3ac</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>c3f0eb64-dc08-4886-bd13-93b5b0ce49f6</TaskID>
<TaskOn>2025-05-20T21:13:02.2575242+04:00</TaskOn>
<TaskTracking>
<ActEndOn>2025-05-20T21:13:02.2575242+04:00</ActEndOn>
<ActStartOn>2025-05-20T21:13:02.2575242+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>2d4e015d-e920-4cf8-b446-ae29a791dfb9</VehicleID>
<VehicleNo>sample string 2</VehicleNo>
</Vehicle>
</TaskViewModel>
</ArrayOfTaskViewModel>