POST api/OptimizeSchedule

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
fromDate	date	None.
toDate	date	None.
currentTime	string	None.
TimeZone	string	None.
BatchMode	boolean	None.
territory	Collection of string	None.
location	Collection of string	None.
optimizerId	string	None.
loginDetail	clsLoginDetail	None.

Request Formats

application/json, text/json

Sample:

{
  "fromDate": "2025-12-13T19:54:07.3233587+00:00",
  "toDate": "2025-12-13T19:54:07.3233587+00:00",
  "currentTime": "sample string 3",
  "TimeZone": "sample string 4",
  "BatchMode": true,
  "territory": [
    "sample string 1",
    "sample string 2"
  ],
  "location": [
    "sample string 1",
    "sample string 2"
  ],
  "optimizerId": "sample string 6",
  "loginDetail": {
    "sessionID": "sample string 1",
    "serverURL": "sample string 2",
    "orgID": "sample string 3",
    "userName": "sample string 4",
    "password": "sample string 5",
    "securityToken": "sample string 6",
    "connectionString": "sample string 7",
    "MetadataServerURL": "sample string 8"
  }
}

application/xml, text/xml

Sample:

<OptimizeScheduleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RouteOptimizerWebAPI.Models">
  <BatchMode>true</BatchMode>
  <TimeZone>sample string 4</TimeZone>
  <currentTime>sample string 3</currentTime>
  <fromDate>2025-12-13T19:54:07.3233587+00:00</fromDate>
  <location xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </location>
  <loginDetail>
    <MetadataServerURL>sample string 8</MetadataServerURL>
    <connectionString>sample string 7</connectionString>
    <orgID>sample string 3</orgID>
    <password>sample string 5</password>
    <securityToken>sample string 6</securityToken>
    <serverURL>sample string 2</serverURL>
    <sessionID>sample string 1</sessionID>
    <userName>sample string 4</userName>
  </loginDetail>
  <optimizerId>sample string 6</optimizerId>
  <territory xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </territory>
  <toDate>2025-12-13T19:54:07.3233587+00:00</toDate>
</OptimizeScheduleRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OptimizeRouteResult

Name	Type	Additional information
error	string	None.
success	boolean	None.
sessionId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "error": "sample string 1",
  "success": true,
  "sessionId": "sample string 3"
}

application/xml, text/xml

Sample:

<OptimizeRouteResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RouteOptimizerWebAPI.Models">
  <error>sample string 1</error>
  <sessionId>sample string 3</sessionId>
  <success>true</success>
</OptimizeRouteResult>