Field Squared API Services

PublicDocument

The following routes are available for this service:
GET	/{Workspace}/API/Document/Schema
GET, PUT, POST, DELETE	/{Workspace}/API/Document/{Id}
GET, PUT, POST, DELETE	/{Workspace}/API/Document
GET	/{Workspace}/API/Document/Schema/{DocumentType}

**PublicDocument** Parameters:
Name	Parameter	Data Type	Required
Id	path	string	No
Workspace	path	string	No
DocumentType	path	string	No
Document	body	Document	No
Documents	body	List<Document>	No

**Document** Parameters:
Name	Parameter	Data Type	Required
Workspace	form	string	No
AssignedWorkspace	form	string	No
ObjectId	form	string	No
VersionId	form	string	No
BasedOn	form	string	No
Created	form	string	No
ExternalId	form	string	No
LastUpdated	form	string	No
Type	form	string	No
Name	form	string	No
Title	form	string	No
Data	form	Dictionary<string, Object>	No
Owner	form	ClassedItem	No
SecondaryOwners	form	List<ClassedItem>	No
Location	form	Location	No
Date	form	string	No
CreatedBy	form	string	No
PercentComplete	form	double	No
PercentTotal	form	int	No
PercentDone	form	int	No
RangeExceptions	form	List<RangeExceptionItem>	No
Submitted	form	bool	No
Schema	form	string	No
OwnerData	form	DocumentOwnerData	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

**Location** Parameters:
Name	Parameter	Data Type	Required	Description
y	form	double	No
x	form	double	No

**RangeExceptionItem** Parameters:
Name	Parameter	Data Type	Required
Binding	form	string	No
Message	form	string	No
Type	form	string	No
ClassName	form	string	No

**DocumentOwnerData** Parameters:
Name	Parameter	Data Type	Required
OwnerType	form	string	No
TaskData	form	DocumentOwnerDataTask	No
AssetData	form	DocumentOwnerDataAsset	No

**DocumentOwnerDataTask** Parameters:
Name	Parameter	Data Type	Required
ObjectId	form	string	No
Name	form	string	No
Status	form	string	No
TaskType	form	string	No
LastUpdated	form	DateTime	No
Created	form	DateTime	No
Priority	form	int?	No
Rank	form	decimal	No
FirstTeam	form	Team	No
Address	form	Address	No
CustomDataFields	form	List<CustomDataField>	No

**Team** Parameters:
Name	Parameter	Data Type	Required
Workspace	form	string	No
TimeZone	form	string	No
ObjectId	form	string	No
ExternalId	form	string	No
VersionId	form	string	No
BasedOn	form	string	No
Name	form	string	No
Enabled	form	bool	No
Members	form	List<DomainItem>	No
Lead	form	DomainItem	No
Parent	form	DomainItem	No
Address	form	Address	No
Data	form	Dictionary<string, string>	No
Teams	form	List<string>	No
Events	form	List<EventItem>	No
CreatedBy	form	string	No
ActiveLaborTypes	form	Dictionary<string, Object>	No

**DomainItem** Parameters:
Name	Parameter	Data Type	Required
Workspace	form	string	No
ObjectId	form	string	No
VersionId	form	string	No
LastUpdated	form	string	No

**Address** Parameters:
Name	Parameter	Data Type	Required
Street	form	string	No
Unit	form	string	No
City	form	string	No
State	form	string	No
Zip	form	string	No
ContactTitle	form	string	No
ContactName	form	string	No
ContactPhone	form	string	No
ContactEmail	form	string	No
Location	form	Location	No
SiteName	form	string	No
GeocodeFailed	form	bool	No
Country	form	string	No

**EventItem** Parameters:
Name	Parameter	Data Type	Required
ObjectId	form	string	No
Date	form	string	No
Location	form	Location	No
Barcode	form	string	No
Details	form	string	No
Type	form	string	No
IsScan	form	bool	No
User	form	string	No
SelectedBy	form	string	No
Status	form	string	No
StatusType	form	string	No
DateCreated	form	string	No
Automatic	form	bool	No

**Address** Parameters:
Name	Parameter	Data Type	Required
SiteName	form	string	No
ContactTitle	form	string	No
ContactName	form	string	No
ContactPhone	form	string	No
ContactEmail	form	string	No

**AddressBase** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
AddressLine1	form	string	No
AddressLine2	form	string	No
City	form	string	No
State	form	string	No
Zip	form	string	No
Location	form	Location	No
Name	form	string	No
NameSingleLine	form	string	No
NameSingleLine5DigitZip	form	string	No
HasValidLocation	form	bool	No
GeocodeFailed	form	bool	No
GeocodeResultCode	form	string	No
Country	form	string	No

**Location** Parameters:
Name	Parameter	Data Type	Required
Latitude	form	double	No
Longitude	form	double	No
HasValidLocation	form	bool	No

**CustomDataField** Parameters:
Name	Parameter	Data Type	Required
Binding	form	string	No
Label	form	string	No
Value	form	Object	No
DataType	form	string	No
IsReadOnly	form	bool	No
IsHidden	form	bool	No
Values	form	string	No

**DocumentOwnerDataAsset** Parameters:
Name	Parameter	Data Type	Required
ObjectId	form	string	No
Name	form	string	No
AssetType	form	string	No
LastUpdated	form	DateTime	No
Created	form	DateTime	No
Address	form	AddressBasic	No
CustomDataFields	form	List<CustomDataField>	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}/API/Document/{Id} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: String,
	Workspace: String,
	DocumentType: String,
	Document: 
	{
		Name: String,
		ExternalId: String,
		Type: String,
		OwnerId: String,
		OwnerClass: String,
		Lat: 0,
		Lon: 0,
		LastUpdated: String,
		Created: String,
		Date: String,
		PercentComplete: 0,
		PercentTotal: 0,
		PercentDone: 0,
		Data: 
		{
			String: {}
		}
	},
	Documents: 
	[
		{
			Name: String,
			ExternalId: String,
			Type: String,
			OwnerId: String,
			OwnerClass: String,
			Lat: 0,
			Lon: 0,
			LastUpdated: String,
			Created: String,
			Date: String,
			PercentComplete: 0,
			PercentTotal: 0,
			PercentDone: 0,
			Data: 
			{
				String: {}
			}
		}
	]
}