Field Squared API Services

<back to all web services

PublicTeam

The following routes are available for this service:
GET/{Workspace}/API/Team/Schema
GET, PUT, POST, DELETE/{Workspace}/API/Team/{Id}
GET, PUT, POST, DELETE/{Workspace}/API/Team
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.PublicApi.Teams;
using Field2Office.API.Model.Teams;
using Field2Office.API.Model;

namespace Field2Office.API.Model
{
    public partial class Address
    {
        public virtual string Street { get; set; }
        public virtual string Unit { get; set; }
        public virtual string City { get; set; }
        public virtual string State { get; set; }
        public virtual string Zip { get; set; }
        public virtual string ContactTitle { get; set; }
        public virtual string ContactName { get; set; }
        public virtual string ContactPhone { get; set; }
        public virtual string ContactEmail { get; set; }
        public virtual Location Location { get; set; }
        public virtual string SiteName { get; set; }
        public virtual bool GeocodeFailed { get; set; }
        public virtual string Country { get; set; }
    }

    public partial class DomainItem
    {
        public virtual string Workspace { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string VersionId { get; set; }
        public virtual string LastUpdated { get; set; }
    }

    public partial class EventItem
    {
        public virtual string ObjectId { get; set; }
        public virtual string Date { get; set; }
        public virtual Location Location { get; set; }
        public virtual string Barcode { get; set; }
        public virtual string Details { get; set; }
        public virtual string Type { get; set; }
        public virtual bool IsScan { get; set; }
        public virtual string User { get; set; }
        public virtual string SelectedBy { get; set; }
        public virtual string Status { get; set; }
        public virtual string StatusType { get; set; }
        public virtual string DateCreated { get; set; }
        public virtual bool Automatic { get; set; }
    }

    public partial class Location
    {
        public virtual double y { get; set; }
        public virtual double x { get; set; }
    }

}

namespace Field2Office.API.Model.PublicApi.Teams
{
    [DataContract]
    public partial class PublicTeam
    {
        public PublicTeam()
        {
            Teams = new List<Team>{};
        }

        [DataMember]
        public virtual string Id { get; set; }

        [DataMember]
        public virtual string Workspace { get; set; }

        [DataMember]
        public virtual Team Team { get; set; }

        [DataMember]
        public virtual List<Team> Teams { get; set; }
    }

}

namespace Field2Office.API.Model.Teams
{
    ///<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>
    public partial class Team
    {
        public Team()
        {
            Members = new List<DomainItem>{};
            Data = new Dictionary<string, string>{};
            Teams = new List<string>{};
            Events = new List<EventItem>{};
            ActiveLaborTypes = new Dictionary<string, Object>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string TimeZone { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string ExternalId { get; set; }
        public virtual string VersionId { get; set; }
        public virtual string BasedOn { get; set; }
        public virtual string Name { get; set; }
        public virtual bool Enabled { get; set; }
        public virtual List<DomainItem> Members { get; set; }
        public virtual DomainItem Lead { get; set; }
        public virtual DomainItem Parent { get; set; }
        public virtual Address Address { get; set; }
        public virtual Dictionary<string, string> Data { get; set; }
        public virtual List<string> Teams { get; set; }
        public virtual List<EventItem> Events { get; set; }
        public virtual string CreatedBy { get; set; }
        public virtual Dictionary<string, Object> ActiveLaborTypes { get; set; }
    }

}

C# PublicTeam DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

{"Id":"String","Workspace":"String","Team":{"ExternalId":"String","Name":"String","Lat":0,"Lon":0,"StreetAddress":"String","Unit":"String","City":"String","State":"String","Zip":"String","Country":"String","Enabled":false,"Members":["String"],"Teams":["String"],"LastUpdated":"String","Created":"String","Data":{"String":{}}},"Teams":[{"ExternalId":"String","Name":"String","Lat":0,"Lon":0,"StreetAddress":"String","Unit":"String","City":"String","State":"String","Zip":"String","Country":"String","Enabled":false,"Members":["String"],"Teams":["String"],"LastUpdated":"String","Created":"String","Data":{"String":{}}}]}