| GET | /{Workspace}/API/Team/Schema | ||
|---|---|---|---|
| GET, PUT, POST, DELETE | /{Workspace}/API/Team/{Id} | ||
| GET, PUT, POST, DELETE | /{Workspace}/API/Team |
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 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); }
}
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); }
}
// @DataContract
export class PublicTeam
{
// @DataMember
public Id: string;
// @DataMember
public Workspace: string;
// @DataMember
public Team: Team;
// @DataMember
public Teams: Team[];
public constructor(init?: Partial<PublicTeam>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv
Content-Type: text/csv
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":{}}}]}