Field Squared API Services

<back to all web services

PublicDocument

export class ClassedItem
{
    public ObjectId: string;
    public Class: string;
    public VersionId: string;
    public Ancestors: string[];
    public Type: string;

    public constructor(init?: Partial<ClassedItem>) { (Object as any).assign(this, init); }
}

export class Location
{
    public Latitude: number;
    public Longitude: number;
    public HasValidLocation: boolean;

    public constructor(init?: Partial<Location>) { (Object as any).assign(this, init); }
}

export class RangeExceptionItem
{
    public Binding: string;
    public Message: string;
    public Type: string;
    public ClassName: string;

    public constructor(init?: Partial<RangeExceptionItem>) { (Object as any).assign(this, init); }
}

export class DomainItem
{
    public Workspace: string;
    public ObjectId: string;
    public VersionId: string;
    public LastUpdated: string;

    public constructor(init?: Partial<DomainItem>) { (Object as any).assign(this, init); }
}

export class AddressBase
{
    public Id: string;
    public AddressLine1: string;
    public AddressLine2: string;
    public City: string;
    public State: string;
    public Zip: string;
    public Location: Location;
    public Name: string;
    public NameSingleLine: string;
    public NameSingleLine5DigitZip: string;
    public HasValidLocation: boolean;
    public GeocodeFailed: boolean;
    public GeocodeResultCode: string;
    public Country: string;

    public constructor(init?: Partial<AddressBase>) { (Object as any).assign(this, init); }
}

export class Address extends AddressBase
{
    public SiteName: string;
    public ContactTitle: string;
    public ContactName: string;
    public ContactPhone: string;
    public ContactEmail: string;

    public constructor(init?: Partial<Address>) { super(init); (Object as any).assign(this, init); }
}

export class EventItem
{
    public ObjectId: string;
    public Date: string;
    public Location: Location;
    public Barcode: string;
    public Details: string;
    public Type: string;
    public IsScan: boolean;
    public User: string;
    public SelectedBy: string;
    public Status: string;
    public StatusType: string;
    public DateCreated: string;
    public Automatic: boolean;

    public constructor(init?: Partial<EventItem>) { (Object as any).assign(this, init); }
}

/** @description Represents a DTO for a team in a workspace. Calls without an ObjectId will retrieve an array of all team objects for the workspace. */
export class Team
{
    public Workspace: string;
    public TimeZone: string;
    public ObjectId: string;
    public ExternalId: string;
    public VersionId: string;
    public BasedOn: string;
    public Name: string;
    public Enabled: boolean;
    public Members: DomainItem[];
    public Lead: DomainItem;
    public Parent: DomainItem;
    public Address: Address;
    public Data: { [index: string]: string; };
    public Teams: string[];
    public Events: EventItem[];
    public CreatedBy: string;
    public ActiveLaborTypes: { [index: string]: Object; };

    public constructor(init?: Partial<Team>) { (Object as any).assign(this, init); }
}

export class CustomDataField
{
    public Binding: string;
    public Label: string;
    public Value: Object;
    public DataType: string;
    public IsReadOnly: boolean;
    public IsHidden: boolean;
    public Values: string;

    public constructor(init?: Partial<CustomDataField>) { (Object as any).assign(this, init); }
}

export class DocumentOwnerDataTask
{
    public ObjectId: string;
    public Name: string;
    public Status: string;
    public TaskType: string;
    public LastUpdated: string;
    public Created: string;
    public Priority?: number;
    public Rank: number;
    public FirstTeam: Team;
    public Address: Address;
    public CustomDataFields: CustomDataField[];

    public constructor(init?: Partial<DocumentOwnerDataTask>) { (Object as any).assign(this, init); }
}

export class AddressBasic extends AddressBase
{

    public constructor(init?: Partial<AddressBasic>) { super(init); (Object as any).assign(this, init); }
}

export class DocumentOwnerDataAsset
{
    public ObjectId: string;
    public Name: string;
    public AssetType: string;
    public LastUpdated: string;
    public Created: string;
    public Address: AddressBasic;
    public CustomDataFields: CustomDataField[];

    public constructor(init?: Partial<DocumentOwnerDataAsset>) { (Object as any).assign(this, init); }
}

export class DocumentOwnerData
{
    public OwnerType: string;
    public TaskData: DocumentOwnerDataTask;
    public AssetData: DocumentOwnerDataAsset;

    public constructor(init?: Partial<DocumentOwnerData>) { (Object as any).assign(this, init); }
}

/** @description 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.  */
export class Document
{
    public Workspace: string;
    public AssignedWorkspace: string;
    public ObjectId: string;
    public VersionId: string;
    public BasedOn: string;
    public Created: string;
    public ExternalId: string;
    public LastUpdated: string;
    public Type: string;
    public Name: string;
    public Title: string;
    public Data: { [index: string]: Object; };
    public Owner: ClassedItem;
    public SecondaryOwners: ClassedItem[];
    public Location: Location;
    public Date: string;
    public CreatedBy: string;
    public PercentComplete: number;
    public PercentTotal: number;
    public PercentDone: number;
    public RangeExceptions: RangeExceptionItem[];
    public Submitted: boolean;
    public Schema: string;
    public OwnerData: DocumentOwnerData;

    public constructor(init?: Partial<Document>) { (Object as any).assign(this, init); }
}

// @DataContract
export class PublicDocument
{
    // @DataMember
    public Id: string;

    // @DataMember
    public Workspace: string;

    // @DataMember
    public DocumentType: string;

    // @DataMember
    public Document: Document;

    // @DataMember
    public Documents: Document[];

    public constructor(init?: Partial<PublicDocument>) { (Object as any).assign(this, init); }
}

export class Location
{
    public y: number;
    public x: number;

    public constructor(init?: Partial<Location>) { (Object as any).assign(this, init); }
}

export class Address
{
    public Street: string;
    public Unit: string;
    public City: string;
    public State: string;
    public Zip: string;
    public ContactTitle: string;
    public ContactName: string;
    public ContactPhone: string;
    public ContactEmail: string;
    public Location: Location;
    public SiteName: string;
    public GeocodeFailed: boolean;
    public Country: string;

    public constructor(init?: Partial<Address>) { (Object as any).assign(this, init); }
}

TypeScript PublicDocument DTOs

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>