GET api/Route/V2/GetRoute?APIKey={APIKey}&FromDate={FromDate}&Todate={Todate}&UserID={UserID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
APIKey

string

Default value is

FromDate

string

Default value is

Todate

string

Default value is

UserID

string

Default value is 0

Body Parameters

None.

Response Information

Resource Description

RouteResponceModel
NameDescriptionTypeAdditional information
routePlan

Collection of RoutePlanResponceVM

None.

ReturnID

integer

Required

Message

string

Required

Successful

boolean

Required

Code

integer

None.

TotalRecord

integer

None.

Response Formats

application/json, text/json, text/plain, text/html

Sample:
{
  "routePlan": [
    {
      "routeID": 1,
      "driverID": 2,
      "routeName": "sample string 3",
      "routeDescription": "sample string 4",
      "routeDate": "2025-07-17T04:23:26.9269918+00:00",
      "startLatitude": 6.0,
      "startLongitude": 7.0,
      "startAddress": "sample string 8",
      "endLatitude": 9.0,
      "endLongitude": 10.0,
      "endAddress": "sample string 11",
      "routeJson": "sample string 12",
      "status": 13,
      "waypoints": [
        {
          "autoserviceMasterId": 1,
          "jobID": 2,
          "routeDetailsID": 3,
          "routeID": 4,
          "jobStatus": 5,
          "parentStatus": 6,
          "address": "sample string 7",
          "customerName": "sample string 8",
          "custtomerEmail": "sample string 9",
          "customerAddress": "sample string 10",
          "customerAddressCountry": "sample string 11",
          "customerAddressState": "sample string 12",
          "customerAddressCity": "sample string 13",
          "customerAddressZipCode": "sample string 14",
          "latitude": 15.0,
          "longitude": 16.0,
          "title": "sample string 17",
          "sequence": 18
        },
        {
          "autoserviceMasterId": 1,
          "jobID": 2,
          "routeDetailsID": 3,
          "routeID": 4,
          "jobStatus": 5,
          "parentStatus": 6,
          "address": "sample string 7",
          "customerName": "sample string 8",
          "custtomerEmail": "sample string 9",
          "customerAddress": "sample string 10",
          "customerAddressCountry": "sample string 11",
          "customerAddressState": "sample string 12",
          "customerAddressCity": "sample string 13",
          "customerAddressZipCode": "sample string 14",
          "latitude": 15.0,
          "longitude": 16.0,
          "title": "sample string 17",
          "sequence": 18
        }
      ]
    },
    {
      "routeID": 1,
      "driverID": 2,
      "routeName": "sample string 3",
      "routeDescription": "sample string 4",
      "routeDate": "2025-07-17T04:23:26.9269918+00:00",
      "startLatitude": 6.0,
      "startLongitude": 7.0,
      "startAddress": "sample string 8",
      "endLatitude": 9.0,
      "endLongitude": 10.0,
      "endAddress": "sample string 11",
      "routeJson": "sample string 12",
      "status": 13,
      "waypoints": [
        {
          "autoserviceMasterId": 1,
          "jobID": 2,
          "routeDetailsID": 3,
          "routeID": 4,
          "jobStatus": 5,
          "parentStatus": 6,
          "address": "sample string 7",
          "customerName": "sample string 8",
          "custtomerEmail": "sample string 9",
          "customerAddress": "sample string 10",
          "customerAddressCountry": "sample string 11",
          "customerAddressState": "sample string 12",
          "customerAddressCity": "sample string 13",
          "customerAddressZipCode": "sample string 14",
          "latitude": 15.0,
          "longitude": 16.0,
          "title": "sample string 17",
          "sequence": 18
        },
        {
          "autoserviceMasterId": 1,
          "jobID": 2,
          "routeDetailsID": 3,
          "routeID": 4,
          "jobStatus": 5,
          "parentStatus": 6,
          "address": "sample string 7",
          "customerName": "sample string 8",
          "custtomerEmail": "sample string 9",
          "customerAddress": "sample string 10",
          "customerAddressCountry": "sample string 11",
          "customerAddressState": "sample string 12",
          "customerAddressCity": "sample string 13",
          "customerAddressZipCode": "sample string 14",
          "latitude": 15.0,
          "longitude": 16.0,
          "title": "sample string 17",
          "sequence": 18
        }
      ]
    }
  ],
  "returnID": 1,
  "message": "sample string 2",
  "successful": true,
  "code": 4,
  "totalRecord": 5
}

application/xml, text/xml

Sample:
<RouteResponceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.DataModel">
  <Code xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">4</Code>
  <Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 2</Message>
  <ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">1</ReturnID>
  <Successful xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">true</Successful>
  <TotalRecord xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">5</TotalRecord>
  <routePlan>
    <RoutePlanResponceVM>
      <DriverID>2</DriverID>
      <EndAddress>sample string 11</EndAddress>
      <EndLatitude>9</EndLatitude>
      <EndLongitude>10</EndLongitude>
      <RouteDate>2025-07-17T04:23:26.9269918+00:00</RouteDate>
      <RouteDescription>sample string 4</RouteDescription>
      <RouteID>1</RouteID>
      <RouteJson>sample string 12</RouteJson>
      <RouteName>sample string 3</RouteName>
      <StartAddress>sample string 8</StartAddress>
      <StartLatitude>6</StartLatitude>
      <StartLongitude>7</StartLongitude>
      <Status>13</Status>
      <Waypoints>
        <WaypointsVM>
          <Address>sample string 7</Address>
          <AutoserviceMasterId>1</AutoserviceMasterId>
          <CustomerAddress>sample string 10</CustomerAddress>
          <CustomerAddressCity>sample string 13</CustomerAddressCity>
          <CustomerAddressCountry>sample string 11</CustomerAddressCountry>
          <CustomerAddressState>sample string 12</CustomerAddressState>
          <CustomerAddressZipCode>sample string 14</CustomerAddressZipCode>
          <CustomerName>sample string 8</CustomerName>
          <CusttomerEmail>sample string 9</CusttomerEmail>
          <JobID>2</JobID>
          <JobStatus>5</JobStatus>
          <Latitude>15</Latitude>
          <Longitude>16</Longitude>
          <ParentStatus>6</ParentStatus>
          <RouteDetailsID>3</RouteDetailsID>
          <RouteID>4</RouteID>
          <Sequence>18</Sequence>
          <Title>sample string 17</Title>
        </WaypointsVM>
        <WaypointsVM>
          <Address>sample string 7</Address>
          <AutoserviceMasterId>1</AutoserviceMasterId>
          <CustomerAddress>sample string 10</CustomerAddress>
          <CustomerAddressCity>sample string 13</CustomerAddressCity>
          <CustomerAddressCountry>sample string 11</CustomerAddressCountry>
          <CustomerAddressState>sample string 12</CustomerAddressState>
          <CustomerAddressZipCode>sample string 14</CustomerAddressZipCode>
          <CustomerName>sample string 8</CustomerName>
          <CusttomerEmail>sample string 9</CusttomerEmail>
          <JobID>2</JobID>
          <JobStatus>5</JobStatus>
          <Latitude>15</Latitude>
          <Longitude>16</Longitude>
          <ParentStatus>6</ParentStatus>
          <RouteDetailsID>3</RouteDetailsID>
          <RouteID>4</RouteID>
          <Sequence>18</Sequence>
          <Title>sample string 17</Title>
        </WaypointsVM>
      </Waypoints>
    </RoutePlanResponceVM>
    <RoutePlanResponceVM>
      <DriverID>2</DriverID>
      <EndAddress>sample string 11</EndAddress>
      <EndLatitude>9</EndLatitude>
      <EndLongitude>10</EndLongitude>
      <RouteDate>2025-07-17T04:23:26.9269918+00:00</RouteDate>
      <RouteDescription>sample string 4</RouteDescription>
      <RouteID>1</RouteID>
      <RouteJson>sample string 12</RouteJson>
      <RouteName>sample string 3</RouteName>
      <StartAddress>sample string 8</StartAddress>
      <StartLatitude>6</StartLatitude>
      <StartLongitude>7</StartLongitude>
      <Status>13</Status>
      <Waypoints>
        <WaypointsVM>
          <Address>sample string 7</Address>
          <AutoserviceMasterId>1</AutoserviceMasterId>
          <CustomerAddress>sample string 10</CustomerAddress>
          <CustomerAddressCity>sample string 13</CustomerAddressCity>
          <CustomerAddressCountry>sample string 11</CustomerAddressCountry>
          <CustomerAddressState>sample string 12</CustomerAddressState>
          <CustomerAddressZipCode>sample string 14</CustomerAddressZipCode>
          <CustomerName>sample string 8</CustomerName>
          <CusttomerEmail>sample string 9</CusttomerEmail>
          <JobID>2</JobID>
          <JobStatus>5</JobStatus>
          <Latitude>15</Latitude>
          <Longitude>16</Longitude>
          <ParentStatus>6</ParentStatus>
          <RouteDetailsID>3</RouteDetailsID>
          <RouteID>4</RouteID>
          <Sequence>18</Sequence>
          <Title>sample string 17</Title>
        </WaypointsVM>
        <WaypointsVM>
          <Address>sample string 7</Address>
          <AutoserviceMasterId>1</AutoserviceMasterId>
          <CustomerAddress>sample string 10</CustomerAddress>
          <CustomerAddressCity>sample string 13</CustomerAddressCity>
          <CustomerAddressCountry>sample string 11</CustomerAddressCountry>
          <CustomerAddressState>sample string 12</CustomerAddressState>
          <CustomerAddressZipCode>sample string 14</CustomerAddressZipCode>
          <CustomerName>sample string 8</CustomerName>
          <CusttomerEmail>sample string 9</CusttomerEmail>
          <JobID>2</JobID>
          <JobStatus>5</JobStatus>
          <Latitude>15</Latitude>
          <Longitude>16</Longitude>
          <ParentStatus>6</ParentStatus>
          <RouteDetailsID>3</RouteDetailsID>
          <RouteID>4</RouteID>
          <Sequence>18</Sequence>
          <Title>sample string 17</Title>
        </WaypointsVM>
      </Waypoints>
    </RoutePlanResponceVM>
  </routePlan>
</RouteResponceModel>

multipart/form-data

Sample:
<RouteResponceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.DataModel"><Code xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">4</Code><Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 2</Message><ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">1</ReturnID><Successful xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">true</Successful><TotalRecord xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">5</TotalRecord><routePlan><RoutePlanResponceVM><DriverID>2</DriverID><EndAddress>sample string 11</EndAddress><EndLatitude>9</EndLatitude><EndLongitude>10</EndLongitude><RouteDate>2025-07-17T04:23:26.9269918+00:00</RouteDate><RouteDescription>sample string 4</RouteDescription><RouteID>1</RouteID><RouteJson>sample string 12</RouteJson><RouteName>sample string 3</RouteName><StartAddress>sample string 8</StartAddress><StartLatitude>6</StartLatitude><StartLongitude>7</StartLongitude><Status>13</Status><Waypoints><WaypointsVM><Address>sample string 7</Address><AutoserviceMasterId>1</AutoserviceMasterId><CustomerAddress>sample string 10</CustomerAddress><CustomerAddressCity>sample string 13</CustomerAddressCity><CustomerAddressCountry>sample string 11</CustomerAddressCountry><CustomerAddressState>sample string 12</CustomerAddressState><CustomerAddressZipCode>sample string 14</CustomerAddressZipCode><CustomerName>sample string 8</CustomerName><CusttomerEmail>sample string 9</CusttomerEmail><JobID>2</JobID><JobStatus>5</JobStatus><Latitude>15</Latitude><Longitude>16</Longitude><ParentStatus>6</ParentStatus><RouteDetailsID>3</RouteDetailsID><RouteID>4</RouteID><Sequence>18</Sequence><Title>sample string 17</Title></WaypointsVM><WaypointsVM><Address>sample string 7</Address><AutoserviceMasterId>1</AutoserviceMasterId><CustomerAddress>sample string 10</CustomerAddress><CustomerAddressCity>sample string 13</CustomerAddressCity><CustomerAddressCountry>sample string 11</CustomerAddressCountry><CustomerAddressState>sample string 12</CustomerAddressState><CustomerAddressZipCode>sample string 14</CustomerAddressZipCode><CustomerName>sample string 8</CustomerName><CusttomerEmail>sample string 9</CusttomerEmail><JobID>2</JobID><JobStatus>5</JobStatus><Latitude>15</Latitude><Longitude>16</Longitude><ParentStatus>6</ParentStatus><RouteDetailsID>3</RouteDetailsID><RouteID>4</RouteID><Sequence>18</Sequence><Title>sample string 17</Title></WaypointsVM></Waypoints></RoutePlanResponceVM><RoutePlanResponceVM><DriverID>2</DriverID><EndAddress>sample string 11</EndAddress><EndLatitude>9</EndLatitude><EndLongitude>10</EndLongitude><RouteDate>2025-07-17T04:23:26.9269918+00:00</RouteDate><RouteDescription>sample string 4</RouteDescription><RouteID>1</RouteID><RouteJson>sample string 12</RouteJson><RouteName>sample string 3</RouteName><StartAddress>sample string 8</StartAddress><StartLatitude>6</StartLatitude><StartLongitude>7</StartLongitude><Status>13</Status><Waypoints><WaypointsVM><Address>sample string 7</Address><AutoserviceMasterId>1</AutoserviceMasterId><CustomerAddress>sample string 10</CustomerAddress><CustomerAddressCity>sample string 13</CustomerAddressCity><CustomerAddressCountry>sample string 11</CustomerAddressCountry><CustomerAddressState>sample string 12</CustomerAddressState><CustomerAddressZipCode>sample string 14</CustomerAddressZipCode><CustomerName>sample string 8</CustomerName><CusttomerEmail>sample string 9</CusttomerEmail><JobID>2</JobID><JobStatus>5</JobStatus><Latitude>15</Latitude><Longitude>16</Longitude><ParentStatus>6</ParentStatus><RouteDetailsID>3</RouteDetailsID><RouteID>4</RouteID><Sequence>18</Sequence><Title>sample string 17</Title></WaypointsVM><WaypointsVM><Address>sample string 7</Address><AutoserviceMasterId>1</AutoserviceMasterId><CustomerAddress>sample string 10</CustomerAddress><CustomerAddressCity>sample string 13</CustomerAddressCity><CustomerAddressCountry>sample string 11</CustomerAddressCountry><CustomerAddressState>sample string 12</CustomerAddressState><CustomerAddressZipCode>sample string 14</CustomerAddressZipCode><CustomerName>sample string 8</CustomerName><CusttomerEmail>sample string 9</CusttomerEmail><JobID>2</JobID><JobStatus>5</JobStatus><Latitude>15</Latitude><Longitude>16</Longitude><ParentStatus>6</ParentStatus><RouteDetailsID>3</RouteDetailsID><RouteID>4</RouteID><Sequence>18</Sequence><Title>sample string 17</Title></WaypointsVM></Waypoints></RoutePlanResponceVM></routePlan></RouteResponceModel>