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}
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 InventoryTreeNode() = 
        member val Type:String = null with get,set
        member val DescendantCount:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type InventoryCategory() = 
        inherit InventoryTreeNode()
        member val Type:String = null with get,set
        member val ObjectId:String = null with get,set
        member val Workspace:String = null with get,set
        member val ItemCategory:String = null with get,set
        member val HideFor:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val ShowFor:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val ParentCategoryId:String = null with get,set
        member val Enabled:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val ChildNodes:ResizeArray<InventoryTreeNode> = new ResizeArray<InventoryTreeNode>() with get,set
        member val IncludeInactive:Boolean = new Boolean() with get,set

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