POST api/Routes/{routeId}/Close

Request Information

URI Parameters

Name	Description	Type	Additional information
routeId		integer	Required

Body Parameters

Route

Name	Type	Additional information
Name	string	None.
ExpirationDate	date	None.
Status	integer	None.
Type	integer	None.
ActivationDate	date	None.
TotalDistance	decimal number	None.
TotalDuration	decimal number	None.
CloseDetail	string	None.
CloseUser	string	None.
CloseDate	date	None.
TotalEstimatedDistance	decimal number	None.
TotalEstimatedDuration	decimal number	None.
CompanyId	integer	None.
RouteFrequencyId	integer	None.
Company	Company	None.
RouteFrequency	RouteFrequency	None.
Id	integer	None.
CreatedDate	date	None.
CreatedBy	string	None.
UpdateDate	date	None.
UpdatedBy	string	None.
IsActive	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "ExpirationDate": "2025-12-05T23:07:00.8101806-06:00",
  "Status": 3,
  "Type": 4,
  "ActivationDate": "2025-12-05T23:07:00.8101806-06:00",
  "TotalDistance": 5.1,
  "TotalDuration": 6.1,
  "CloseDetail": "sample string 7",
  "CloseUser": "sample string 8",
  "CloseDate": "2025-12-05T23:07:00.8101806-06:00",
  "TotalEstimatedDistance": 9.1,
  "TotalEstimatedDuration": 10.1,
  "CompanyId": 11,
  "RouteFrequencyId": 12,
  "Company": {
    "ConnectionId": 1,
    "Connection": {
      "Name": "sample string 1",
      "Odbctype": "sample string 2",
      "Server": "sample string 3",
      "User": "sample string 4",
      "Pass": "sample string 5",
      "ServerType": "sample string 6",
      "SLUrl": "sample string 7",
      "Id": 8,
      "CreatedDate": "2025-12-05T23:07:00.8101806-06:00",
      "CreatedBy": "sample string 10",
      "UpdateDate": "2025-12-05T23:07:00.8101806-06:00",
      "UpdatedBy": "sample string 11",
      "IsActive": true
    },
    "Name": "sample string 2",
    "DatabaseCode": "sample string 3",
    "Id": 4,
    "CreatedDate": "2025-12-05T23:07:00.8101806-06:00",
    "CreatedBy": "sample string 6",
    "UpdateDate": "2025-12-05T23:07:00.8101806-06:00",
    "UpdatedBy": "sample string 7",
    "IsActive": true
  },
  "RouteFrequency": {
    "Description": "sample string 1",
    "Weeks": "sample string 2",
    "Days": "sample string 3",
    "Id": 4,
    "CreatedDate": "2025-12-05T23:07:00.8111805-06:00",
    "CreatedBy": "sample string 6",
    "UpdateDate": "2025-12-05T23:07:00.8111805-06:00",
    "UpdatedBy": "sample string 7",
    "IsActive": true
  },
  "Id": 13,
  "CreatedDate": "2025-12-05T23:07:00.8111805-06:00",
  "CreatedBy": "sample string 15",
  "UpdateDate": "2025-12-05T23:07:00.8111805-06:00",
  "UpdatedBy": "sample string 16",
  "IsActive": true
}

application/xml, text/xml

Sample:

<Route xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CLMLTEMA.MODELS">
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 15</CreatedBy>
  <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-12-05T23:07:00.8111805-06:00</CreatedDate>
  <Id xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">13</Id>
  <IsActive xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">true</IsActive>
  <UpdateDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-12-05T23:07:00.8111805-06:00</UpdateDate>
  <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 16</UpdatedBy>
  <ActivationDate>2025-12-05T23:07:00.8101806-06:00</ActivationDate>
  <CloseDate>2025-12-05T23:07:00.8101806-06:00</CloseDate>
  <CloseDetail>sample string 7</CloseDetail>
  <CloseUser>sample string 8</CloseUser>
  <Company>
    <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 6</CreatedBy>
    <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-12-05T23:07:00.8101806-06:00</CreatedDate>
    <Id xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">4</Id>
    <IsActive xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">true</IsActive>
    <UpdateDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-12-05T23:07:00.8101806-06:00</UpdateDate>
    <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 7</UpdatedBy>
    <DatabaseCode xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 3</DatabaseCode>
    <Name xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 2</Name>
    <Connection>
      <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 10</CreatedBy>
      <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-12-05T23:07:00.8101806-06:00</CreatedDate>
      <Id xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">8</Id>
      <IsActive xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">true</IsActive>
      <UpdateDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-12-05T23:07:00.8101806-06:00</UpdateDate>
      <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 11</UpdatedBy>
      <Name xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 1</Name>
      <Odbctype xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 2</Odbctype>
      <Pass xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 5</Pass>
      <SLUrl xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 7</SLUrl>
      <Server xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 3</Server>
      <ServerType xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 6</ServerType>
      <User xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 4</User>
    </Connection>
    <ConnectionId>1</ConnectionId>
  </Company>
  <CompanyId>11</CompanyId>
  <ExpirationDate>2025-12-05T23:07:00.8101806-06:00</ExpirationDate>
  <Name>sample string 1</Name>
  <RouteFrequency>
    <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 6</CreatedBy>
    <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-12-05T23:07:00.8111805-06:00</CreatedDate>
    <Id xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">4</Id>
    <IsActive xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">true</IsActive>
    <UpdateDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-12-05T23:07:00.8111805-06:00</UpdateDate>
    <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 7</UpdatedBy>
    <Days>sample string 3</Days>
    <Description>sample string 1</Description>
    <Weeks>sample string 2</Weeks>
  </RouteFrequency>
  <RouteFrequencyId>12</RouteFrequencyId>
  <Status>3</Status>
  <TotalDistance>5.1</TotalDistance>
  <TotalDuration>6.1</TotalDuration>
  <TotalEstimatedDistance>9.1</TotalEstimatedDistance>
  <TotalEstimatedDuration>10.1</TotalEstimatedDuration>
  <Type>4</Type>
</Route>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.