Field Squared API Services

<back to all web services

Catalog

Contains the data for a catalog within the system.

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

Namespace Global

    Namespace Field2Office.API.Model.Catalogs

        '''<Summary>
        '''Contains the data for a catalog within the system.
        '''</Summary>
        Public Partial Class Catalog
            Public Sub New()
                Ancestors = New List(Of String)
                Items = New Dictionary(Of String, Dictionary(Of String,String))
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property AssignedWorkspace As String
            Public Overridable Property ObjectId As String
            Public Overridable Property VersionId As String
            Public Overridable Property BasedOn As String
            Public Overridable Property ExternalId As String
            Public Overridable Property Created As String
            Public Overridable Property LastUpdated As String
            Public Overridable Property Name As String
            Public Overridable Property Type As String
            Public Overridable Property Parent As String
            Public Overridable Property Ancestors As List(Of String)
            Public Overridable Property Items As Dictionary(Of String, Dictionary(Of String,String))
            Public Overridable Property Enabled As Boolean
        End Class
    End Namespace
End Namespace

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

{"Workspace":"String","AssignedWorkspace":"String","ObjectId":"String","VersionId":"String","BasedOn":"String","ExternalId":"String","Created":"String","LastUpdated":"String","Name":"String","Type":"String","Parent":"String","Ancestors":["String"],"Items":{"String":{"String":"String"}},"Enabled":false}