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}

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

namespace Field2Office.API.Model.Documentation
{
    public partial class ControlDocumentation
    {
        public virtual string Binding { get; set; }
        public virtual string InputFormat { get; set; }
        public virtual string InputContraints { get; set; }
        public virtual string InputExample { get; set; }
    }

    public partial class TemplateDocumentation
    {
        public TemplateDocumentation()
        {
            TemplateProperties = new Dictionary<string, string>{};
            Controls = new List<ControlDocumentation>{};
        }

        public virtual string TemplateName { get; set; }
        public virtual Dictionary<string, string> TemplateProperties { get; set; }
        public virtual List<ControlDocumentation> Controls { get; set; }
    }

    ///<summary>
    ///Detail structural compoments and documentation required for a workspace document for a given binding.
    ///</summary>
    public partial class WorkspaceFormDocumentation
    {
        public WorkspaceFormDocumentation()
        {
            MatchingTemplates = new List<TemplateDocumentation>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string Binding { get; set; }
        public virtual List<TemplateDocumentation> MatchingTemplates { get; set; }
    }

}

C# WorkspaceFormDocumentation DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json