Field Squared API Services

<back to all web 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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	RecordsAvailable: 0,
	Tree: 
	[
		{
			
		}
	]
}