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}

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
{
    ///<summary>
    ///This dto documents a set of controls that match the given workspace and binding.
    ///</summary>
    public partial class BindingDocumentation
    {
        public BindingDocumentation()
        {
            Controls = new List<ControlDocumentation>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string Binding { get; set; }
        public virtual List<ControlDocumentation> Controls { get; set; }
    }

    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; }
    }

}

C# BindingDocumentation 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/document/{Binding} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/csv