POST api/Order/GetRoutePlan

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
APIKey	string	None.
SerachModel	RoutePlanSearchModel	None.
DeleteModel	RouteDeleteModel	None.
StatusUpdateModel	RouteStatusUpdateModel	None.
ReorderModel	RouteReorderModel	None.
IsActive	integer	None.
SearchText	string	None.
PageNumber	integer	None.
PageSize	integer	None.
UsePaging	boolean	None.

Request Formats

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

Sample:

{
  "apiKey": "sample string 1",
  "serachModel": {
    "routeID": 1,
    "fromDate": "sample string 2",
    "toDate": "sample string 3",
    "routeName": "sample string 4",
    "status": 5,
    "isPagination": 6,
    "currentPage": 7,
    "userID": 8,
    "pageSize": 9,
    "resultsPageCount": 10,
    "sortingBy": "sample string 11",
    "sortingOrder": "sample string 12",
    "resulsPerPage": 13
  },
  "deleteModel": {
    "routeID": 1,
    "modifiedBy": 2
  },
  "statusUpdateModel": {
    "routeID": 1,
    "routeDetailsID": 2,
    "statusID": 3,
    "type": 4,
    "userID": 5
  },
  "reorderModel": {
    "reOrderList": "sample string 1",
    "userID": 2
  },
  "isActive": 1,
  "searchText": "sample string 2",
  "pageNumber": 1,
  "pageSize": 1,
  "usePaging": true
}

application/xml, text/xml

Sample:

<RoutePlanRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel">
  <IsActive>1</IsActive>
  <PageNumber>1</PageNumber>
  <PageSize>1</PageSize>
  <SearchText>sample string 2</SearchText>
  <UsePaging>true</UsePaging>
  <APIKey>sample string 1</APIKey>
  <DeleteModel>
    <ModifiedBy>2</ModifiedBy>
    <RouteID>1</RouteID>
  </DeleteModel>
  <ReorderModel>
    <ReOrderList>sample string 1</ReOrderList>
    <UserID>2</UserID>
  </ReorderModel>
  <SerachModel>
    <CurrentPage>7</CurrentPage>
    <FromDate>sample string 2</FromDate>
    <IsPagination>6</IsPagination>
    <PageSize>9</PageSize>
    <ResulsPerPage>13</ResulsPerPage>
    <ResultsPageCount>10</ResultsPageCount>
    <RouteID>1</RouteID>
    <RouteName>sample string 4</RouteName>
    <SortingBy>sample string 11</SortingBy>
    <SortingOrder>sample string 12</SortingOrder>
    <Status>5</Status>
    <ToDate>sample string 3</ToDate>
    <UserID>8</UserID>
  </SerachModel>
  <StatusUpdateModel>
    <RouteDetailsID>2</RouteDetailsID>
    <RouteID>1</RouteID>
    <StatusID>3</StatusID>
    <Type>4</Type>
    <UserID>5</UserID>
  </StatusUpdateModel>
</RoutePlanRequestModel>

multipart/form-data

Sample:

<RoutePlanRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel"><IsActive>1</IsActive><PageNumber>1</PageNumber><PageSize>1</PageSize><SearchText>sample string 2</SearchText><UsePaging>true</UsePaging><APIKey>sample string 1</APIKey><DeleteModel><ModifiedBy>2</ModifiedBy><RouteID>1</RouteID></DeleteModel><ReorderModel><ReOrderList>sample string 1</ReOrderList><UserID>2</UserID></ReorderModel><SerachModel><CurrentPage>7</CurrentPage><FromDate>sample string 2</FromDate><IsPagination>6</IsPagination><PageSize>9</PageSize><ResulsPerPage>13</ResulsPerPage><ResultsPageCount>10</ResultsPageCount><RouteID>1</RouteID><RouteName>sample string 4</RouteName><SortingBy>sample string 11</SortingBy><SortingOrder>sample string 12</SortingOrder><Status>5</Status><ToDate>sample string 3</ToDate><UserID>8</UserID></SerachModel><StatusUpdateModel><RouteDetailsID>2</RouteDetailsID><RouteID>1</RouteID><StatusID>3</StatusID><Type>4</Type><UserID>5</UserID></StatusUpdateModel></RoutePlanRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RoutePlanResponceModel

Name	Type	Additional information
routePlan	Collection of RoutePlanResponce	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,
      "routeName": "sample string 2",
      "jobID": "sample string 3",
      "jobName": "sample string 4",
      "driverID": 5,
      "driverName": "sample string 6",
      "allocationDate": "2025-07-17T04:22:01.984431+00:00",
      "description": "sample string 8",
      "status": 9,
      "totalRecord": 10,
      "statusName": "sample string 11",
      "addressJson": "sample string 12",
      "startingPoint": "sample string 13",
      "startingPointType": "sample string 14",
      "endingPoint": "sample string 15",
      "endingPointType": "sample string 16",
      "orderViewDate": "2025-07-17T04:22:01.984431+00:00",
      "details": [
        {
          "id": 1,
          "routeDetailsID": 2,
          "title": "sample string 3",
          "adress": "sample string 4",
          "status": 5,
          "longitude": 6.0,
          "latitude": 7.0,
          "type": "sample string 8",
          "wayBillid": "sample string 9",
          "eta": "sample string 10",
          "duration": "sample string 11",
          "jobCode": "sample string 12",
          "sequence": 13,
          "customerName": "sample string 14",
          "customerPhoneNumber": "sample string 15",
          "typeId": 16,
          "code": "sample string 17",
          "jobStatus": 18,
          "jobType": "sample string 19",
          "parentStatus": 20,
          "statusName": "sample string 21"
        },
        {
          "id": 1,
          "routeDetailsID": 2,
          "title": "sample string 3",
          "adress": "sample string 4",
          "status": 5,
          "longitude": 6.0,
          "latitude": 7.0,
          "type": "sample string 8",
          "wayBillid": "sample string 9",
          "eta": "sample string 10",
          "duration": "sample string 11",
          "jobCode": "sample string 12",
          "sequence": 13,
          "customerName": "sample string 14",
          "customerPhoneNumber": "sample string 15",
          "typeId": 16,
          "code": "sample string 17",
          "jobStatus": 18,
          "jobType": "sample string 19",
          "parentStatus": 20,
          "statusName": "sample string 21"
        }
      ]
    },
    {
      "routeID": 1,
      "routeName": "sample string 2",
      "jobID": "sample string 3",
      "jobName": "sample string 4",
      "driverID": 5,
      "driverName": "sample string 6",
      "allocationDate": "2025-07-17T04:22:01.984431+00:00",
      "description": "sample string 8",
      "status": 9,
      "totalRecord": 10,
      "statusName": "sample string 11",
      "addressJson": "sample string 12",
      "startingPoint": "sample string 13",
      "startingPointType": "sample string 14",
      "endingPoint": "sample string 15",
      "endingPointType": "sample string 16",
      "orderViewDate": "2025-07-17T04:22:01.984431+00:00",
      "details": [
        {
          "id": 1,
          "routeDetailsID": 2,
          "title": "sample string 3",
          "adress": "sample string 4",
          "status": 5,
          "longitude": 6.0,
          "latitude": 7.0,
          "type": "sample string 8",
          "wayBillid": "sample string 9",
          "eta": "sample string 10",
          "duration": "sample string 11",
          "jobCode": "sample string 12",
          "sequence": 13,
          "customerName": "sample string 14",
          "customerPhoneNumber": "sample string 15",
          "typeId": 16,
          "code": "sample string 17",
          "jobStatus": 18,
          "jobType": "sample string 19",
          "parentStatus": 20,
          "statusName": "sample string 21"
        },
        {
          "id": 1,
          "routeDetailsID": 2,
          "title": "sample string 3",
          "adress": "sample string 4",
          "status": 5,
          "longitude": 6.0,
          "latitude": 7.0,
          "type": "sample string 8",
          "wayBillid": "sample string 9",
          "eta": "sample string 10",
          "duration": "sample string 11",
          "jobCode": "sample string 12",
          "sequence": 13,
          "customerName": "sample string 14",
          "customerPhoneNumber": "sample string 15",
          "typeId": 16,
          "code": "sample string 17",
          "jobStatus": 18,
          "jobType": "sample string 19",
          "parentStatus": 20,
          "statusName": "sample string 21"
        }
      ]
    }
  ],
  "returnID": 1,
  "message": "sample string 2",
  "successful": true,
  "code": 4,
  "totalRecord": 5
}

application/xml, text/xml

Sample:

<RoutePlanResponceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">
  <Code>4</Code>
  <Message>sample string 2</Message>
  <ReturnID>1</ReturnID>
  <Successful>true</Successful>
  <TotalRecord>5</TotalRecord>
  <routePlan>
    <RoutePlanResponce>
      <AddressJson>sample string 12</AddressJson>
      <AllocationDate>2025-07-17T04:22:01.984431+00:00</AllocationDate>
      <Description>sample string 8</Description>
      <Details>
        <RoutePlanDetailsVM>
          <Adress>sample string 4</Adress>
          <Code>sample string 17</Code>
          <CustomerName>sample string 14</CustomerName>
          <CustomerPhoneNumber>sample string 15</CustomerPhoneNumber>
          <Duration>sample string 11</Duration>
          <ETA>sample string 10</ETA>
          <ID>1</ID>
          <JobCode>sample string 12</JobCode>
          <JobStatus>18</JobStatus>
          <JobType>sample string 19</JobType>
          <Latitude>7</Latitude>
          <Longitude>6</Longitude>
          <ParentStatus>20</ParentStatus>
          <RouteDetailsID>2</RouteDetailsID>
          <Sequence>13</Sequence>
          <Status>5</Status>
          <StatusName>sample string 21</StatusName>
          <Title>sample string 3</Title>
          <Type>sample string 8</Type>
          <TypeId>16</TypeId>
          <WayBillid>sample string 9</WayBillid>
        </RoutePlanDetailsVM>
        <RoutePlanDetailsVM>
          <Adress>sample string 4</Adress>
          <Code>sample string 17</Code>
          <CustomerName>sample string 14</CustomerName>
          <CustomerPhoneNumber>sample string 15</CustomerPhoneNumber>
          <Duration>sample string 11</Duration>
          <ETA>sample string 10</ETA>
          <ID>1</ID>
          <JobCode>sample string 12</JobCode>
          <JobStatus>18</JobStatus>
          <JobType>sample string 19</JobType>
          <Latitude>7</Latitude>
          <Longitude>6</Longitude>
          <ParentStatus>20</ParentStatus>
          <RouteDetailsID>2</RouteDetailsID>
          <Sequence>13</Sequence>
          <Status>5</Status>
          <StatusName>sample string 21</StatusName>
          <Title>sample string 3</Title>
          <Type>sample string 8</Type>
          <TypeId>16</TypeId>
          <WayBillid>sample string 9</WayBillid>
        </RoutePlanDetailsVM>
      </Details>
      <DriverID>5</DriverID>
      <DriverName>sample string 6</DriverName>
      <EndingPoint>sample string 15</EndingPoint>
      <EndingPointType>sample string 16</EndingPointType>
      <JobID>sample string 3</JobID>
      <JobName>sample string 4</JobName>
      <OrderViewDate>2025-07-17T04:22:01.984431+00:00</OrderViewDate>
      <RouteID>1</RouteID>
      <RouteName>sample string 2</RouteName>
      <StartingPoint>sample string 13</StartingPoint>
      <StartingPointType>sample string 14</StartingPointType>
      <Status>9</Status>
      <StatusName>sample string 11</StatusName>
      <TotalRecord>10</TotalRecord>
    </RoutePlanResponce>
    <RoutePlanResponce>
      <AddressJson>sample string 12</AddressJson>
      <AllocationDate>2025-07-17T04:22:01.984431+00:00</AllocationDate>
      <Description>sample string 8</Description>
      <Details>
        <RoutePlanDetailsVM>
          <Adress>sample string 4</Adress>
          <Code>sample string 17</Code>
          <CustomerName>sample string 14</CustomerName>
          <CustomerPhoneNumber>sample string 15</CustomerPhoneNumber>
          <Duration>sample string 11</Duration>
          <ETA>sample string 10</ETA>
          <ID>1</ID>
          <JobCode>sample string 12</JobCode>
          <JobStatus>18</JobStatus>
          <JobType>sample string 19</JobType>
          <Latitude>7</Latitude>
          <Longitude>6</Longitude>
          <ParentStatus>20</ParentStatus>
          <RouteDetailsID>2</RouteDetailsID>
          <Sequence>13</Sequence>
          <Status>5</Status>
          <StatusName>sample string 21</StatusName>
          <Title>sample string 3</Title>
          <Type>sample string 8</Type>
          <TypeId>16</TypeId>
          <WayBillid>sample string 9</WayBillid>
        </RoutePlanDetailsVM>
        <RoutePlanDetailsVM>
          <Adress>sample string 4</Adress>
          <Code>sample string 17</Code>
          <CustomerName>sample string 14</CustomerName>
          <CustomerPhoneNumber>sample string 15</CustomerPhoneNumber>
          <Duration>sample string 11</Duration>
          <ETA>sample string 10</ETA>
          <ID>1</ID>
          <JobCode>sample string 12</JobCode>
          <JobStatus>18</JobStatus>
          <JobType>sample string 19</JobType>
          <Latitude>7</Latitude>
          <Longitude>6</Longitude>
          <ParentStatus>20</ParentStatus>
          <RouteDetailsID>2</RouteDetailsID>
          <Sequence>13</Sequence>
          <Status>5</Status>
          <StatusName>sample string 21</StatusName>
          <Title>sample string 3</Title>
          <Type>sample string 8</Type>
          <TypeId>16</TypeId>
          <WayBillid>sample string 9</WayBillid>
        </RoutePlanDetailsVM>
      </Details>
      <DriverID>5</DriverID>
      <DriverName>sample string 6</DriverName>
      <EndingPoint>sample string 15</EndingPoint>
      <EndingPointType>sample string 16</EndingPointType>
      <JobID>sample string 3</JobID>
      <JobName>sample string 4</JobName>
      <OrderViewDate>2025-07-17T04:22:01.984431+00:00</OrderViewDate>
      <RouteID>1</RouteID>
      <RouteName>sample string 2</RouteName>
      <StartingPoint>sample string 13</StartingPoint>
      <StartingPointType>sample string 14</StartingPointType>
      <Status>9</Status>
      <StatusName>sample string 11</StatusName>
      <TotalRecord>10</TotalRecord>
    </RoutePlanResponce>
  </routePlan>
</RoutePlanResponceModel>

multipart/form-data

Sample:

<RoutePlanResponceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"><Code>4</Code><Message>sample string 2</Message><ReturnID>1</ReturnID><Successful>true</Successful><TotalRecord>5</TotalRecord><routePlan><RoutePlanResponce><AddressJson>sample string 12</AddressJson><AllocationDate>2025-07-17T04:22:01.984431+00:00</AllocationDate><Description>sample string 8</Description><Details><RoutePlanDetailsVM><Adress>sample string 4</Adress><Code>sample string 17</Code><CustomerName>sample string 14</CustomerName><CustomerPhoneNumber>sample string 15</CustomerPhoneNumber><Duration>sample string 11</Duration><ETA>sample string 10</ETA><ID>1</ID><JobCode>sample string 12</JobCode><JobStatus>18</JobStatus><JobType>sample string 19</JobType><Latitude>7</Latitude><Longitude>6</Longitude><ParentStatus>20</ParentStatus><RouteDetailsID>2</RouteDetailsID><Sequence>13</Sequence><Status>5</Status><StatusName>sample string 21</StatusName><Title>sample string 3</Title><Type>sample string 8</Type><TypeId>16</TypeId><WayBillid>sample string 9</WayBillid></RoutePlanDetailsVM><RoutePlanDetailsVM><Adress>sample string 4</Adress><Code>sample string 17</Code><CustomerName>sample string 14</CustomerName><CustomerPhoneNumber>sample string 15</CustomerPhoneNumber><Duration>sample string 11</Duration><ETA>sample string 10</ETA><ID>1</ID><JobCode>sample string 12</JobCode><JobStatus>18</JobStatus><JobType>sample string 19</JobType><Latitude>7</Latitude><Longitude>6</Longitude><ParentStatus>20</ParentStatus><RouteDetailsID>2</RouteDetailsID><Sequence>13</Sequence><Status>5</Status><StatusName>sample string 21</StatusName><Title>sample string 3</Title><Type>sample string 8</Type><TypeId>16</TypeId><WayBillid>sample string 9</WayBillid></RoutePlanDetailsVM></Details><DriverID>5</DriverID><DriverName>sample string 6</DriverName><EndingPoint>sample string 15</EndingPoint><EndingPointType>sample string 16</EndingPointType><JobID>sample string 3</JobID><JobName>sample string 4</JobName><OrderViewDate>2025-07-17T04:22:01.984431+00:00</OrderViewDate><RouteID>1</RouteID><RouteName>sample string 2</RouteName><StartingPoint>sample string 13</StartingPoint><StartingPointType>sample string 14</StartingPointType><Status>9</Status><StatusName>sample string 11</StatusName><TotalRecord>10</TotalRecord></RoutePlanResponce><RoutePlanResponce><AddressJson>sample string 12</AddressJson><AllocationDate>2025-07-17T04:22:01.984431+00:00</AllocationDate><Description>sample string 8</Description><Details><RoutePlanDetailsVM><Adress>sample string 4</Adress><Code>sample string 17</Code><CustomerName>sample string 14</CustomerName><CustomerPhoneNumber>sample string 15</CustomerPhoneNumber><Duration>sample string 11</Duration><ETA>sample string 10</ETA><ID>1</ID><JobCode>sample string 12</JobCode><JobStatus>18</JobStatus><JobType>sample string 19</JobType><Latitude>7</Latitude><Longitude>6</Longitude><ParentStatus>20</ParentStatus><RouteDetailsID>2</RouteDetailsID><Sequence>13</Sequence><Status>5</Status><StatusName>sample string 21</StatusName><Title>sample string 3</Title><Type>sample string 8</Type><TypeId>16</TypeId><WayBillid>sample string 9</WayBillid></RoutePlanDetailsVM><RoutePlanDetailsVM><Adress>sample string 4</Adress><Code>sample string 17</Code><CustomerName>sample string 14</CustomerName><CustomerPhoneNumber>sample string 15</CustomerPhoneNumber><Duration>sample string 11</Duration><ETA>sample string 10</ETA><ID>1</ID><JobCode>sample string 12</JobCode><JobStatus>18</JobStatus><JobType>sample string 19</JobType><Latitude>7</Latitude><Longitude>6</Longitude><ParentStatus>20</ParentStatus><RouteDetailsID>2</RouteDetailsID><Sequence>13</Sequence><Status>5</Status><StatusName>sample string 21</StatusName><Title>sample string 3</Title><Type>sample string 8</Type><TypeId>16</TypeId><WayBillid>sample string 9</WayBillid></RoutePlanDetailsVM></Details><DriverID>5</DriverID><DriverName>sample string 6</DriverName><EndingPoint>sample string 15</EndingPoint><EndingPointType>sample string 16</EndingPointType><JobID>sample string 3</JobID><JobName>sample string 4</JobName><OrderViewDate>2025-07-17T04:22:01.984431+00:00</OrderViewDate><RouteID>1</RouteID><RouteName>sample string 2</RouteName><StartingPoint>sample string 13</StartingPoint><StartingPointType>sample string 14</StartingPointType><Status>9</Status><StatusName>sample string 11</StatusName><TotalRecord>10</TotalRecord></RoutePlanResponce></routePlan></RoutePlanResponceModel>