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 .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
}