Field Squared API Services

<back to all web services

CatalogList

/{Workspace}/CatalogList returns a list of catalogs in the workspace.

import 'package:servicestack/servicestack.dart';

/**
* Contains the data for a catalog within the system.
*/
class Catalog implements IConvertible
{
    String? Workspace;
    String? AssignedWorkspace;
    String? ObjectId;
    String? VersionId;
    String? BasedOn;
    String? ExternalId;
    String? Created;
    String? LastUpdated;
    String? Name;
    String? Type;
    String? Parent;
    List<String>? Ancestors;
    Map<String,Map<String,String>?>? Items;
    bool? Enabled;

    Catalog({this.Workspace,this.AssignedWorkspace,this.ObjectId,this.VersionId,this.BasedOn,this.ExternalId,this.Created,this.LastUpdated,this.Name,this.Type,this.Parent,this.Ancestors,this.Items,this.Enabled});
    Catalog.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Workspace = json['Workspace'];
        AssignedWorkspace = json['AssignedWorkspace'];
        ObjectId = json['ObjectId'];
        VersionId = json['VersionId'];
        BasedOn = json['BasedOn'];
        ExternalId = json['ExternalId'];
        Created = json['Created'];
        LastUpdated = json['LastUpdated'];
        Name = json['Name'];
        Type = json['Type'];
        Parent = json['Parent'];
        Ancestors = JsonConverters.fromJson(json['Ancestors'],'List<String>',context!);
        Items = JsonConverters.fromJson(json['Items'],'Map<String,Map<String,String>?>',context!);
        Enabled = json['Enabled'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Workspace': Workspace,
        'AssignedWorkspace': AssignedWorkspace,
        'ObjectId': ObjectId,
        'VersionId': VersionId,
        'BasedOn': BasedOn,
        'ExternalId': ExternalId,
        'Created': Created,
        'LastUpdated': LastUpdated,
        'Name': Name,
        'Type': Type,
        'Parent': Parent,
        'Ancestors': JsonConverters.toJson(Ancestors,'List<String>',context!),
        'Items': JsonConverters.toJson(Items,'Map<String,Map<String,String>?>',context!),
        'Enabled': Enabled
    };

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

/**
* /{Workspace}/CatalogList returns a list of catalogs in the workspace.
*/
class CatalogList implements IConvertible
{
    String? Workspace;
    String? DateGenerated;
    List<Catalog>? Catalogs;
    int? RecordsAvailable;

    CatalogList({this.Workspace,this.DateGenerated,this.Catalogs,this.RecordsAvailable});
    CatalogList.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Workspace = json['Workspace'];
        DateGenerated = json['DateGenerated'];
        Catalogs = JsonConverters.fromJson(json['Catalogs'],'List<Catalog>',context!);
        RecordsAvailable = json['RecordsAvailable'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Workspace': Workspace,
        'DateGenerated': DateGenerated,
        'Catalogs': JsonConverters.toJson(Catalogs,'List<Catalog>',context!),
        'RecordsAvailable': RecordsAvailable
    };

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

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

Dart CatalogList DTOs

GET /{Workspace}/CatalogList HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv