GET Api/TaskEx/GetTaskByID?clientID={clientID}&taskID={taskID}&taskOn={taskOn}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientID

globally unique identifier

Required
taskID

globally unique identifier

Required
taskOn

date

Required

Body Parameters

None.

Response Information

Resource Description

TaskViewModel
NameDescriptionTypeAdditional 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": "a324cc0f-5b28-4720-b66a-4d73ba2f4331",
  "TaskOn": "2025-05-20T21:36:27.1549733+04:00",
  "CreatedOn": "2025-05-20T21:36:27.1549733+04:00",
  "Name": "sample string 4",
  "Description": "sample string 5",
  "RoutePoint": [
    {
      "Id": "511ff73d-527f-4fd3-a7f1-5c4057a1d009",
      "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:36:27.1549733+04:00",
      "ActualEndTime": "2025-05-20T21:36:27.1549733+04:00",
      "ExpStartTime": "2025-05-20T21:36:27.1549733+04:00",
      "ActualStartTime": "2025-05-20T21:36:27.1549733+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": "511ff73d-527f-4fd3-a7f1-5c4057a1d009",
      "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:36:27.1549733+04:00",
      "ActualEndTime": "2025-05-20T21:36:27.1549733+04:00",
      "ExpStartTime": "2025-05-20T21:36:27.1549733+04:00",
      "ActualStartTime": "2025-05-20T21:36:27.1549733+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:36:27.1549733+04:00",
    "ActEndOn": "2025-05-20T21:36:27.1549733+04:00"
  },
  "ExpectedStartOn": "00:00:00.1234567",
  "ExpectedEndOn": "00:00:00.1234567",
  "Driver": {
    "DriverID": "284743e4-8506-4e98-a223-9ac28f7bd22c",
    "Name": "sample string 2",
    "DriverCode": "sample string 3",
    "MobileNo": "sample string 4"
  },
  "Vehicle": {
    "VehicleID": "5c58c1a7-0d95-40fb-9fef-ff627891bb16",
    "VehicleNo": "sample string 2"
  },
  "Priority": 0
}

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">
  <CreatedOn>2025-05-20T21:36:27.1549733+04:00</CreatedOn>
  <Description>sample string 5</Description>
  <Driver>
    <DriverCode>sample string 3</DriverCode>
    <DriverID>284743e4-8506-4e98-a223-9ac28f7bd22c</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:36:27.1549733+04:00</ActualEndTime>
      <ActualStartTime>2025-05-20T21:36:27.1549733+04:00</ActualStartTime>
      <City>sample string 4</City>
      <CurrentLat>10.1</CurrentLat>
      <CurrentLon>11.1</CurrentLon>
      <ExpEndTime>2025-05-20T21:36:27.1549733+04:00</ExpEndTime>
      <ExpStartTime>2025-05-20T21:36:27.1549733+04:00</ExpStartTime>
      <Id>511ff73d-527f-4fd3-a7f1-5c4057a1d009</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-05-20T21:36:27.1549733+04:00</ActualEndTime>
      <ActualStartTime>2025-05-20T21:36:27.1549733+04:00</ActualStartTime>
      <City>sample string 4</City>
      <CurrentLat>10.1</CurrentLat>
      <CurrentLon>11.1</CurrentLon>
      <ExpEndTime>2025-05-20T21:36:27.1549733+04:00</ExpEndTime>
      <ExpStartTime>2025-05-20T21:36:27.1549733+04:00</ExpStartTime>
      <Id>511ff73d-527f-4fd3-a7f1-5c4057a1d009</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>a324cc0f-5b28-4720-b66a-4d73ba2f4331</TaskID>
  <TaskOn>2025-05-20T21:36:27.1549733+04:00</TaskOn>
  <TaskTracking>
    <ActEndOn>2025-05-20T21:36:27.1549733+04:00</ActEndOn>
    <ActStartOn>2025-05-20T21:36:27.1549733+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>5c58c1a7-0d95-40fb-9fef-ff627891bb16</VehicleID>
    <VehicleNo>sample string 2</VehicleNo>
  </Vehicle>
</TaskViewModel>