Field Squared API Services

InventoryTree

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

namespace Field2Office.API.Model.Inventory

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type InventoryTree() = 
        member val Workspace:String = null with get,set
        member val IncludeInactive:Boolean = new Boolean() with get,set
        member val OwningAsset:String = null with get,set
        member val OwningTask:String = null with get,set

    [<AllowNullLiteral>]
    type InventoryTreeNode() = 
        member val Type:String = null with get,set
        member val DescendantCount:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type InventoryTreeResponse() = 
        member val RecordsAvailable:Int64 = new Int64() with get,set
        member val Tree:ResizeArray<InventoryTreeNode> = new ResizeArray<InventoryTreeNode>() with get,set

F# 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>