| GET | /{Workspace}/API/Team/Schema | ||
|---|---|---|---|
| GET, PUT, POST, DELETE | /{Workspace}/API/Team/{Id} | ||
| GET, PUT, POST, DELETE | /{Workspace}/API/Team |
import Foundation
import ServiceStack
// @DataContract
public class PublicTeam : Codable
{
// @DataMember
public var id:String
// @DataMember
public var workspace:String
// @DataMember
public var team:Team
// @DataMember
public var teams:[Team] = []
required public init(){}
}
/**
* Represents a DTO for a team in a workspace. Calls without an ObjectId will retrieve an array of all team objects for the workspace.
*/
public class Team : Codable
{
public var workspace:String
public var timeZone:String
public var objectId:String
public var externalId:String
public var versionId:String
public var basedOn:String
public var name:String
public var enabled:Bool
public var members:[DomainItem] = []
public var lead:DomainItem
public var parent:DomainItem
public var address:Address
public var data:[String:String] = [:]
public var teams:[String] = []
public var events:[EventItem] = []
public var createdBy:String
public var activeLaborTypes:[String:Object] = [:]
required public init(){}
}
public class DomainItem : Codable
{
public var workspace:String
public var objectId:String
public var versionId:String
public var lastUpdated:String
required public init(){}
}
public class Address : Codable
{
public var street:String
public var unit:String
public var city:String
public var state:String
public var zip:String
public var contactTitle:String
public var contactName:String
public var contactPhone:String
public var contactEmail:String
public var location:Location
public var siteName:String
public var geocodeFailed:Bool
public var country:String
required public init(){}
}
public class Location : Codable
{
public var y:Double
public var x:Double
required public init(){}
}
public class EventItem : Codable
{
public var objectId:String
public var date:String
public var location:Location
public var barcode:String
public var details:String
public var type:String
public var isScan:Bool
public var user:String
public var selectedBy:String
public var status:String
public var statusType:String
public var dateCreated:String
public var automatic:Bool
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<PublicTeam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.PublicApi.Teams">
<Id>String</Id>
<Team>
<City>String</City>
<Country>String</Country>
<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>
<Enabled>false</Enabled>
<ExternalId>String</ExternalId>
<LastUpdated>String</LastUpdated>
<Lat>0</Lat>
<Lon>0</Lon>
<Members xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</Members>
<Name>String</Name>
<State>String</State>
<StreetAddress>String</StreetAddress>
<Teams xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</Teams>
<Unit>String</Unit>
<Zip>String</Zip>
</Team>
<Teams>
<Team>
<City>String</City>
<Country>String</Country>
<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>
<Enabled>false</Enabled>
<ExternalId>String</ExternalId>
<LastUpdated>String</LastUpdated>
<Lat>0</Lat>
<Lon>0</Lon>
<Members xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</Members>
<Name>String</Name>
<State>String</State>
<StreetAddress>String</StreetAddress>
<Teams xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</Teams>
<Unit>String</Unit>
<Zip>String</Zip>
</Team>
</Teams>
<Workspace>String</Workspace>
</PublicTeam>