<back to all web services
RouteList
The following routes are available for this service:| GET | /{Workspace}/RouteList | | |
|---|
| GET | /{Workspace}/RouteList/Count | | |
|---|
RouteList Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Workspace | path | string | No | |
| DateGenerated | query | string | No | |
| Routes | query | List<Route> | No | |
| RecordsAvailable | query | long | No | |
Route Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Workspace | form | string | No | |
| AssignedWorkspace | form | string | No | |
| ObjectId | form | string | No | |
| VersionId | form | string | No | |
| BasedOn | form | string | No | |
| Created | form | string | No | |
| LastUpdated | form | string | No | |
| Date | form | string | No | |
| StartTime | form | string | No | |
| EndTime | form | string | No | |
| UserId | form | string | No | |
| Name | form | string | No | |
| Type | form | string | No | |
| Segments | form | List<RouteSegment> | No | |
| TotalTime | form | int | No | |
| TotalDistance | form | double | No | |
| Nodes | form | List<RouteNode> | No | |
RouteSegment Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Time | form | int | No | |
| Distance | form | double | No | |
| Start | form | string | No | |
| End | form | string | No | |
| Geometry | form | List<Location> | No | |
| DrivingDirections | form | List<string> | No | |
| EndNode | form | RouteNode | No | |
Location Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| y | form | double | No | |
| x | form | double | No | |
RouteNode Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Location | form | Location | No | |
| StopTime | form | int | No | |
| Schedule | form | Schedule | No | |
| Name | form | string | No | |
ClassedItem Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ObjectId | form | string | No | |
| Class | form | string | No | |
| VersionId | form | string | No | |
| Ancestors | form | List<string> | No | |
| Type | form | string | No | |
Schedule Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Workspace | form | string | No | |
| ObjectId | form | string | No | |
| VersionId | form | string | No | |
| BasedOn | form | string | No | |
| Start | form | string | No | |
| End | form | string | No | |
| TimeZone | form | string | No | |
| Users | form | List<string> | No | |
| Teams | form | List<string> | No | |
| Data | form | Dictionary<string, Object> | No | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
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: application/xml