Field Squared API Services

<back to all web services

InventoryTree

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

Namespace Global

    Namespace Field2Office.API.Model.Inventory

        Public Partial Class InventoryTree
            Public Overridable Property Workspace As String
            Public Overridable Property IncludeInactive As Boolean
            Public Overridable Property OwningAsset As String
            Public Overridable Property OwningTask As String
        End Class

        Public Partial Class InventoryTreeNode
            Public Overridable Property Type As String
            Public Overridable Property DescendantCount As Integer
        End Class

        Public Partial Class InventoryTreeResponse
            Public Sub New()
                Tree = New List(Of InventoryTreeNode)
            End Sub

            Public Overridable Property RecordsAvailable As Long
            Public Overridable Property Tree As List(Of InventoryTreeNode)
        End Class
    End Namespace
End Namespace

VB.NET 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>