Field Squared API Services

<back to all web services

InventoryItemTemplate

The following routes are available for this service:
GET,PUT,POST,DELETE/{Workspace}/InventoryItemTemplate
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Field2Office.API.Model.Inventory
Imports Field2Office.API.Model.Workspaces
Imports Field2Office.DomainObjects

Namespace Global

    Namespace Field2Office.API.Model.Inventory

        Public Partial Class InventoryItemTemplate
            Public Sub New()
                CustomFields = New List(Of CustomField)
            End Sub

            Public Overridable Property ObjectId As String
            Public Overridable Property Workspace As String
            Public Overridable Property Name As String
            Public Overridable Property CustomFields As List(Of CustomField)
        End Class
    End Namespace

    Namespace Field2Office.API.Model.Workspaces

        Public Partial Class CustomField
            Public Sub New()
                Hidden = New List(Of String)
                ReadOnly = New List(Of String)
                ControlArgs = New Dictionary(Of String, Object)
            End Sub

            Public Overridable Property Key As String
            Public Overridable Property Label As String
            Public Overridable Property IsActive As Boolean
            Public Overridable Property IsReadOnly As Boolean
            Public Overridable Property IsHidden As Boolean
            Public Overridable Property IsMandatory As Boolean
            Public Overridable Property DisplayOnMap As Boolean
            Public Overridable Property CustomFieldDataType As CustomFieldDataType
            Public Overridable Property Values As String
            Public Overridable Property Prompt As String
            Public Overridable Property [Default] As String
            Public Overridable Property DefaultAutoUpdate As Boolean
            Public Overridable Property RequiredIf As String
            Public Overridable Property Hidden As List(Of String)
            Public Overridable Property ReadOnly As List(Of String)
            Public Overridable Property ControlArgs As Dictionary(Of String, Object)
            Public Overridable Property IndexSlot As String
            Public Overridable Property Index As String
        End Class
    End Namespace

    Namespace Field2Office.DomainObjects

        Public Enum CustomFieldDataType
            Text
            Number
            [Decimal]
            Money
            PhoneNumber
            Ssn
            List
            [Date]
            File
            Barcode
            GPS
            Photo
            Spacer
            Separator
            AutoNumber
            TextArea
            Contact
            User
            Asset
            Checkbox
            CoreAssetList
            CoreTaskList
            CoreParentTask
            CoreContactList
            ComboBox
            DateTime
            Time
            Location
            CoreLocation
            Label
            EventLog
            Address
            Catalog
            CoreTeamList
            Segment
            CoreTimeSeries
            TimeSeries
            Command
            AutoNumberNumeric
            CatalogList
            CatalogComboBox
            DateRange
            DocumentGrid
            ReportLink
            Hyperlink
            PercentComplete
            Chart
            Range
            ExternalId
            AssetCatalog
            Inventory
            CoreTaskLaborItemTypes
            CoreTaskLaborItems
            ObjectList
            CoreTimeZone
        End Enum
    End Namespace
End Namespace

VB.NET InventoryItemTemplate 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}/InventoryItemTemplate HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ObjectId: String,
	Workspace: String,
	Name: String,
	CustomFields: 
	[
		{
			Key: String,
			Label: String,
			IsActive: False,
			IsReadOnly: False,
			IsHidden: False,
			IsMandatory: False,
			DisplayOnMap: False,
			CustomFieldDataType: Text,
			Values: String,
			Prompt: String,
			Default: String,
			DefaultAutoUpdate: False,
			RequiredIf: String,
			Hidden: 
			[
				String
			],
			ReadOnly: 
			[
				String
			],
			ControlArgs: 
			{
				String: {}
			},
			IndexSlot: String,
			Index: String
		}
	]
}