Field Squared API Services

<back to all web services

InventoryTree

The following routes are available for this service:
GET/{Workspace}/InventoryTree
import Foundation
import ServiceStack

public class InventoryTree : Codable
{
    public var workspace:String
    public var includeInactive:Bool
    public var owningAsset:String
    public var owningTask:String

    required public init(){}
}

public class InventoryTreeResponse : Codable
{
    public var recordsAvailable:Int
    public var tree:[InventoryTreeNode] = []

    required public init(){}
}

public class InventoryTreeNode : Codable
{
    public var type:String
    public var descendantCount:Int

    required public init(){}
}


Swift InventoryTree DTOs

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.

GET /{Workspace}/InventoryTree HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InventoryTreeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Inventory">
  <RecordsAvailable>0</RecordsAvailable>
  <Tree>
    <InventoryTreeNode i:nil="true" />
  </Tree>
</InventoryTreeResponse>