Field Squared API Services

<back to all web services

PublicContact

import java.math.*
import java.util.*
import net.servicestack.client.*


@DataContract
open class PublicContact
{
    @DataMember
    var Id:String? = null

    @DataMember
    var Workspace:String? = null

    @DataMember
    var Contact:Contact? = null

    @DataMember
    var Contacts:ArrayList<Contact> = ArrayList<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
*/
open class Contact
{
    var Workspace:String? = null
    var ObjectId:String? = null
    var TimeZone:String? = null
    var VersionId:String? = null
    var BasedOn:String? = null
    var ExternalId:String? = null
    var ContactName:String? = null
    var Company:String? = null
    var MobilePhone:String? = null
    var WorkPhone:String? = null
    var HomePhone:String? = null
    var Email:String? = null
    var SMS:Boolean? = null
    var Address:Address? = null
    var Enabled:Boolean? = null
    var POI:Boolean? = null
    var EmailSiteDriving:Boolean? = null
    var ServiceAddresses:ArrayList<Address> = ArrayList<Address>()
    var Documents:ArrayList<DomainItem> = ArrayList<DomainItem>()
    var Data:HashMap<String,String> = HashMap<String,String>()
    var Owner:ClassedItem? = null
    var Tasks:ArrayList<String> = ArrayList<String>()
    var Assets:ArrayList<String> = ArrayList<String>()
    var Contacts:ArrayList<String> = ArrayList<String>()
    var Events:ArrayList<EventItem> = ArrayList<EventItem>()
    var Teams:ArrayList<String> = ArrayList<String>()
    var Created:String? = null
    var LastUpdated:String? = null
    var CreatedBy:String? = null
    var ActiveLaborTypes:HashMap<String,Object> = HashMap<String,Object>()
}

open class Address
{
    var Street:String? = null
    var Unit:String? = null
    var City:String? = null
    var State:String? = null
    var Zip:String? = null
    var ContactTitle:String? = null
    var ContactName:String? = null
    var ContactPhone:String? = null
    var ContactEmail:String? = null
    var Location:Location? = null
    var SiteName:String? = null
    var GeocodeFailed:Boolean? = null
    var Country:String? = null
}

open class Location
{
    var y:Double? = null
    var x:Double? = null
}

open class DomainItem
{
    var Workspace:String? = null
    var ObjectId:String? = null
    var VersionId:String? = null
    var LastUpdated:String? = null
}

open class ClassedItem
{
    var ObjectId:String? = null
    var Class:String? = null
    var VersionId:String? = null
    var Ancestors:ArrayList<String> = ArrayList<String>()
    var Type:String? = null
}

open class EventItem
{
    var ObjectId:String? = null
    var Date:String? = null
    var Location:Location? = null
    var Barcode:String? = null
    var Details:String? = null
    var Type:String? = null
    var IsScan:Boolean? = null
    var User:String? = null
    var SelectedBy:String? = null
    var Status:String? = null
    var StatusType:String? = null
    var DateCreated:String? = null
    var Automatic:Boolean? = null
}

Kotlin PublicContact DTOs

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

<PublicContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.PublicApi.Contacts">
  <Contact>
    <City>String</City>
    <Company>String</Company>
    <ContactName>String</ContactName>
    <Country>String</Country>
    <Created>String</Created>
    <Data xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
    </Data>
    <Email>String</Email>
    <Enabled>false</Enabled>
    <ExternalId>String</ExternalId>
    <HomePhone>String</HomePhone>
    <LastUpdated>String</LastUpdated>
    <Lat>0</Lat>
    <Lon>0</Lon>
    <MobilePhone>String</MobilePhone>
    <State>String</State>
    <StreetAddress>String</StreetAddress>
    <Tasks xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Tasks>
    <Team>String</Team>
    <Unit>String</Unit>
    <WorkPhone>String</WorkPhone>
    <Zip>String</Zip>
  </Contact>
  <Contacts>
    <Contact>
      <City>String</City>
      <Company>String</Company>
      <ContactName>String</ContactName>
      <Country>String</Country>
      <Created>String</Created>
      <Data xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </Data>
      <Email>String</Email>
      <Enabled>false</Enabled>
      <ExternalId>String</ExternalId>
      <HomePhone>String</HomePhone>
      <LastUpdated>String</LastUpdated>
      <Lat>0</Lat>
      <Lon>0</Lon>
      <MobilePhone>String</MobilePhone>
      <State>String</State>
      <StreetAddress>String</StreetAddress>
      <Tasks xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Tasks>
      <Team>String</Team>
      <Unit>String</Unit>
      <WorkPhone>String</WorkPhone>
      <Zip>String</Zip>
    </Contact>
  </Contacts>
  <Id>String</Id>
  <Workspace>String</Workspace>
</PublicContact>