CollectionsAPI

GetCollectionsRequest

The following routes are available for this service:
GET	/v4/collections/list

import 'package:servicestack/servicestack.dart';

// @DataContract
class V4BaseRequest implements IConvertible
{
    V4BaseRequest();
    V4BaseRequest.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "V4BaseRequest";
    TypeContext? context = _ctx;
}

// @DataContract
class V4PaginatedBaseRequest extends V4BaseRequest implements IConvertible
{
    // @DataMember(Name="offset")
    int? offset;

    // @DataMember(Name="limit")
    int? limit;

    V4PaginatedBaseRequest({this.offset,this.limit});
    V4PaginatedBaseRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        offset = json['offset'];
        limit = json['limit'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'offset': offset,
        'limit': limit
    });

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

// @DataContract
class V4ListRequest extends V4PaginatedBaseRequest implements IConvertible
{
    // @DataMember(Name="ids")
    List<String>? ids;

    V4ListRequest({this.ids});
    V4ListRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'ids': JsonConverters.toJson(ids,'List<String>',context!)
    });

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

// @DataContract
class V4BaseResponse implements IConvertible
{
    // @DataMember(Name="status")
    ResponseStatus? status;

    V4BaseResponse({this.status});
    V4BaseResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        status = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'status': JsonConverters.toJson(status,'ResponseStatus',context!)
    };

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

// @DataContract
class V4PageObject implements IConvertible
{
    // @DataMember(Name="offset")
    int? offset;

    // @DataMember(Name="limit")
    int? limit;

    // @DataMember(Name="totalRecords")
    int? totalRecords;

    V4PageObject({this.offset,this.limit,this.totalRecords});
    V4PageObject.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        offset = json['offset'];
        limit = json['limit'];
        totalRecords = json['totalRecords'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'offset': offset,
        'limit': limit,
        'totalRecords': totalRecords
    };

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

// @DataContract
class V4PaginatedBaseResponse extends V4BaseResponse implements IConvertible
{
    // @DataMember(Name="page")
    V4PageObject? page;

    V4PaginatedBaseResponse({this.page});
    V4PaginatedBaseResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        page = JsonConverters.fromJson(json['page'],'V4PageObject',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'page': JsonConverters.toJson(page,'V4PageObject',context!)
    });

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

abstract class IUserCollection
{
    String? id;
    String? title;
    List<String>? linkIds;
    String? collectionSettingsId;
}

// @DataContract
class GetCollectionsResponse extends V4PaginatedBaseResponse implements IGetCollectionsResponse, IConvertible
{
    // @DataMember(Name="data")
    List<IUserCollection>? data;

    GetCollectionsResponse({this.data});
    GetCollectionsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        data = JsonConverters.fromJson(json['data'],'List<IUserCollection>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'data': JsonConverters.toJson(data,'List<IUserCollection>',context!)
    });

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

// @DataContract
class GetCollectionsRequest extends V4ListRequest implements IConvertible
{
    GetCollectionsRequest();
    GetCollectionsRequest.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "GetCollectionsRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'collections_api_zane.dev.platform.georiot.com', types: <String, TypeInfo> {
    'V4BaseRequest': TypeInfo(TypeOf.Class, create:() => V4BaseRequest()),
    'V4PaginatedBaseRequest': TypeInfo(TypeOf.Class, create:() => V4PaginatedBaseRequest()),
    'V4ListRequest': TypeInfo(TypeOf.Class, create:() => V4ListRequest()),
    'V4BaseResponse': TypeInfo(TypeOf.Class, create:() => V4BaseResponse()),
    'V4PageObject': TypeInfo(TypeOf.Class, create:() => V4PageObject()),
    'V4PaginatedBaseResponse': TypeInfo(TypeOf.Class, create:() => V4PaginatedBaseResponse()),
    'IUserCollection': TypeInfo(TypeOf.Interface),
    'GetCollectionsResponse': TypeInfo(TypeOf.Class, create:() => GetCollectionsResponse()),
    'List<IUserCollection>': TypeInfo(TypeOf.Class, create:() => <IUserCollection>[]),
    'GetCollectionsRequest': TypeInfo(TypeOf.Class, create:() => GetCollectionsRequest()),
});

Dart GetCollectionsRequest DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v4/collections/list HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"page":{"offset":0,"limit":0,"totalRecords":0},"status":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}