Field Squared API Services

<back to all web services

BindingDocumentation

This dto documents a set of controls that match the given workspace and binding.

import 'package:servicestack/servicestack.dart';

class ControlDocumentation implements IConvertible
{
    String? Binding;
    String? InputFormat;
    String? InputContraints;
    String? InputExample;

    ControlDocumentation({this.Binding,this.InputFormat,this.InputContraints,this.InputExample});
    ControlDocumentation.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Binding = json['Binding'];
        InputFormat = json['InputFormat'];
        InputContraints = json['InputContraints'];
        InputExample = json['InputExample'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Binding': Binding,
        'InputFormat': InputFormat,
        'InputContraints': InputContraints,
        'InputExample': InputExample
    };

    getTypeName() => "ControlDocumentation";
    TypeContext? context = _ctx;
}

/**
* This dto documents a set of controls that match the given workspace and binding.
*/
class BindingDocumentation implements IConvertible
{
    String? Workspace;
    String? Binding;
    List<ControlDocumentation>? Controls;

    BindingDocumentation({this.Workspace,this.Binding,this.Controls});
    BindingDocumentation.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Workspace = json['Workspace'];
        Binding = json['Binding'];
        Controls = JsonConverters.fromJson(json['Controls'],'List<ControlDocumentation>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Workspace': Workspace,
        'Binding': Binding,
        'Controls': JsonConverters.toJson(Controls,'List<ControlDocumentation>',context!)
    };

    getTypeName() => "BindingDocumentation";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'dev.fieldsquared.com', types: <String, TypeInfo> {
    'ControlDocumentation': TypeInfo(TypeOf.Class, create:() => ControlDocumentation()),
    'BindingDocumentation': TypeInfo(TypeOf.Class, create:() => BindingDocumentation()),
    'List<ControlDocumentation>': TypeInfo(TypeOf.Class, create:() => <ControlDocumentation>[]),
});

Dart BindingDocumentation DTOs

GET /{Workspace}/apidoc/document/{Binding} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/csv