Field Squared API Services

<back to all web services

Contact

Represents a DTO for a contact in a workspace. Calls without an ObjectId will retrieve an array of all active contact objects for the workspace.
A call to /{Workspace}/ContactTasks/{ObjectId} will return a List<DomainItem> for the list of tasks associated to the contact.
A core or custom sort field can be specified by using sort=fieldname&sortorder=ascending/descending.
To filter for contacts based on full text search, use fulltext
Custom contact field 'contains' filters can also be specified by using the binding/key as the query parameter. i.e. Comments=Quick Brown Fox.
To filter and return all contacts modified since a date and time, use the query parameter modifiedsince = X where X = YYYY-MM-DDTHH:MM:SSZ
To filter and return all contacts deleted since a date and time, use the query parameter deletedsince = X where X = YYYY-MM-DDTHH:MM:SSZ. Note only Object ID, Workspace and Version is populated.
Spatial extents can be passed in using: bottomleft=Lat,Lon&topright=Lat,Lon.
To filter on tasks inside a boundary, use boundary=Lat,Lon,Lat,Lon etc.
Pagination - /{0}/ContactList?recstart=0&reccount=1
/{Workspace}/ContactList/Count returns a count, not the actual object list

The following routes are available for this service:
GET,POST,PUT,DELETE/{Workspace}/Contact/{ObjectId}
GET/{Workspace}/Contact
GET/{Workspace}/ContactList
GET/{Workspace}/ContactList/Count
GET/{Workspace}/ContactTasks/{ObjectId}
Contact Parameters:
NameParameterData TypeRequiredDescription
WorkspacepathstringNo
ObjectIdpathstringNo
TimeZonebodystringNo
VersionIdbodystringNo
BasedOnbodystringNo
ExternalIdbodystringNo
ContactNamebodystringNo
CompanybodystringNo
MobilePhonebodystringNo
WorkPhonebodystringNo
HomePhonebodystringNo
EmailbodystringNo
SMSbodyboolNo
AddressbodyAddressNo
EnabledbodyboolNo
POIbodyboolNo
EmailSiteDrivingbodyboolNo
ServiceAddressesbodyList<Address>No
DocumentsbodyList<DomainItem>No
DatabodyDictionary<string, string>No
OwnerbodyClassedItemNo
TasksbodyList<string>No
AssetsbodyList<string>No
ContactsbodyList<string>No
EventsbodyList<EventItem>No
TeamsbodyList<string>No
CreatedbodystringNo
LastUpdatedbodystringNo
CreatedBybodystringNo
ActiveLaborTypesbodyDictionary<string, Object>No
Address Parameters:
NameParameterData TypeRequiredDescription
StreetformstringNo
UnitformstringNo
CityformstringNo
StateformstringNo
ZipformstringNo
ContactTitleformstringNo
ContactNameformstringNo
ContactPhoneformstringNo
ContactEmailformstringNo
LocationformLocationNo
SiteNameformstringNo
GeocodeFailedformboolNo
CountryformstringNo
Location Parameters:
NameParameterData TypeRequiredDescription
yformdoubleNo
xformdoubleNo
DomainItem Parameters:
NameParameterData TypeRequiredDescription
WorkspaceformstringNo
ObjectIdformstringNo
VersionIdformstringNo
LastUpdatedformstringNo
ClassedItem Parameters:
NameParameterData TypeRequiredDescription
ObjectIdformstringNo
ClassformstringNo
VersionIdformstringNo
AncestorsformList<string>No
TypeformstringNo
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /{Workspace}/Contact/{ObjectId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Workspace":"String","ObjectId":"String","TimeZone":"String","VersionId":"String","BasedOn":"String","ExternalId":"String","ContactName":"String","Company":"String","MobilePhone":"String","WorkPhone":"String","HomePhone":"String","Email":"String","SMS":false,"Address":{"Street":"String","Unit":"String","City":"String","State":"String","Zip":"String","ContactTitle":"String","ContactName":"String","ContactPhone":"String","ContactEmail":"String","Location":{"y":0,"x":0},"SiteName":"String","GeocodeFailed":false,"Country":"String"},"Enabled":false,"POI":false,"EmailSiteDriving":false,"ServiceAddresses":[{"Street":"String","Unit":"String","City":"String","State":"String","Zip":"String","ContactTitle":"String","ContactName":"String","ContactPhone":"String","ContactEmail":"String","Location":{"y":0,"x":0},"SiteName":"String","GeocodeFailed":false,"Country":"String"}],"Documents":[{"Workspace":"String","ObjectId":"String","VersionId":"String","LastUpdated":"String"}],"Data":{"String":"String"},"Owner":{"ObjectId":"String","Class":"String","VersionId":"String","Ancestors":["String"],"Type":"String"},"Tasks":["String"],"Assets":["String"],"Contacts":["String"],"Events":[{"ObjectId":"String","Date":"String","Location":{"y":0,"x":0},"Barcode":"String","Details":"String","Type":"String","IsScan":false,"User":"String","SelectedBy":"String","Status":"String","StatusType":"String","DateCreated":"String","Automatic":false}],"Teams":["String"],"Created":"String","LastUpdated":"String","CreatedBy":"String","ActiveLaborTypes":{"String":{}}}