Field Squared API Services

CatalogList

/{Workspace}/CatalogList returns a list of catalogs in the workspace.

The following routes are available for this service:
GET	/{Workspace}/CatalogList

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

        '''<Summary>
        '''/{Workspace}/CatalogList returns a list of catalogs in the workspace.
        '''</Summary>
        Public Partial Class CatalogList
            Public Sub New()
                Catalogs = New List(Of Catalog)
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property DateGenerated As String
            Public Overridable Property Catalogs As List(Of Catalog)
            Public Overridable Property RecordsAvailable As Long
        End Class
    End Namespace
End Namespace

VB.NET CatalogList 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.

GET /{Workspace}/CatalogList HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv