Field Squared API Services

<back to all web services

ContactImport

Bulk import a set of contacts..

The following routes are available for this service:
POST/{Workspace}/ContactImport
ContactImport Parameters:
NameParameterData TypeRequiredDescription
WorkspacepathstringNo
ContactsbodyList<Contact>No
RequestIdbodystringNo
Contact Parameters:
NameParameterData TypeRequiredDescription
WorkspaceformstringNo
ObjectIdformstringNo
TimeZoneformstringNo
VersionIdformstringNo
BasedOnformstringNo
ExternalIdformstringNo
ContactNameformstringNo
CompanyformstringNo
MobilePhoneformstringNo
WorkPhoneformstringNo
HomePhoneformstringNo
EmailformstringNo
SMSformboolNo
AddressformAddressNo
EnabledformboolNo
POIformboolNo
EmailSiteDrivingformboolNo
ServiceAddressesformList<Address>No
DocumentsformList<DomainItem>No
DataformDictionary<string, string>No
OwnerformClassedItemNo
TasksformList<string>No
AssetsformList<string>No
ContactsformList<string>No
EventsformList<EventItem>No
TeamsformList<string>No
CreatedformstringNo
LastUpdatedformstringNo
CreatedByformstringNo
ActiveLaborTypesformDictionary<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}/ContactImport HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Workspace":"String","Contacts":[{"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":{}}}],"RequestId":"String"}