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}

namespace Field2Office.API.Model.Documentation

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ControlDocumentation() = 
        member val Binding:String = null with get,set
        member val InputFormat:String = null with get,set
        member val InputContraints:String = null with get,set
        member val InputExample:String = null with get,set

    [<AllowNullLiteral>]
    type TemplateDocumentation() = 
        member val TemplateName:String = null with get,set
        member val TemplateProperties:Dictionary<String, String> = new Dictionary<String, String>() with get,set
        member val Controls:ResizeArray<ControlDocumentation> = new ResizeArray<ControlDocumentation>() with get,set

    ///<summary>
    ///Detail structural compoments and documentation required for a workspace document for a given binding.
    ///</summary>
    [<AllowNullLiteral>]
    type WorkspaceFormDocumentation() = 
        member val Workspace:String = null with get,set
        member val Binding:String = null with get,set
        member val MatchingTemplates:ResizeArray<TemplateDocumentation> = new ResizeArray<TemplateDocumentation>() with get,set

F# 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