<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 | | |
|---|
PublicTeam Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Id | path | string | No | |
| Workspace | path | string | No | |
| Team | body | Team | No | |
| Teams | body | List<Team> | No | |
Team Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Workspace | form | string | No | |
| TimeZone | form | string | No | |
| ObjectId | form | string | No | |
| ExternalId | form | string | No | |
| VersionId | form | string | No | |
| BasedOn | form | string | No | |
| Name | form | string | No | |
| Enabled | form | bool | No | |
| Members | form | List<DomainItem> | No | |
| Lead | form | DomainItem | No | |
| Parent | form | DomainItem | No | |
| Address | form | Address | No | |
| Data | form | Dictionary<string, string> | No | |
| Teams | form | List<string> | No | |
| Events | form | List<EventItem> | No | |
| CreatedBy | form | string | No | |
| ActiveLaborTypes | form | Dictionary<string, Object> | No | |
DomainItem Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Workspace | form | string | No | |
| ObjectId | form | string | No | |
| VersionId | form | string | No | |
| LastUpdated | form | string | No | |
Address Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Street | form | string | No | |
| Unit | form | string | No | |
| City | form | string | No | |
| State | form | string | No | |
| Zip | form | string | No | |
| ContactTitle | form | string | No | |
| ContactName | form | string | No | |
| ContactPhone | form | string | No | |
| ContactEmail | form | string | No | |
| Location | form | Location | No | |
| SiteName | form | string | No | |
| GeocodeFailed | form | bool | No | |
| Country | form | string | No | |
Location Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| y | form | double | No | |
| x | form | double | No | |
EventItem Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ObjectId | form | string | No | |
| Date | form | string | No | |
| Location | form | Location | No | |
| Barcode | form | string | No | |
| Details | form | string | No | |
| Type | form | string | No | |
| IsScan | form | bool | No | |
| User | form | string | No | |
| SelectedBy | form | string | No | |
| Status | form | string | No | |
| StatusType | form | string | No | |
| DateCreated | form | string | No | |
| Automatic | form | bool | No | |
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/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>