Field Squared API Services

PublicDocument

The following routes are available for this service:
GET	/{Workspace}/API/Document/Schema
GET, PUT, POST, DELETE	/{Workspace}/API/Document/{Id}
GET, PUT, POST, DELETE	/{Workspace}/API/Document
GET	/{Workspace}/API/Document/Schema/{DocumentType}

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


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

    @DataMember
    var Workspace:String? = null

    @DataMember
    var DocumentType:String? = null

    @DataMember
    var Document:Document? = null

    @DataMember
    var Documents:ArrayList<Document> = ArrayList<Document>()
}

/**
* Represents a document associated with a task or user. To return multiple documents, call /{Workspace}/Document and pass in query parameter ids = comma separated list of document ids. 
*/
open class Document
{
    var Workspace:String? = null
    var AssignedWorkspace:String? = null
    var ObjectId:String? = null
    var VersionId:String? = null
    var BasedOn:String? = null
    var Created:String? = null
    var ExternalId:String? = null
    var LastUpdated:String? = null
    var Type:String? = null
    var Name:String? = null
    var Title:String? = null
    var Data:HashMap<String,Object> = HashMap<String,Object>()
    var Owner:ClassedItem? = null
    var SecondaryOwners:ArrayList<ClassedItem> = ArrayList<ClassedItem>()
    var Location:Location? = null
    var Date:String? = null
    var CreatedBy:String? = null
    var PercentComplete:Double? = null
    var PercentTotal:Int? = null
    var PercentDone:Int? = null
    var RangeExceptions:ArrayList<RangeExceptionItem> = ArrayList<RangeExceptionItem>()
    var Submitted:Boolean? = null
    var Schema:String? = null
    var OwnerData:DocumentOwnerData? = 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 Location
{
    var y:Double? = null
    var x:Double? = null
}

open class RangeExceptionItem
{
    var Binding:String? = null
    var Message:String? = null
    var Type:String? = null
    var ClassName:String? = null
}

open class DocumentOwnerData
{
    var OwnerType:String? = null
    var TaskData:DocumentOwnerDataTask? = null
    var AssetData:DocumentOwnerDataAsset? = null
}

open class DocumentOwnerDataTask
{
    var ObjectId:String? = null
    var Name:String? = null
    var Status:String? = null
    var TaskType:String? = null
    var LastUpdated:Date? = null
    var Created:Date? = null
    var Priority:Int? = null
    var Rank:BigDecimal? = null
    var FirstTeam:Team? = null
    var Address:Address? = null
    var CustomDataFields:ArrayList<CustomDataField> = ArrayList<CustomDataField>()
}

/**
* Represents a DTO for a team in a workspace. Calls without an ObjectId will retrieve an array of all team objects for the workspace.
*/
open class Team
{
    var Workspace:String? = null
    var TimeZone:String? = null
    var ObjectId:String? = null
    var ExternalId:String? = null
    var VersionId:String? = null
    var BasedOn:String? = null
    var Name:String? = null
    var Enabled:Boolean? = null
    var Members:ArrayList<DomainItem> = ArrayList<DomainItem>()
    var Lead:DomainItem? = null
    var Parent:DomainItem? = null
    var Address:Address? = null
    var Data:HashMap<String,String> = HashMap<String,String>()
    var Teams:ArrayList<String> = ArrayList<String>()
    var Events:ArrayList<EventItem> = ArrayList<EventItem>()
    var CreatedBy:String? = null
    var ActiveLaborTypes:HashMap<String,Object> = HashMap<String,Object>()
}

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

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

open class Address : AddressBase()
{
    var SiteName:String? = null
    var ContactTitle:String? = null
    var ContactName:String? = null
    var ContactPhone:String? = null
    var ContactEmail:String? = null
}

open class AddressBase
{
    var Id:String? = null
    var AddressLine1:String? = null
    var AddressLine2:String? = null
    var City:String? = null
    var State:String? = null
    var Zip:String? = null
    var Location:Location? = null
    var Name:String? = null
    var NameSingleLine:String? = null
    var NameSingleLine5DigitZip:String? = null
    var HasValidLocation:Boolean? = null
    var GeocodeFailed:Boolean? = null
    var GeocodeResultCode:String? = null
    var Country:String? = null
}

open class Location
{
    var Latitude:Double? = null
    var Longitude:Double? = null
    var HasValidLocation:Boolean? = null
}

open class CustomDataField
{
    var Binding:String? = null
    var Label:String? = null
    var Value:Object? = null
    var DataType:String? = null
    var IsReadOnly:Boolean? = null
    var IsHidden:Boolean? = null
    var Values:String? = null
}

open class DocumentOwnerDataAsset
{
    var ObjectId:String? = null
    var Name:String? = null
    var AssetType:String? = null
    var LastUpdated:Date? = null
    var Created:Date? = null
    var Address:AddressBasic? = null
    var CustomDataFields:ArrayList<CustomDataField> = ArrayList<CustomDataField>()
}

open class AddressBasic : AddressBase()
{
}

Kotlin PublicDocument 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}/API/Document/{Id} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PublicDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.PublicApi.Documents">
  <Document>
    <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>
    <Date>String</Date>
    <ExternalId>String</ExternalId>
    <LastUpdated>String</LastUpdated>
    <Lat>0</Lat>
    <Lon>0</Lon>
    <Name>String</Name>
    <OwnerClass>String</OwnerClass>
    <OwnerId>String</OwnerId>
    <PercentComplete>0</PercentComplete>
    <PercentDone>0</PercentDone>
    <PercentTotal>0</PercentTotal>
    <Type>String</Type>
  </Document>
  <DocumentType>String</DocumentType>
  <Documents>
    <Document>
      <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>
      <Date>String</Date>
      <ExternalId>String</ExternalId>
      <LastUpdated>String</LastUpdated>
      <Lat>0</Lat>
      <Lon>0</Lon>
      <Name>String</Name>
      <OwnerClass>String</OwnerClass>
      <OwnerId>String</OwnerId>
      <PercentComplete>0</PercentComplete>
      <PercentDone>0</PercentDone>
      <PercentTotal>0</PercentTotal>
      <Type>String</Type>
    </Document>
  </Documents>
  <Id>String</Id>
  <Workspace>String</Workspace>
</PublicDocument>