Field Squared API Services

WorkspaceFormDocumentation

Detail structural compoments and documentation required for a workspace document for a given binding.

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Field2Office.API.Model.Documentation

Namespace Global

    Namespace Field2Office.API.Model.Documentation

        Public Partial Class ControlDocumentation
            Public Overridable Property Binding As String
            Public Overridable Property InputFormat As String
            Public Overridable Property InputContraints As String
            Public Overridable Property InputExample As String
        End Class

        Public Partial Class TemplateDocumentation
            Public Sub New()
                TemplateProperties = New Dictionary(Of String, String)
                Controls = New List(Of ControlDocumentation)
            End Sub

            Public Overridable Property TemplateName As String
            Public Overridable Property TemplateProperties As Dictionary(Of String, String)
            Public Overridable Property Controls As List(Of ControlDocumentation)
        End Class

        '''<Summary>
        '''Detail structural compoments and documentation required for a workspace document for a given binding.
        '''</Summary>
        Public Partial Class WorkspaceFormDocumentation
            Public Sub New()
                MatchingTemplates = New List(Of TemplateDocumentation)
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property Binding As String
            Public Overridable Property MatchingTemplates As List(Of TemplateDocumentation)
        End Class
    End Namespace
End Namespace

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

GET /{Workspace}/apidoc/{Binding} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/csv