Field Squared API Services

<back to all web services

InventoryCategory

The following routes are available for this service:
GET,PUT,POST/{Workspace}/InventoryCategory
GET,PUT,POST/{Workspace}/InventoryCategory/{ObjectId}
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 InventoryCategory
            Inherits InventoryTreeNode
            Public Sub New()
                HideFor = New List(Of String)
                ShowFor = New List(Of String)
                ChildNodes = New List(Of InventoryTreeNode)
            End Sub

            Public Overridable Property Type As String
            Public Overridable Property ObjectId As String
            Public Overridable Property Workspace As String
            Public Overridable Property ItemCategory As String
            Public Overridable Property HideFor As List(Of String)
            Public Overridable Property ShowFor As List(Of String)
            Public Overridable Property ParentCategoryId As String
            Public Overridable Property Enabled As Nullable(Of Boolean)
            Public Overridable Property ChildNodes As List(Of InventoryTreeNode)
            Public Overridable Property IncludeInactive As Boolean
        End Class

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

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

POST /{Workspace}/InventoryCategory HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<InventoryCategory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Inventory">
  <DescendantCount>0</DescendantCount>
  <ChildNodes>
    <InventoryTreeNode i:nil="true" />
  </ChildNodes>
  <Enabled>false</Enabled>
  <HideFor xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </HideFor>
  <IncludeInactive>false</IncludeInactive>
  <ItemCategory>String</ItemCategory>
  <ObjectId>String</ObjectId>
  <ParentCategoryId>String</ParentCategoryId>
  <ShowFor xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ShowFor>
  <Workspace>String</Workspace>
</InventoryCategory>