Field Squared API Services

BindingDocumentation

This dto documents a set of controls that match the given workspace and binding.

The following routes are available for this service:
GET	/{Workspace}/apidoc/document/{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

        '''<Summary>
        '''This dto documents a set of controls that match the given workspace and binding.
        '''</Summary>
        Public Partial Class BindingDocumentation
            Public Sub New()
                Controls = New List(Of ControlDocumentation)
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property Binding As String
            Public Overridable Property Controls As List(Of ControlDocumentation)
        End Class

        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
    End Namespace
End Namespace

VB.NET BindingDocumentation 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}/apidoc/document/{Binding} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv