POST Api/TaskEx/GetTaskByID
Request Information
URI Parameters
None.
Body Parameters
TaskByIDParameter| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientID | globally unique identifier |
None. |
|
| TaskID | globally unique identifier |
None. |
|
| TaskOn | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"ClientID": "46bb78a2-58eb-475c-b1a2-221dc469a073",
"TaskID": "e264e121-630c-403c-96cb-873d292824c6",
"TaskOn": "2025-07-07T09:14:45.8507359+04:00"
}
application/xml, text/xml
Sample:
<TaskByIDParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fleetroot.Entity.Tasks"> <ClientID>46bb78a2-58eb-475c-b1a2-221dc469a073</ClientID> <TaskID>e264e121-630c-403c-96cb-873d292824c6</TaskID> <TaskOn>2025-07-07T09:14:45.8507359+04:00</TaskOn> </TaskByIDParameter>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
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": "f7363301-b5be-42bc-9fad-8606eb7d2ec9",
"TaskOn": "2025-07-07T09:14:45.8663615+04:00",
"CreatedOn": "2025-07-07T09:14:45.8663615+04:00",
"Name": "sample string 4",
"Description": "sample string 5",
"RoutePoint": [
{
"Id": "ba50133b-6935-4c5e-b140-696715a75cdd",
"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-07-07T09:14:45.8663615+04:00",
"ActualEndTime": "2025-07-07T09:14:45.8663615+04:00",
"ExpStartTime": "2025-07-07T09:14:45.8663615+04:00",
"ActualStartTime": "2025-07-07T09:14:45.8663615+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": "ba50133b-6935-4c5e-b140-696715a75cdd",
"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-07-07T09:14:45.8663615+04:00",
"ActualEndTime": "2025-07-07T09:14:45.8663615+04:00",
"ExpStartTime": "2025-07-07T09:14:45.8663615+04:00",
"ActualStartTime": "2025-07-07T09:14:45.8663615+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-07-07T09:14:45.8663615+04:00",
"ActEndOn": "2025-07-07T09:14:45.8663615+04:00"
},
"ExpectedStartOn": "00:00:00.1234567",
"ExpectedEndOn": "00:00:00.1234567",
"Driver": {
"DriverID": "2331efab-fc2e-4ebb-a3a4-a2406dad5983",
"Name": "sample string 2",
"DriverCode": "sample string 3",
"MobileNo": "sample string 4"
},
"Vehicle": {
"VehicleID": "e5420be7-5df4-41b4-ad56-b0997b780e98",
"VehicleNo": "sample string 2"
},
"Priority": 0,
"CategorySummary": [
{
"Name": "sample string 1",
"Qty": 2
},
{
"Name": "sample string 1",
"Qty": 2
}
]
}
application/xml, text/xml
Sample:
<TaskViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FleetrootDriver.Service.Models">
<CategorySummary xmlns:d2p1="http://schemas.datacontract.org/2004/07/Fleetroot.Entity.Tasks">
<d2p1:CategorySummary>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Qty>2</d2p1:Qty>
</d2p1:CategorySummary>
<d2p1:CategorySummary>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Qty>2</d2p1:Qty>
</d2p1:CategorySummary>
</CategorySummary>
<CreatedOn>2025-07-07T09:14:45.8663615+04:00</CreatedOn>
<Description>sample string 5</Description>
<Driver>
<DriverCode>sample string 3</DriverCode>
<DriverID>2331efab-fc2e-4ebb-a3a4-a2406dad5983</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-07-07T09:14:45.8663615+04:00</ActualEndTime>
<ActualStartTime>2025-07-07T09:14:45.8663615+04:00</ActualStartTime>
<City>sample string 4</City>
<CurrentLat>10.1</CurrentLat>
<CurrentLon>11.1</CurrentLon>
<ExpEndTime>2025-07-07T09:14:45.8663615+04:00</ExpEndTime>
<ExpStartTime>2025-07-07T09:14:45.8663615+04:00</ExpStartTime>
<Id>ba50133b-6935-4c5e-b140-696715a75cdd</Id>
<POIName>sample string 3</POIName>
<ParcelPlace xmlns:d4p1="http://schemas.datacontract.org/2004/07/Fleetroot.Entity">
<d4p1:ParcelCount>1</d4p1:ParcelCount>
<d4p1:PlaceType1>None</d4p1:PlaceType1>
<d4p1:PlaceType2>None</d4p1:PlaceType2>
<d4p1:PlaceType3>None</d4p1: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-07-07T09:14:45.8663615+04:00</ActualEndTime>
<ActualStartTime>2025-07-07T09:14:45.8663615+04:00</ActualStartTime>
<City>sample string 4</City>
<CurrentLat>10.1</CurrentLat>
<CurrentLon>11.1</CurrentLon>
<ExpEndTime>2025-07-07T09:14:45.8663615+04:00</ExpEndTime>
<ExpStartTime>2025-07-07T09:14:45.8663615+04:00</ExpStartTime>
<Id>ba50133b-6935-4c5e-b140-696715a75cdd</Id>
<POIName>sample string 3</POIName>
<ParcelPlace xmlns:d4p1="http://schemas.datacontract.org/2004/07/Fleetroot.Entity">
<d4p1:ParcelCount>1</d4p1:ParcelCount>
<d4p1:PlaceType1>None</d4p1:PlaceType1>
<d4p1:PlaceType2>None</d4p1:PlaceType2>
<d4p1:PlaceType3>None</d4p1: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>f7363301-b5be-42bc-9fad-8606eb7d2ec9</TaskID>
<TaskOn>2025-07-07T09:14:45.8663615+04:00</TaskOn>
<TaskTracking>
<ActEndOn>2025-07-07T09:14:45.8663615+04:00</ActEndOn>
<ActStartOn>2025-07-07T09:14:45.8663615+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>e5420be7-5df4-41b4-ad56-b0997b780e98</VehicleID>
<VehicleNo>sample string 2</VehicleNo>
</Vehicle>
</TaskViewModel>