Field Squared API Services

<back to all web services

InventoryTree

The following routes are available for this service:
GET/{Workspace}/InventoryTree
import java.math.*
import java.util.*
import net.servicestack.client.*


open class InventoryTree
{
    var Workspace:String? = null
    var IncludeInactive:Boolean? = null
    var OwningAsset:String? = null
    var OwningTask:String? = null
}

open class InventoryTreeResponse
{
    var RecordsAvailable:Long? = null
    var Tree:ArrayList<InventoryTreeNode> = ArrayList<InventoryTreeNode>()
}

open class InventoryTreeNode
{
    var Type:String? = null
    var DescendantCount:Int? = null
}

Kotlin 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>