Field Squared API Services

ContactImport

Bulk import a set of contacts..

The following routes are available for this service:
POST	/{Workspace}/ContactImport

**ContactImport** Parameters:
Name	Parameter	Data Type	Required
Workspace	path	string	No
Contacts	body	List<Contact>	No
RequestId	body	string	No

**Contact** Parameters:
Name	Parameter	Data Type	Required
Workspace	form	string	No
ObjectId	form	string	No
TimeZone	form	string	No
VersionId	form	string	No
BasedOn	form	string	No
ExternalId	form	string	No
ContactName	form	string	No
Company	form	string	No
MobilePhone	form	string	No
WorkPhone	form	string	No
HomePhone	form	string	No
Email	form	string	No
SMS	form	bool	No
Address	form	Address	No
Enabled	form	bool	No
POI	form	bool	No
EmailSiteDriving	form	bool	No
ServiceAddresses	form	List<Address>	No
Documents	form	List<DomainItem>	No
Data	form	Dictionary<string, string>	No
Owner	form	ClassedItem	No
Tasks	form	List<string>	No
Assets	form	List<string>	No
Contacts	form	List<string>	No
Events	form	List<EventItem>	No
Teams	form	List<string>	No
Created	form	string	No
LastUpdated	form	string	No
CreatedBy	form	string	No
ActiveLaborTypes	form	Dictionary<string, Object>	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

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

**DomainItem** Parameters:
Name	Parameter	Data Type	Required
Workspace	form	string	No
ObjectId	form	string	No
VersionId	form	string	No
LastUpdated	form	string	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

**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

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<ContactImport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Contacts">
  <Contacts>
    <Contact>
      <ActiveLaborTypes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </ActiveLaborTypes>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
        <d4p1:City>String</d4p1:City>
        <d4p1:ContactEmail>String</d4p1:ContactEmail>
        <d4p1:ContactName>String</d4p1:ContactName>
        <d4p1:ContactPhone>String</d4p1:ContactPhone>
        <d4p1:ContactTitle>String</d4p1:ContactTitle>
        <d4p1:Country>String</d4p1:Country>
        <d4p1:GeocodeFailed>false</d4p1:GeocodeFailed>
        <d4p1:Location>
          <d4p1:x>0</d4p1:x>
          <d4p1:y>0</d4p1:y>
        </d4p1:Location>
        <d4p1:SiteName>String</d4p1:SiteName>
        <d4p1:State>String</d4p1:State>
        <d4p1:Street>String</d4p1:Street>
        <d4p1:Unit>String</d4p1:Unit>
        <d4p1:Zip>String</d4p1:Zip>
      </Address>
      <Assets xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Assets>
      <BasedOn>String</BasedOn>
      <Company>String</Company>
      <ContactName>String</ContactName>
      <Contacts xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Contacts>
      <Created>String</Created>
      <CreatedBy>String</CreatedBy>
      <Data xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Data>
      <Documents xmlns:d4p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
        <d4p1:DomainItem>
          <d4p1:LastUpdated>String</d4p1:LastUpdated>
          <d4p1:ObjectId>String</d4p1:ObjectId>
          <d4p1:VersionId>String</d4p1:VersionId>
          <d4p1:Workspace>String</d4p1:Workspace>
        </d4p1:DomainItem>
      </Documents>
      <Email>String</Email>
      <EmailSiteDriving>false</EmailSiteDriving>
      <Enabled>false</Enabled>
      <Events xmlns:d4p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
        <d4p1:EventItem>
          <d4p1:Automatic>false</d4p1:Automatic>
          <d4p1:Barcode>String</d4p1:Barcode>
          <d4p1:Date>String</d4p1:Date>
          <d4p1:DateCreated>String</d4p1:DateCreated>
          <d4p1:Details>String</d4p1:Details>
          <d4p1:IsScan>false</d4p1:IsScan>
          <d4p1:Location>
            <d4p1:x>0</d4p1:x>
            <d4p1:y>0</d4p1:y>
          </d4p1:Location>
          <d4p1:ObjectId>String</d4p1:ObjectId>
          <d4p1:SelectedBy>String</d4p1:SelectedBy>
          <d4p1:Status>String</d4p1:Status>
          <d4p1:StatusType>String</d4p1:StatusType>
          <d4p1:Type>String</d4p1:Type>
          <d4p1:User>String</d4p1:User>
        </d4p1:EventItem>
      </Events>
      <ExternalId>String</ExternalId>
      <HomePhone>String</HomePhone>
      <LastUpdated>String</LastUpdated>
      <MobilePhone>String</MobilePhone>
      <ObjectId>String</ObjectId>
      <Owner xmlns:d4p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
        <d4p1:Ancestors xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </d4p1:Ancestors>
        <d4p1:Class>String</d4p1:Class>
        <d4p1:ObjectId>String</d4p1:ObjectId>
        <d4p1:Type>String</d4p1:Type>
        <d4p1:VersionId>String</d4p1:VersionId>
      </Owner>
      <POI>false</POI>
      <SMS>false</SMS>
      <ServiceAddresses xmlns:d4p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
        <d4p1:Address>
          <d4p1:City>String</d4p1:City>
          <d4p1:ContactEmail>String</d4p1:ContactEmail>
          <d4p1:ContactName>String</d4p1:ContactName>
          <d4p1:ContactPhone>String</d4p1:ContactPhone>
          <d4p1:ContactTitle>String</d4p1:ContactTitle>
          <d4p1:Country>String</d4p1:Country>
          <d4p1:GeocodeFailed>false</d4p1:GeocodeFailed>
          <d4p1:Location>
            <d4p1:x>0</d4p1:x>
            <d4p1:y>0</d4p1:y>
          </d4p1:Location>
          <d4p1:SiteName>String</d4p1:SiteName>
          <d4p1:State>String</d4p1:State>
          <d4p1:Street>String</d4p1:Street>
          <d4p1:Unit>String</d4p1:Unit>
          <d4p1:Zip>String</d4p1:Zip>
        </d4p1:Address>
      </ServiceAddresses>
      <Tasks xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Tasks>
      <Teams xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Teams>
      <TimeZone>String</TimeZone>
      <VersionId>String</VersionId>
      <WorkPhone>String</WorkPhone>
      <Workspace>String</Workspace>
    </Contact>
  </Contacts>
  <RequestId>String</RequestId>
  <Workspace>String</Workspace>
</ContactImport>