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
import java.math.*
import java.util.*
import net.servicestack.client.*


@DataContract
open class PublicTeam
{
    @DataMember
    var Id:String? = null

    @DataMember
    var Workspace:String? = null

    @DataMember
    var Team:Team? = null

    @DataMember
    var Teams:ArrayList<Team> = ArrayList<Team>()
}

/**
* Represents a DTO for a team in a workspace. Calls without an ObjectId will retrieve an array of all team objects for the workspace.
*/
open class Team
{
    var Workspace:String? = null
    var TimeZone:String? = null
    var ObjectId:String? = null
    var ExternalId:String? = null
    var VersionId:String? = null
    var BasedOn:String? = null
    var Name:String? = null
    var Enabled:Boolean? = null
    var Members:ArrayList<DomainItem> = ArrayList<DomainItem>()
    var Lead:DomainItem? = null
    var Parent:DomainItem? = null
    var Address:Address? = null
    var Data:HashMap<String,String> = HashMap<String,String>()
    var Teams:ArrayList<String> = ArrayList<String>()
    var Events:ArrayList<EventItem> = ArrayList<EventItem>()
    var CreatedBy:String? = null
    var ActiveLaborTypes:HashMap<String,Object> = HashMap<String,Object>()
}

open class DomainItem
{
    var Workspace:String? = null
    var ObjectId:String? = null
    var VersionId:String? = null
    var LastUpdated:String? = null
}

open class Address
{
    var Street:String? = null
    var Unit:String? = null
    var City:String? = null
    var State:String? = null
    var Zip:String? = null
    var ContactTitle:String? = null
    var ContactName:String? = null
    var ContactPhone:String? = null
    var ContactEmail:String? = null
    var Location:Location? = null
    var SiteName:String? = null
    var GeocodeFailed:Boolean? = null
    var Country:String? = null
}

open class Location
{
    var y:Double? = null
    var x:Double? = null
}

open class EventItem
{
    var ObjectId:String? = null
    var Date:String? = null
    var Location:Location? = null
    var Barcode:String? = null
    var Details:String? = null
    var Type:String? = null
    var IsScan:Boolean? = null
    var User:String? = null
    var SelectedBy:String? = null
    var Status:String? = null
    var StatusType:String? = null
    var DateCreated:String? = null
    var Automatic:Boolean? = null
}

Kotlin PublicTeam DTOs

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: {}
			}
		}
	]
}