Field Squared API Services

Route

Contains the data for a route within the system.

The following routes are available for this service:
GET,POST,DELETE	/{Workspace}/Route/{ObjectId}
GET	/{Workspace}/Route/{UserId}/{Date}

**Route** Parameters:
Name	Parameter	Data Type	Required
Workspace	path	string	No
AssignedWorkspace	body	string	No
ObjectId	path	string	No
VersionId	body	string	No
BasedOn	body	string	No
Created	body	string	No
LastUpdated	body	string	No
Date	path	string	No
StartTime	body	string	No
EndTime	body	string	No
UserId	path	string	No
Name	body	string	No
Type	body	string	No
Segments	body	List<RouteSegment>	No
TotalTime	body	int	No
TotalDistance	body	double	No
Nodes	body	List<RouteNode>	No

**RouteSegment** Parameters:
Name	Parameter	Data Type	Required
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
Location	form	Location	No
StopTime	form	int	No
Schedule	form	Schedule	No
Name	form	string	No

**ClassedItem** Parameters:
Name	Parameter	Data Type	Required
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
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 .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /{Workspace}/Route/{ObjectId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Workspace: String,
	AssignedWorkspace: String,
	ObjectId: String,
	VersionId: String,
	BasedOn: String,
	Created: String,
	LastUpdated: String,
	Date: String,
	StartTime: String,
	EndTime: String,
	UserId: String,
	Name: String,
	Type: String,
	Segments: 
	[
		{
			Time: 0,
			Distance: 0,
			Start: String,
			End: String,
			Geometry: 
			[
				{
					y: 0,
					x: 0
				}
			],
			DrivingDirections: 
			[
				String
			],
			EndNode: 
			{
				Location: 
				{
					y: 0,
					x: 0
				},
				StopTime: 0,
				Schedule: 
				{
					Workspace: String,
					ObjectId: String,
					VersionId: String,
					BasedOn: String,
					Start: String,
					End: String,
					TimeZone: String,
					Users: 
					[
						String
					],
					Teams: 
					[
						String
					],
					Data: 
					{
						String: {}
					}
				},
				Name: String,
				ObjectId: String,
				Class: String,
				VersionId: String,
				Ancestors: 
				[
					String
				],
				Type: String
			}
		}
	],
	TotalTime: 0,
	TotalDistance: 0,
	Nodes: 
	[
		{
			Location: 
			{
				y: 0,
				x: 0
			},
			StopTime: 0,
			Schedule: 
			{
				Workspace: String,
				ObjectId: String,
				VersionId: String,
				BasedOn: String,
				Start: String,
				End: String,
				TimeZone: String,
				Users: 
				[
					String
				],
				Teams: 
				[
					String
				],
				Data: 
				{
					String: {}
				}
			},
			Name: String,
			ObjectId: String,
			Class: String,
			VersionId: String,
			Ancestors: 
			[
				String
			],
			Type: String
		}
	]
}