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}

import Foundation
import ServiceStack

/**
* This dto documents a set of controls that match the given workspace and binding.
*/
public class BindingDocumentation : Codable
{
    public var workspace:String
    public var binding:String
    public var controls:[ControlDocumentation] = []

    required public init(){}
}

public class ControlDocumentation : Codable
{
    public var binding:String
    public var inputFormat:String
    public var inputContraints:String
    public var inputExample:String

    required public init(){}
}

Swift BindingDocumentation DTOs

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

HTTP + XML

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/xml