/Routes
- 18 Jan 2024
- Print
- PDF
/Routes
- Updated on 18 Jan 2024
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/Routes
Security
Http
Type bearer
Bearer Authorization Token
Query parameters
$select
string
$filter
string
$expand
string
$orderby
string
$skip
string
$top
string
$pageNumber
string
$limit
string
Responses
200
Success
Array of object
object
RouteID
integer (int32)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
RouteName
string
Max length100
Min length0
Hours
number (double)
Color
string
Max length10
Min length0
CrewLeaderContactID
integer (int32)
CrewLeaderContactName
string
Max length101
Min length0
Active
boolean
ManagerContactID
integer (int32)
ManagerName
string
Max length101
Min length0
RouteSize
integer (int32)
DivisionID
integer (int32)
DivisionName
string
Max length50
Min length0
DisplayOrder
integer (int32)
PercentTravelTime
integer (int32)
ShowDailyPlan
boolean
AllowEquipmentTimeReporting
boolean
EquipmentID
integer (int32)
EquipmentName
string
Max length250
Min length0
RouteProperties
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteProperty)
object
RoutePropertyID
integer (int32)
PropertyID
integer (int32)
PropertyName
string
Max length100
Min length0
DisplayOrder
integer (int32)
RouteServices
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteService)
object
ServiceID
integer (int32)
ServiceName
string
Max length150
Min length0
RouteServiceTypes
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteServiceType)
object
ServiceTypeID
integer (int32)
ServiceTypeName
string
Max length100
Min length0
Array of object
object
RouteID
integer (int32)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
RouteName
string
Max length100
Min length0
Hours
number (double)
Color
string
Max length10
Min length0
CrewLeaderContactID
integer (int32)
CrewLeaderContactName
string
Max length101
Min length0
Active
boolean
ManagerContactID
integer (int32)
ManagerName
string
Max length101
Min length0
RouteSize
integer (int32)
DivisionID
integer (int32)
DivisionName
string
Max length50
Min length0
DisplayOrder
integer (int32)
PercentTravelTime
integer (int32)
ShowDailyPlan
boolean
AllowEquipmentTimeReporting
boolean
EquipmentID
integer (int32)
EquipmentName
string
Max length250
Min length0
RouteProperties
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteProperty)
object
RoutePropertyID
integer (int32)
PropertyID
integer (int32)
PropertyName
string
Max length100
Min length0
DisplayOrder
integer (int32)
RouteServices
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteService)
object
ServiceID
integer (int32)
ServiceName
string
Max length150
Min length0
RouteServiceTypes
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteServiceType)
object
ServiceTypeID
integer (int32)
ServiceTypeName
string
Max length100
Min length0
Array of object
object
RouteID
integer (int32)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
RouteName
string
Max length100
Min length0
Hours
number (double)
Color
string
Max length10
Min length0
CrewLeaderContactID
integer (int32)
CrewLeaderContactName
string
Max length101
Min length0
Active
boolean
ManagerContactID
integer (int32)
ManagerName
string
Max length101
Min length0
RouteSize
integer (int32)
DivisionID
integer (int32)
DivisionName
string
Max length50
Min length0
DisplayOrder
integer (int32)
PercentTravelTime
integer (int32)
ShowDailyPlan
boolean
AllowEquipmentTimeReporting
boolean
EquipmentID
integer (int32)
EquipmentName
string
Max length250
Min length0
RouteProperties
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteProperty)
object
RoutePropertyID
integer (int32)
PropertyID
integer (int32)
PropertyName
string
Max length100
Min length0
DisplayOrder
integer (int32)
RouteServices
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteService)
object
ServiceID
integer (int32)
ServiceName
string
Max length150
Min length0
RouteServiceTypes
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteServiceType)
object
ServiceTypeID
integer (int32)
ServiceTypeName
string
Max length100
Min length0
Array of object
object
RouteID
integer (int32)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
RouteName
string
Max length100
Min length0
Hours
number (double)
Color
string
Max length10
Min length0
CrewLeaderContactID
integer (int32)
CrewLeaderContactName
string
Max length101
Min length0
Active
boolean
ManagerContactID
integer (int32)
ManagerName
string
Max length101
Min length0
RouteSize
integer (int32)
DivisionID
integer (int32)
DivisionName
string
Max length50
Min length0
DisplayOrder
integer (int32)
PercentTravelTime
integer (int32)
ShowDailyPlan
boolean
AllowEquipmentTimeReporting
boolean
EquipmentID
integer (int32)
EquipmentName
string
Max length250
Min length0
RouteProperties
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteProperty)
object
RoutePropertyID
integer (int32)
PropertyID
integer (int32)
PropertyName
string
Max length100
Min length0
DisplayOrder
integer (int32)
RouteServices
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteService)
object
ServiceID
integer (int32)
ServiceName
string
Max length150
Min length0
RouteServiceTypes
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteServiceType)
object
ServiceTypeID
integer (int32)
ServiceTypeName
string
Max length100
Min length0
Array of object
object
RouteID
integer (int32)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
RouteName
string
Max length100
Min length0
Hours
number (double)
Color
string
Max length10
Min length0
CrewLeaderContactID
integer (int32)
CrewLeaderContactName
string
Max length101
Min length0
Active
boolean
ManagerContactID
integer (int32)
ManagerName
string
Max length101
Min length0
RouteSize
integer (int32)
DivisionID
integer (int32)
DivisionName
string
Max length50
Min length0
DisplayOrder
integer (int32)
PercentTravelTime
integer (int32)
ShowDailyPlan
boolean
AllowEquipmentTimeReporting
boolean
EquipmentID
integer (int32)
EquipmentName
string
Max length250
Min length0
RouteProperties
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteProperty)
object
RoutePropertyID
integer (int32)
PropertyID
integer (int32)
PropertyName
string
Max length100
Min length0
DisplayOrder
integer (int32)
RouteServices
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteService)
object
ServiceID
integer (int32)
ServiceName
string
Max length150
Min length0
RouteServiceTypes
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteServiceType)
object
ServiceTypeID
integer (int32)
ServiceTypeName
string
Max length100
Min length0
Array of object
object
RouteID
integer (int32)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
RouteName
string
Max length100
Min length0
Hours
number (double)
Color
string
Max length10
Min length0
CrewLeaderContactID
integer (int32)
CrewLeaderContactName
string
Max length101
Min length0
Active
boolean
ManagerContactID
integer (int32)
ManagerName
string
Max length101
Min length0
RouteSize
integer (int32)
DivisionID
integer (int32)
DivisionName
string
Max length50
Min length0
DisplayOrder
integer (int32)
PercentTravelTime
integer (int32)
ShowDailyPlan
boolean
AllowEquipmentTimeReporting
boolean
EquipmentID
integer (int32)
EquipmentName
string
Max length250
Min length0
RouteProperties
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteProperty)
object
RoutePropertyID
integer (int32)
PropertyID
integer (int32)
PropertyName
string
Max length100
Min length0
DisplayOrder
integer (int32)
RouteServices
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteService)
object
ServiceID
integer (int32)
ServiceName
string
Max length150
Min length0
RouteServiceTypes
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteServiceType)
object
ServiceTypeID
integer (int32)
ServiceTypeName
string
Max length100
Min length0
Array of object
object
RouteID
integer (int32)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
RouteName
string
Max length100
Min length0
Hours
number (double)
Color
string
Max length10
Min length0
CrewLeaderContactID
integer (int32)
CrewLeaderContactName
string
Max length101
Min length0
Active
boolean
ManagerContactID
integer (int32)
ManagerName
string
Max length101
Min length0
RouteSize
integer (int32)
DivisionID
integer (int32)
DivisionName
string
Max length50
Min length0
DisplayOrder
integer (int32)
PercentTravelTime
integer (int32)
ShowDailyPlan
boolean
AllowEquipmentTimeReporting
boolean
EquipmentID
integer (int32)
EquipmentName
string
Max length250
Min length0
RouteProperties
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteProperty)
object
RoutePropertyID
integer (int32)
PropertyID
integer (int32)
PropertyName
string
Max length100
Min length0
DisplayOrder
integer (int32)
RouteServices
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteService)
object
ServiceID
integer (int32)
ServiceName
string
Max length150
Min length0
RouteServiceTypes
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteServiceType)
object
ServiceTypeID
integer (int32)
ServiceTypeName
string
Max length100
Min length0
Array of object
object
RouteID
integer (int32)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
RouteName
string
Max length100
Min length0
Hours
number (double)
Color
string
Max length10
Min length0
CrewLeaderContactID
integer (int32)
CrewLeaderContactName
string
Max length101
Min length0
Active
boolean
ManagerContactID
integer (int32)
ManagerName
string
Max length101
Min length0
RouteSize
integer (int32)
DivisionID
integer (int32)
DivisionName
string
Max length50
Min length0
DisplayOrder
integer (int32)
PercentTravelTime
integer (int32)
ShowDailyPlan
boolean
AllowEquipmentTimeReporting
boolean
EquipmentID
integer (int32)
EquipmentName
string
Max length250
Min length0
RouteProperties
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteProperty)
object
RoutePropertyID
integer (int32)
PropertyID
integer (int32)
PropertyName
string
Max length100
Min length0
DisplayOrder
integer (int32)
RouteServices
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteService)
object
ServiceID
integer (int32)
ServiceName
string
Max length150
Min length0
RouteServiceTypes
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteServiceType)
object
ServiceTypeID
integer (int32)
ServiceTypeName
string
Max length100
Min length0
Array of object
object
RouteID
integer (int32)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
RouteName
string
Max length100
Min length0
Hours
number (double)
Color
string
Max length10
Min length0
CrewLeaderContactID
integer (int32)
CrewLeaderContactName
string
Max length101
Min length0
Active
boolean
ManagerContactID
integer (int32)
ManagerName
string
Max length101
Min length0
RouteSize
integer (int32)
DivisionID
integer (int32)
DivisionName
string
Max length50
Min length0
DisplayOrder
integer (int32)
PercentTravelTime
integer (int32)
ShowDailyPlan
boolean
AllowEquipmentTimeReporting
boolean
EquipmentID
integer (int32)
EquipmentName
string
Max length250
Min length0
RouteProperties
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteProperty)
object
RoutePropertyID
integer (int32)
PropertyID
integer (int32)
PropertyName
string
Max length100
Min length0
DisplayOrder
integer (int32)
RouteServices
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteService)
object
ServiceID
integer (int32)
ServiceName
string
Max length150
Min length0
RouteServiceTypes
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteServiceType)
object
ServiceTypeID
integer (int32)
ServiceTypeName
string
Max length100
Min length0
Array of object
object
RouteID
integer (int32)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
RouteName
string
Max length100
Min length0
Hours
number (double)
Color
string
Max length10
Min length0
CrewLeaderContactID
integer (int32)
CrewLeaderContactName
string
Max length101
Min length0
Active
boolean
ManagerContactID
integer (int32)
ManagerName
string
Max length101
Min length0
RouteSize
integer (int32)
DivisionID
integer (int32)
DivisionName
string
Max length50
Min length0
DisplayOrder
integer (int32)
PercentTravelTime
integer (int32)
ShowDailyPlan
boolean
AllowEquipmentTimeReporting
boolean
EquipmentID
integer (int32)
EquipmentName
string
Max length250
Min length0
RouteProperties
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteProperty)
object
RoutePropertyID
integer (int32)
PropertyID
integer (int32)
PropertyName
string
Max length100
Min length0
DisplayOrder
integer (int32)
RouteServices
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteService)
object
ServiceID
integer (int32)
ServiceName
string
Max length150
Min length0
RouteServiceTypes
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteServiceType)
object
ServiceTypeID
integer (int32)
ServiceTypeName
string
Max length100
Min length0
Array of object
object
RouteID
integer (int32)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
RouteName
string
Max length100
Min length0
Hours
number (double)
Color
string
Max length10
Min length0
CrewLeaderContactID
integer (int32)
CrewLeaderContactName
string
Max length101
Min length0
Active
boolean
ManagerContactID
integer (int32)
ManagerName
string
Max length101
Min length0
RouteSize
integer (int32)
DivisionID
integer (int32)
DivisionName
string
Max length50
Min length0
DisplayOrder
integer (int32)
PercentTravelTime
integer (int32)
ShowDailyPlan
boolean
AllowEquipmentTimeReporting
boolean
EquipmentID
integer (int32)
EquipmentName
string
Max length250
Min length0
RouteProperties
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteProperty)
object
RoutePropertyID
integer (int32)
PropertyID
integer (int32)
PropertyName
string
Max length100
Min length0
DisplayOrder
integer (int32)
RouteServices
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteService)
object
ServiceID
integer (int32)
ServiceName
string
Max length150
Min length0
RouteServiceTypes
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteServiceType)
object
ServiceTypeID
integer (int32)
ServiceTypeName
string
Max length100
Min length0
Array of object
object
RouteID
integer (int32)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
RouteName
string
Max length100
Min length0
Hours
number (double)
Color
string
Max length10
Min length0
CrewLeaderContactID
integer (int32)
CrewLeaderContactName
string
Max length101
Min length0
Active
boolean
ManagerContactID
integer (int32)
ManagerName
string
Max length101
Min length0
RouteSize
integer (int32)
DivisionID
integer (int32)
DivisionName
string
Max length50
Min length0
DisplayOrder
integer (int32)
PercentTravelTime
integer (int32)
ShowDailyPlan
boolean
AllowEquipmentTimeReporting
boolean
EquipmentID
integer (int32)
EquipmentName
string
Max length250
Min length0
RouteProperties
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteProperty)
object
RoutePropertyID
integer (int32)
PropertyID
integer (int32)
PropertyName
string
Max length100
Min length0
DisplayOrder
integer (int32)
RouteServices
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteService)
object
ServiceID
integer (int32)
ServiceName
string
Max length150
Min length0
RouteServiceTypes
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteServiceType)
object
ServiceTypeID
integer (int32)
ServiceTypeName
string
Max length100
Min length0
Array of object
object
RouteID
integer (int32)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
RouteName
string
Max length100
Min length0
Hours
number (double)
Color
string
Max length10
Min length0
CrewLeaderContactID
integer (int32)
CrewLeaderContactName
string
Max length101
Min length0
Active
boolean
ManagerContactID
integer (int32)
ManagerName
string
Max length101
Min length0
RouteSize
integer (int32)
DivisionID
integer (int32)
DivisionName
string
Max length50
Min length0
DisplayOrder
integer (int32)
PercentTravelTime
integer (int32)
ShowDailyPlan
boolean
AllowEquipmentTimeReporting
boolean
EquipmentID
integer (int32)
EquipmentName
string
Max length250
Min length0
RouteProperties
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteProperty)
object
RoutePropertyID
integer (int32)
PropertyID
integer (int32)
PropertyName
string
Max length100
Min length0
DisplayOrder
integer (int32)
RouteServices
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteService)
object
ServiceID
integer (int32)
ServiceName
string
Max length150
Min length0
RouteServiceTypes
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteServiceType)
object
ServiceTypeID
integer (int32)
ServiceTypeName
string
Max length100
Min length0
Array of object
object
RouteID
integer (int32)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
RouteName
string
Max length100
Min length0
Hours
number (double)
Color
string
Max length10
Min length0
CrewLeaderContactID
integer (int32)
CrewLeaderContactName
string
Max length101
Min length0
Active
boolean
ManagerContactID
integer (int32)
ManagerName
string
Max length101
Min length0
RouteSize
integer (int32)
DivisionID
integer (int32)
DivisionName
string
Max length50
Min length0
DisplayOrder
integer (int32)
PercentTravelTime
integer (int32)
ShowDailyPlan
boolean
AllowEquipmentTimeReporting
boolean
EquipmentID
integer (int32)
EquipmentName
string
Max length250
Min length0
RouteProperties
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteProperty)
object
RoutePropertyID
integer (int32)
PropertyID
integer (int32)
PropertyName
string
Max length100
Min length0
DisplayOrder
integer (int32)
RouteServices
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteService)
object
ServiceID
integer (int32)
ServiceName
string
Max length150
Min length0
RouteServiceTypes
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteServiceType)
object
ServiceTypeID
integer (int32)
ServiceTypeName
string
Max length100
Min length0
Array of object
object
RouteID
integer (int32)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
RouteName
string
Max length100
Min length0
Hours
number (double)
Color
string
Max length10
Min length0
CrewLeaderContactID
integer (int32)
CrewLeaderContactName
string
Max length101
Min length0
Active
boolean
ManagerContactID
integer (int32)
ManagerName
string
Max length101
Min length0
RouteSize
integer (int32)
DivisionID
integer (int32)
DivisionName
string
Max length50
Min length0
DisplayOrder
integer (int32)
PercentTravelTime
integer (int32)
ShowDailyPlan
boolean
AllowEquipmentTimeReporting
boolean
EquipmentID
integer (int32)
EquipmentName
string
Max length250
Min length0
RouteProperties
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteProperty)
object
RoutePropertyID
integer (int32)
PropertyID
integer (int32)
PropertyName
string
Max length100
Min length0
DisplayOrder
integer (int32)
RouteServices
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteService)
object
ServiceID
integer (int32)
ServiceName
string
Max length150
Min length0
RouteServiceTypes
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteServiceType)
object
ServiceTypeID
integer (int32)
ServiceTypeName
string
Max length100
Min length0
Array of object
object
RouteID
integer (int32)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
RouteName
string
Max length100
Min length0
Hours
number (double)
Color
string
Max length10
Min length0
CrewLeaderContactID
integer (int32)
CrewLeaderContactName
string
Max length101
Min length0
Active
boolean
ManagerContactID
integer (int32)
ManagerName
string
Max length101
Min length0
RouteSize
integer (int32)
DivisionID
integer (int32)
DivisionName
string
Max length50
Min length0
DisplayOrder
integer (int32)
PercentTravelTime
integer (int32)
ShowDailyPlan
boolean
AllowEquipmentTimeReporting
boolean
EquipmentID
integer (int32)
EquipmentName
string
Max length250
Min length0
RouteProperties
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteProperty)
object
RoutePropertyID
integer (int32)
PropertyID
integer (int32)
PropertyName
string
Max length100
Min length0
DisplayOrder
integer (int32)
RouteServices
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteService)
object
ServiceID
integer (int32)
ServiceName
string
Max length150
Min length0
RouteServiceTypes
Array of object (AspireCloud.Domain.Tenant.Routes.ODataModel.RouteServiceType)
object
ServiceTypeID
integer (int32)
ServiceTypeName
string
Max length100
Min length0
Was this article helpful?