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}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.Inventory;

namespace Field2Office.API.Model.Inventory
{
    public partial class InventoryCategory
        : InventoryTreeNode
    {
        public InventoryCategory()
        {
            HideFor = new List<string>{};
            ShowFor = new List<string>{};
            ChildNodes = new List<InventoryTreeNode>{};
        }

        public virtual string Type { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string Workspace { get; set; }
        public virtual string ItemCategory { get; set; }
        public virtual List<string> HideFor { get; set; }
        public virtual List<string> ShowFor { get; set; }
        public virtual string ParentCategoryId { get; set; }
        public virtual bool? Enabled { get; set; }
        public virtual List<InventoryTreeNode> ChildNodes { get; set; }
        public virtual bool IncludeInactive { get; set; }
    }

    public partial class InventoryTreeNode
    {
        public virtual string Type { get; set; }
        public virtual int DescendantCount { get; set; }
    }

}

C# InventoryCategory DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

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