Field Squared API Services

<back to all web 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}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * This dto documents a set of controls that match the given workspace and binding.
    */
    public static class BindingDocumentation
    {
        public String Workspace = null;
        public String Binding = null;
        public ArrayList<ControlDocumentation> Controls = null;
        
        public String getWorkspace() { return Workspace; }
        public BindingDocumentation setWorkspace(String value) { this.Workspace = value; return this; }
        public String getBinding() { return Binding; }
        public BindingDocumentation setBinding(String value) { this.Binding = value; return this; }
        public ArrayList<ControlDocumentation> getControls() { return Controls; }
        public BindingDocumentation setControls(ArrayList<ControlDocumentation> value) { this.Controls = value; return this; }
    }

    public static class ControlDocumentation
    {
        public String Binding = null;
        public String InputFormat = null;
        public String InputContraints = null;
        public String InputExample = null;
        
        public String getBinding() { return Binding; }
        public ControlDocumentation setBinding(String value) { this.Binding = value; return this; }
        public String getInputFormat() { return InputFormat; }
        public ControlDocumentation setInputFormat(String value) { this.InputFormat = value; return this; }
        public String getInputContraints() { return InputContraints; }
        public ControlDocumentation setInputContraints(String value) { this.InputContraints = value; return this; }
        public String getInputExample() { return InputExample; }
        public ControlDocumentation setInputExample(String value) { this.InputExample = value; return this; }
    }

}

Java BindingDocumentation 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/document/{Binding} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/json