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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"Type":"Category","ObjectId":"String","Workspace":"String","ItemCategory":"String","HideFor":["String"],"ShowFor":["String"],"ParentCategoryId":"String","Enabled":false,"ChildNodes":[{}],"IncludeInactive":false,"DescendantCount":0}