Field Squared API Services

ContactImport

Bulk import a set of contacts..

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

import Foundation
import ServiceStack

/**
* Bulk import a set of contacts..
*/
public class ContactImport : Codable
{
    public var workspace:String
    public var contacts:[Contact] = []
    public var requestId:String

    required public init(){}
}

/**
* 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
*/
public class Contact : Codable
{
    public var workspace:String
    public var objectId:String
    public var timeZone:String
    public var versionId:String
    public var basedOn:String
    public var externalId:String
    public var contactName:String
    public var company:String
    public var mobilePhone:String
    public var workPhone:String
    public var homePhone:String
    public var email:String
    public var sms:Bool
    public var address:Address
    public var enabled:Bool
    public var poi:Bool
    public var emailSiteDriving:Bool
    public var serviceAddresses:[Address] = []
    public var documents:[DomainItem] = []
    public var data:[String:String] = [:]
    public var owner:ClassedItem
    public var tasks:[String] = []
    public var assets:[String] = []
    public var contacts:[String] = []
    public var events:[EventItem] = []
    public var teams:[String] = []
    public var created:String
    public var lastUpdated:String
    public var createdBy:String
    public var activeLaborTypes:[String:Object] = [:]

    required public init(){}
}

public class Address : Codable
{
    public var street:String
    public var unit:String
    public var city:String
    public var state:String
    public var zip:String
    public var contactTitle:String
    public var contactName:String
    public var contactPhone:String
    public var contactEmail:String
    public var location:Location
    public var siteName:String
    public var geocodeFailed:Bool
    public var country:String

    required public init(){}
}

public class Location : Codable
{
    public var y:Double
    public var x:Double

    required public init(){}
}

public class DomainItem : Codable
{
    public var workspace:String
    public var objectId:String
    public var versionId:String
    public var lastUpdated:String

    required public init(){}
}

public class ClassedItem : Codable
{
    public var objectId:String
    public var `class`:String
    public var versionId:String
    public var ancestors:[String] = []
    public var type:String

    required public init(){}
}

public class EventItem : Codable
{
    public var objectId:String
    public var date:String
    public var location:Location
    public var barcode:String
    public var details:String
    public var type:String
    public var isScan:Bool
    public var user:String
    public var selectedBy:String
    public var status:String
    public var statusType:String
    public var dateCreated:String
    public var automatic:Bool

    required public init(){}
}

Swift ContactImport DTOs

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>