Field Squared API Services

<back to all web services

PublicTeam

The following routes are available for this service:
GET/{Workspace}/API/Team/Schema
GET, PUT, POST, DELETE/{Workspace}/API/Team/{Id}
GET, PUT, POST, DELETE/{Workspace}/API/Team
PublicTeam Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
WorkspacepathstringNo
TeambodyTeamNo
TeamsbodyList<Team>No
Team Parameters:
NameParameterData TypeRequiredDescription
WorkspaceformstringNo
TimeZoneformstringNo
ObjectIdformstringNo
ExternalIdformstringNo
VersionIdformstringNo
BasedOnformstringNo
NameformstringNo
EnabledformboolNo
MembersformList<DomainItem>No
LeadformDomainItemNo
ParentformDomainItemNo
AddressformAddressNo
DataformDictionary<string, string>No
TeamsformList<string>No
EventsformList<EventItem>No
CreatedByformstringNo
ActiveLaborTypesformDictionary<string, Object>No
DomainItem Parameters:
NameParameterData TypeRequiredDescription
WorkspaceformstringNo
ObjectIdformstringNo
VersionIdformstringNo
LastUpdatedformstringNo
Address Parameters:
NameParameterData TypeRequiredDescription
StreetformstringNo
UnitformstringNo
CityformstringNo
StateformstringNo
ZipformstringNo
ContactTitleformstringNo
ContactNameformstringNo
ContactPhoneformstringNo
ContactEmailformstringNo
LocationformLocationNo
SiteNameformstringNo
GeocodeFailedformboolNo
CountryformstringNo
Location Parameters:
NameParameterData TypeRequiredDescription
yformdoubleNo
xformdoubleNo
EventItem Parameters:
NameParameterData TypeRequiredDescription
ObjectIdformstringNo
DateformstringNo
LocationformLocationNo
BarcodeformstringNo
DetailsformstringNo
TypeformstringNo
IsScanformboolNo
UserformstringNo
SelectedByformstringNo
StatusformstringNo
StatusTypeformstringNo
DateCreatedformstringNo
AutomaticformboolNo

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/Team/{Id} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: String,
	Workspace: String,
	Team: 
	{
		ExternalId: String,
		Name: String,
		Lat: 0,
		Lon: 0,
		StreetAddress: String,
		Unit: String,
		City: String,
		State: String,
		Zip: String,
		Country: String,
		Enabled: False,
		Members: 
		[
			String
		],
		Teams: 
		[
			String
		],
		LastUpdated: String,
		Created: String,
		Data: 
		{
			String: {}
		}
	},
	Teams: 
	[
		{
			ExternalId: String,
			Name: String,
			Lat: 0,
			Lon: 0,
			StreetAddress: String,
			Unit: String,
			City: String,
			State: String,
			Zip: String,
			Country: String,
			Enabled: False,
			Members: 
			[
				String
			],
			Teams: 
			[
				String
			],
			LastUpdated: String,
			Created: String,
			Data: 
			{
				String: {}
			}
		}
	]
}