Platform API

GetSettings

The following routes are available for this service:
All Verbs	/api/settings

import 'package:servicestack/servicestack.dart';

class SettingModel implements IConvertible
{
    String? SettingId;
    String? SettingName;
    String? SettingValue;

    SettingModel({this.SettingId,this.SettingName,this.SettingValue});
    SettingModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SettingId = json['SettingId'];
        SettingName = json['SettingName'];
        SettingValue = json['SettingValue'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SettingId': SettingId,
        'SettingName': SettingName,
        'SettingValue': SettingValue
    };

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

// @ApiResponse(Description="List of settings")
class GetSettingsResponse implements IConvertible
{
    List<SettingModel>? Settings;
    ResponseStatus? ResponseStatus;

    GetSettingsResponse({this.Settings,this.ResponseStatus});
    GetSettingsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class GetSettings implements IConvertible
{
    List<String>? SettingIds;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'SettingModel': TypeInfo(TypeOf.Class, create:() => SettingModel()),
    'GetSettingsResponse': TypeInfo(TypeOf.Class, create:() => GetSettingsResponse()),
    'List<SettingModel>': TypeInfo(TypeOf.Class, create:() => <SettingModel>[]),
    'GetSettings': TypeInfo(TypeOf.Class, create:() => GetSettings()),
});

Dart GetSettings DTOs

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

HTTP + JSV

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

POST /api/settings HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	SettingIds: 
	[
		00000000-0000-0000-0000-000000000000
	]
}

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

{
	Settings: 
	[
		{
			SettingName: String,
			SettingValue: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}