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}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InventoryTreeNode:
    type: Optional[str] = None
    descendant_count: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InventoryCategory(InventoryTreeNode):
    type: Optional[str] = None
    object_id: Optional[str] = None
    workspace: Optional[str] = None
    item_category: Optional[str] = None
    hide_for: Optional[List[str]] = None
    show_for: Optional[List[str]] = None
    parent_category_id: Optional[str] = None
    enabled: Optional[bool] = None
    child_nodes: Optional[List[InventoryTreeNode]] = None
    include_inactive: bool = False

Python InventoryCategory DTOs

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

HTTP + CSV

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

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