Field Squared API Services

<back to all web services

InventoryTree

The following routes are available for this service:
GET/{Workspace}/InventoryTree
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.Inventory;

namespace Field2Office.API.Model.Inventory
{
    public partial class InventoryTree
    {
        public virtual string Workspace { get; set; }
        public virtual bool IncludeInactive { get; set; }
        public virtual string OwningAsset { get; set; }
        public virtual string OwningTask { get; set; }
    }

    public partial class InventoryTreeNode
    {
        public virtual string Type { get; set; }
        public virtual int DescendantCount { get; set; }
    }

    public partial class InventoryTreeResponse
    {
        public InventoryTreeResponse()
        {
            Tree = new List<InventoryTreeNode>{};
        }

        public virtual long RecordsAvailable { get; set; }
        public virtual List<InventoryTreeNode> Tree { get; set; }
    }

}

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