CollectionsAPI

<back to all web services

GetCollectionSettingsRequest

Requires Authentication
The following routes are available for this service:
GET/v4/collections/settings
GET/v4/collections/settings/{Id}
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 GetCollectionSettingsResponse implements IGetCollectionSettingsResponse, IConvertible
{
    GetCollectionSettingsResponse();
    GetCollectionSettingsResponse.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

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

// @DataContract
class GetCollectionSettingsRequest extends V4BaseRequest implements IConvertible
{
    // @DataMember(Name="id")
    String? id;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'collections_api_zane.dev.platform.georiot.com', types: <String, TypeInfo> {
    'V4BaseRequest': TypeInfo(TypeOf.Class, create:() => V4BaseRequest()),
    'GetCollectionSettingsResponse': TypeInfo(TypeOf.Class, create:() => GetCollectionSettingsResponse()),
    'GetCollectionSettingsRequest': TypeInfo(TypeOf.Class, create:() => GetCollectionSettingsRequest()),
});

Dart GetCollectionSettingsRequest 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 /v4/collections/settings HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCollectionSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CollectionsAPI.ServiceModel.V4.Responses">
  <data xmlns:d2p1="http://schemas.datacontract.org/2004/07/CollectionsAPI.ServiceModel.V4.DTOs" i:nil="true" />
</GetCollectionSettingsResponse>