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}

export class InventoryTreeNode
{
    public Type: string;
    public DescendantCount: number;

    public constructor(init?: Partial<InventoryTreeNode>) { (Object as any).assign(this, init); }
}

export class InventoryCategory extends InventoryTreeNode
{
    public Type: string;
    public ObjectId: string;
    public Workspace: string;
    public ItemCategory: string;
    public HideFor: string[];
    public ShowFor: string[];
    public ParentCategoryId: string;
    public Enabled?: boolean;
    public ChildNodes: InventoryTreeNode[];
    public IncludeInactive: boolean;

    public constructor(init?: Partial<InventoryCategory>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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>