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}

namespace Field2Office.API.Model

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ClassedItem() = 
        member val ObjectId:String = null with get,set
        member val Class:String = null with get,set
        member val VersionId:String = null with get,set
        member val Ancestors:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Type:String = null with get,set

    [<AllowNullLiteral>]
    type Location() = 
        member val Latitude:Double = new Double() with get,set
        member val Longitude:Double = new Double() with get,set
        member val HasValidLocation:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type RangeExceptionItem() = 
        member val Binding:String = null with get,set
        member val Message:String = null with get,set
        member val Type:String = null with get,set
        member val ClassName:String = null with get,set

    [<AllowNullLiteral>]
    type DomainItem() = 
        member val Workspace:String = null with get,set
        member val ObjectId:String = null with get,set
        member val VersionId:String = null with get,set
        member val LastUpdated:String = null with get,set

    [<AllowNullLiteral>]
    type AddressBase() = 
        member val Id:String = null with get,set
        member val AddressLine1:String = null with get,set
        member val AddressLine2:String = null with get,set
        member val City:String = null with get,set
        member val State:String = null with get,set
        member val Zip:String = null with get,set
        member val Location:Location = null with get,set
        member val Name:String = null with get,set
        member val NameSingleLine:String = null with get,set
        member val NameSingleLine5DigitZip:String = null with get,set
        member val HasValidLocation:Boolean = new Boolean() with get,set
        member val GeocodeFailed:Boolean = new Boolean() with get,set
        member val GeocodeResultCode:String = null with get,set
        member val Country:String = null with get,set

    [<AllowNullLiteral>]
    type Address() = 
        inherit AddressBase()
        member val SiteName:String = null with get,set
        member val ContactTitle:String = null with get,set
        member val ContactName:String = null with get,set
        member val ContactPhone:String = null with get,set
        member val ContactEmail:String = null with get,set

    [<AllowNullLiteral>]
    type EventItem() = 
        member val ObjectId:String = null with get,set
        member val Date:String = null with get,set
        member val Location:Location = null with get,set
        member val Barcode:String = null with get,set
        member val Details:String = null with get,set
        member val Type:String = null with get,set
        member val IsScan:Boolean = new Boolean() with get,set
        member val User:String = null with get,set
        member val SelectedBy:String = null with get,set
        member val Status:String = null with get,set
        member val StatusType:String = null with get,set
        member val DateCreated:String = null with get,set
        member val Automatic:Boolean = new Boolean() with get,set

    ///<summary>
    ///Represents a DTO for a team in a workspace. Calls without an ObjectId will retrieve an array of all team objects for the workspace.
    ///</summary>
    [<AllowNullLiteral>]
    type Team() = 
        member val Workspace:String = null with get,set
        member val TimeZone:String = null with get,set
        member val ObjectId:String = null with get,set
        member val ExternalId:String = null with get,set
        member val VersionId:String = null with get,set
        member val BasedOn:String = null with get,set
        member val Name:String = null with get,set
        member val Enabled:Boolean = new Boolean() with get,set
        member val Members:ResizeArray<DomainItem> = new ResizeArray<DomainItem>() with get,set
        member val Lead:DomainItem = null with get,set
        member val Parent:DomainItem = null with get,set
        member val Address:Address = null with get,set
        member val Data:Dictionary<String, String> = new Dictionary<String, String>() with get,set
        member val Teams:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Events:ResizeArray<EventItem> = new ResizeArray<EventItem>() with get,set
        member val CreatedBy:String = null with get,set
        member val ActiveLaborTypes:Dictionary<String, Object> = new Dictionary<String, Object>() with get,set

    [<AllowNullLiteral>]
    type CustomDataField() = 
        member val Binding:String = null with get,set
        member val Label:String = null with get,set
        member val Value:Object = null with get,set
        member val DataType:String = null with get,set
        member val IsReadOnly:Boolean = new Boolean() with get,set
        member val IsHidden:Boolean = new Boolean() with get,set
        member val Values:String = null with get,set

    [<AllowNullLiteral>]
    type DocumentOwnerDataTask() = 
        member val ObjectId:String = null with get,set
        member val Name:String = null with get,set
        member val Status:String = null with get,set
        member val TaskType:String = null with get,set
        member val LastUpdated:DateTime = new DateTime() with get,set
        member val Created:DateTime = new DateTime() with get,set
        member val Priority:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Rank:Decimal = new Decimal() with get,set
        member val FirstTeam:Team = null with get,set
        member val Address:Address = null with get,set
        member val CustomDataFields:ResizeArray<CustomDataField> = new ResizeArray<CustomDataField>() with get,set

    [<AllowNullLiteral>]
    type AddressBasic() = 
        inherit AddressBase()

    [<AllowNullLiteral>]
    type DocumentOwnerDataAsset() = 
        member val ObjectId:String = null with get,set
        member val Name:String = null with get,set
        member val AssetType:String = null with get,set
        member val LastUpdated:DateTime = new DateTime() with get,set
        member val Created:DateTime = new DateTime() with get,set
        member val Address:AddressBasic = null with get,set
        member val CustomDataFields:ResizeArray<CustomDataField> = new ResizeArray<CustomDataField>() with get,set

    [<AllowNullLiteral>]
    type DocumentOwnerData() = 
        member val OwnerType:String = null with get,set
        member val TaskData:DocumentOwnerDataTask = null with get,set
        member val AssetData:DocumentOwnerDataAsset = null with get,set

    ///<summary>
    ///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. 
    ///</summary>
    [<AllowNullLiteral>]
    type Document() = 
        member val Workspace:String = null with get,set
        member val AssignedWorkspace:String = null with get,set
        member val ObjectId:String = null with get,set
        member val VersionId:String = null with get,set
        member val BasedOn:String = null with get,set
        member val Created:String = null with get,set
        member val ExternalId:String = null with get,set
        member val LastUpdated:String = null with get,set
        member val Type:String = null with get,set
        member val Name:String = null with get,set
        member val Title:String = null with get,set
        member val Data:Dictionary<String, Object> = new Dictionary<String, Object>() with get,set
        member val Owner:ClassedItem = null with get,set
        member val SecondaryOwners:ResizeArray<ClassedItem> = new ResizeArray<ClassedItem>() with get,set
        member val Location:Location = null with get,set
        member val Date:String = null with get,set
        member val CreatedBy:String = null with get,set
        member val PercentComplete:Double = new Double() with get,set
        member val PercentTotal:Int32 = new Int32() with get,set
        member val PercentDone:Int32 = new Int32() with get,set
        member val RangeExceptions:ResizeArray<RangeExceptionItem> = new ResizeArray<RangeExceptionItem>() with get,set
        member val Submitted:Boolean = new Boolean() with get,set
        member val Schema:String = null with get,set
        member val OwnerData:DocumentOwnerData = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type PublicDocument() = 
        [<DataMember>]
        member val Id:String = null with get,set

        [<DataMember>]
        member val Workspace:String = null with get,set

        [<DataMember>]
        member val DocumentType:String = null with get,set

        [<DataMember>]
        member val Document:Document = null with get,set

        [<DataMember>]
        member val Documents:ResizeArray<Document> = new ResizeArray<Document>() with get,set

    [<AllowNullLiteral>]
    type Location() = 
        member val y:Double = new Double() with get,set
        member val x:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type Address() = 
        member val Street:String = null with get,set
        member val Unit:String = null with get,set
        member val City:String = null with get,set
        member val State:String = null with get,set
        member val Zip:String = null with get,set
        member val ContactTitle:String = null with get,set
        member val ContactName:String = null with get,set
        member val ContactPhone:String = null with get,set
        member val ContactEmail:String = null with get,set
        member val Location:Location = null with get,set
        member val SiteName:String = null with get,set
        member val GeocodeFailed:Boolean = new Boolean() with get,set
        member val Country:String = null with get,set

F# 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>