Field Squared API Services

ContactImport

Bulk import a set of contacts..

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Location:
    y: float = 0.0
    x: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Address:
    street: Optional[str] = None
    unit: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    zip: Optional[str] = None
    contact_title: Optional[str] = None
    contact_name: Optional[str] = None
    contact_phone: Optional[str] = None
    contact_email: Optional[str] = None
    location: Optional[Location] = None
    site_name: Optional[str] = None
    geocode_failed: bool = False
    country: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DomainItem:
    workspace: Optional[str] = None
    object_id: Optional[str] = None
    version_id: Optional[str] = None
    last_updated: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ClassedItem:
    object_id: Optional[str] = None
    class_: Optional[str] = field(metadata=config(field_name='class'), default=None)
    version_id: Optional[str] = None
    ancestors: Optional[List[str]] = None
    type: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EventItem:
    object_id: Optional[str] = None
    date: Optional[str] = None
    location: Optional[Location] = None
    barcode: Optional[str] = None
    details: Optional[str] = None
    type: Optional[str] = None
    is_scan: bool = False
    user: Optional[str] = None
    selected_by: Optional[str] = None
    status: Optional[str] = None
    status_type: Optional[str] = None
    date_created: Optional[str] = None
    automatic: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class 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
    """

    workspace: Optional[str] = None
    object_id: Optional[str] = None
    time_zone: Optional[str] = None
    version_id: Optional[str] = None
    based_on: Optional[str] = None
    external_id: Optional[str] = None
    contact_name: Optional[str] = None
    company: Optional[str] = None
    mobile_phone: Optional[str] = None
    work_phone: Optional[str] = None
    home_phone: Optional[str] = None
    email: Optional[str] = None
    sms: bool = False
    address: Optional[Address] = None
    enabled: bool = False
    poi: bool = False
    email_site_driving: bool = False
    service_addresses: Optional[List[Address]] = None
    documents: Optional[List[DomainItem]] = None
    data: Optional[Dict[str, str]] = None
    owner: Optional[ClassedItem] = None
    tasks: Optional[List[str]] = None
    assets: Optional[List[str]] = None
    contacts: Optional[List[str]] = None
    events: Optional[List[EventItem]] = None
    teams: Optional[List[str]] = None
    created: Optional[str] = None
    last_updated: Optional[str] = None
    created_by: Optional[str] = None
    active_labor_types: Optional[Dict[str, Object]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactImport:
    """
    Bulk import a set of contacts..
    """

    workspace: Optional[str] = None
    contacts: Optional[List[Contact]] = None
    request_id: Optional[str] = None

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