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}

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

class TemplateDocumentation implements IConvertible
{
    String? TemplateName;
    Map<String,String?>? TemplateProperties;
    List<ControlDocumentation>? Controls;

    TemplateDocumentation({this.TemplateName,this.TemplateProperties,this.Controls});
    TemplateDocumentation.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

/**
* Detail structural compoments and documentation required for a workspace document for a given binding.
*/
class WorkspaceFormDocumentation implements IConvertible
{
    String? Workspace;
    String? Binding;
    List<TemplateDocumentation>? MatchingTemplates;

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

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

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

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

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

Dart 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