[v2.6] FixedRoute

Overview

This endpoint covers the following functionality:

GetActiveFixedRoutes: Returns a list of currently active fixed routes, route information and the collection of stops are on the route.
FixedRoute: Provides the ability for an external system to load an address into SCC as a fixed route stop.

Response

Property	Data Type	Notes
name	string	Fixed route name.
effectiveDateStart	string	The start date for the fixed route.
effectiveDateEnd	string	The end date for the fixed route.
cutoffTime	string	The cutoff time used by the system when determining if the tender can be released on days the route is executed.
carrierName	string	Carrier servicing the route.
carrierServiceName	string	Service of the carrier being used.
scheduledDays	Collection -String	The days of the week that the route is run.
stopNames	Collection - String	The stops included in the fixed route.

Request Body

Property	Data Type	Notes
stopName	string	Name assigned to the fixed route stop.
stopType	string	Vendor Customer OriginLocation
active	boolean	Is the stop active currently?
notes	string
fixedRouteNames	Collection - String	List of fixed routes this stop is on. Should be blank when transmitted to SCC.

address

identificationNumbers

Property	Data Type	Notes
vat	string	Not applicable.
eori	string	Not applicable.

Response

Property	Data Type	Notes
successfulSaveCount	integer	int32
errorMessages	string