Field Squared API Services

<back to all web services

RouteList

The following routes are available for this service:
GET/{Workspace}/RouteList
GET/{Workspace}/RouteList/Count
RouteList Parameters:
NameParameterData TypeRequiredDescription
WorkspacepathstringNo
DateGeneratedquerystringNo
RoutesqueryList<Route>No
RecordsAvailablequerylongNo
Route Parameters:
NameParameterData TypeRequiredDescription
WorkspaceformstringNo
AssignedWorkspaceformstringNo
ObjectIdformstringNo
VersionIdformstringNo
BasedOnformstringNo
CreatedformstringNo
LastUpdatedformstringNo
DateformstringNo
StartTimeformstringNo
EndTimeformstringNo
UserIdformstringNo
NameformstringNo
TypeformstringNo
SegmentsformList<RouteSegment>No
TotalTimeformintNo
TotalDistanceformdoubleNo
NodesformList<RouteNode>No
RouteSegment Parameters:
NameParameterData TypeRequiredDescription
TimeformintNo
DistanceformdoubleNo
StartformstringNo
EndformstringNo
GeometryformList<Location>No
DrivingDirectionsformList<string>No
EndNodeformRouteNodeNo
Location Parameters:
NameParameterData TypeRequiredDescription
yformdoubleNo
xformdoubleNo
RouteNode Parameters:
NameParameterData TypeRequiredDescription
LocationformLocationNo
StopTimeformintNo
ScheduleformScheduleNo
NameformstringNo
ClassedItem Parameters:
NameParameterData TypeRequiredDescription
ObjectIdformstringNo
ClassformstringNo
VersionIdformstringNo
AncestorsformList<string>No
TypeformstringNo
Schedule Parameters:
NameParameterData TypeRequiredDescription
WorkspaceformstringNo
ObjectIdformstringNo
VersionIdformstringNo
BasedOnformstringNo
StartformstringNo
EndformstringNo
TimeZoneformstringNo
UsersformList<string>No
TeamsformList<string>No
DataformDictionary<string, Object>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /{Workspace}/RouteList HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/csv