Trendsic Platform Service

<back to all web services

CoverageTemplatesRequest

Requires Authentication
The following routes are available for this service:
GET/v1/coverage/policies/templates
import 'package:servicestack/servicestack.dart';

class CoverageRingDef implements IConvertible
{
    String? Key;
    String? Label;
    String? Sub;
    int? WaitMinutes;
    bool? Enabled;

    CoverageRingDef({this.Key,this.Label,this.Sub,this.WaitMinutes,this.Enabled});
    CoverageRingDef.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Key = json['Key'];
        Label = json['Label'];
        Sub = json['Sub'];
        WaitMinutes = json['WaitMinutes'];
        Enabled = json['Enabled'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Key': Key,
        'Label': Label,
        'Sub': Sub,
        'WaitMinutes': WaitMinutes,
        'Enabled': Enabled
    };

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

class CoveragePolicyPrefs implements IConvertible
{
    String? AssignmentMode;
    int? RestHours;
    int? OtThresholdHours;
    int? RingWaitMinutes;
    String? QuietStart;
    String? QuietEnd;
    bool? RescheduleAllowed;
    String? QuietMode;
    List<CoverageRingDef>? Rings = [];

    CoveragePolicyPrefs({this.AssignmentMode,this.RestHours,this.OtThresholdHours,this.RingWaitMinutes,this.QuietStart,this.QuietEnd,this.RescheduleAllowed,this.QuietMode,this.Rings});
    CoveragePolicyPrefs.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AssignmentMode = json['AssignmentMode'];
        RestHours = json['RestHours'];
        OtThresholdHours = json['OtThresholdHours'];
        RingWaitMinutes = json['RingWaitMinutes'];
        QuietStart = json['QuietStart'];
        QuietEnd = json['QuietEnd'];
        RescheduleAllowed = json['RescheduleAllowed'];
        QuietMode = json['QuietMode'];
        Rings = JsonConverters.fromJson(json['Rings'],'List<CoverageRingDef>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AssignmentMode': AssignmentMode,
        'RestHours': RestHours,
        'OtThresholdHours': OtThresholdHours,
        'RingWaitMinutes': RingWaitMinutes,
        'QuietStart': QuietStart,
        'QuietEnd': QuietEnd,
        'RescheduleAllowed': RescheduleAllowed,
        'QuietMode': QuietMode,
        'Rings': JsonConverters.toJson(Rings,'List<CoverageRingDef>',context!)
    };

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

class CoverageRuleDocSection implements IConvertible
{
    String? H;
    String? T;

    CoverageRuleDocSection({this.H,this.T});
    CoverageRuleDocSection.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        H = json['H'];
        T = json['T'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'H': H,
        'T': T
    };

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

class CoverageRuleTuneOption implements IConvertible
{
    String? Label;
    String? Sub;

    CoverageRuleTuneOption({this.Label,this.Sub});
    CoverageRuleTuneOption.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Label = json['Label'];
        Sub = json['Sub'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Label': Label,
        'Sub': Sub
    };

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

class CoverageRuleTune implements IConvertible
{
    String? Intro;
    List<CoverageRuleTuneOption>? Options = [];

    CoverageRuleTune({this.Intro,this.Options});
    CoverageRuleTune.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class CoverageRuleDef implements IConvertible
{
    String? RuleId;
    String? Name;
    String? Kind;
    String? Demand;
    String? SourcePolicyName;
    String? CascadeLevel;
    String? Why;
    String? Change;
    String? OverrideWho;
    String? OverrideConsequence;
    String? NoNote;
    Map<String,String?>? Params = {};
    List<CoverageRuleDocSection>? Doc = [];
    CoverageRuleTune? Tune;

    CoverageRuleDef({this.RuleId,this.Name,this.Kind,this.Demand,this.SourcePolicyName,this.CascadeLevel,this.Why,this.Change,this.OverrideWho,this.OverrideConsequence,this.NoNote,this.Params,this.Doc,this.Tune});
    CoverageRuleDef.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RuleId = json['RuleId'];
        Name = json['Name'];
        Kind = json['Kind'];
        Demand = json['Demand'];
        SourcePolicyName = json['SourcePolicyName'];
        CascadeLevel = json['CascadeLevel'];
        Why = json['Why'];
        Change = json['Change'];
        OverrideWho = json['OverrideWho'];
        OverrideConsequence = json['OverrideConsequence'];
        NoNote = json['NoNote'];
        Params = JsonConverters.toStringMap(json['Params']);
        Doc = JsonConverters.fromJson(json['Doc'],'List<CoverageRuleDocSection>',context!);
        Tune = JsonConverters.fromJson(json['Tune'],'CoverageRuleTune',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'RuleId': RuleId,
        'Name': Name,
        'Kind': Kind,
        'Demand': Demand,
        'SourcePolicyName': SourcePolicyName,
        'CascadeLevel': CascadeLevel,
        'Why': Why,
        'Change': Change,
        'OverrideWho': OverrideWho,
        'OverrideConsequence': OverrideConsequence,
        'NoNote': NoNote,
        'Params': Params,
        'Doc': JsonConverters.toJson(Doc,'List<CoverageRuleDocSection>',context!),
        'Tune': JsonConverters.toJson(Tune,'CoverageRuleTune',context!)
    };

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

class CoveragePolicyDoc implements IConvertible
{
    String? Intro;
    String? LockLine;
    String? TemplateName;
    CoveragePolicyPrefs? Prefs;
    List<CoverageRuleDef>? Rules = [];

    CoveragePolicyDoc({this.Intro,this.LockLine,this.TemplateName,this.Prefs,this.Rules});
    CoveragePolicyDoc.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Intro = json['Intro'];
        LockLine = json['LockLine'];
        TemplateName = json['TemplateName'];
        Prefs = JsonConverters.fromJson(json['Prefs'],'CoveragePolicyPrefs',context!);
        Rules = JsonConverters.fromJson(json['Rules'],'List<CoverageRuleDef>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Intro': Intro,
        'LockLine': LockLine,
        'TemplateName': TemplateName,
        'Prefs': JsonConverters.toJson(Prefs,'CoveragePolicyPrefs',context!),
        'Rules': JsonConverters.toJson(Rules,'List<CoverageRuleDef>',context!)
    };

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

class CoverageTemplateInfo implements IConvertible
{
    String? Key;
    String? Name;
    String? Sub;
    CoveragePolicyDoc? Doc;

    CoverageTemplateInfo({this.Key,this.Name,this.Sub,this.Doc});
    CoverageTemplateInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Key = json['Key'];
        Name = json['Name'];
        Sub = json['Sub'];
        Doc = JsonConverters.fromJson(json['Doc'],'CoveragePolicyDoc',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Key': Key,
        'Name': Name,
        'Sub': Sub,
        'Doc': JsonConverters.toJson(Doc,'CoveragePolicyDoc',context!)
    };

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

class CoverageTemplatesResponse implements IConvertible
{
    List<CoverageTemplateInfo>? Templates = [];
    ResponseStatus? ResponseStatus;

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

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

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

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

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

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

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'CoverageRingDef': TypeInfo(TypeOf.Class, create:() => CoverageRingDef()),
    'CoveragePolicyPrefs': TypeInfo(TypeOf.Class, create:() => CoveragePolicyPrefs()),
    'List<CoverageRingDef>': TypeInfo(TypeOf.Class, create:() => <CoverageRingDef>[]),
    'CoverageRuleDocSection': TypeInfo(TypeOf.Class, create:() => CoverageRuleDocSection()),
    'CoverageRuleTuneOption': TypeInfo(TypeOf.Class, create:() => CoverageRuleTuneOption()),
    'CoverageRuleTune': TypeInfo(TypeOf.Class, create:() => CoverageRuleTune()),
    'List<CoverageRuleTuneOption>': TypeInfo(TypeOf.Class, create:() => <CoverageRuleTuneOption>[]),
    'CoverageRuleDef': TypeInfo(TypeOf.Class, create:() => CoverageRuleDef()),
    'List<CoverageRuleDocSection>': TypeInfo(TypeOf.Class, create:() => <CoverageRuleDocSection>[]),
    'CoveragePolicyDoc': TypeInfo(TypeOf.Class, create:() => CoveragePolicyDoc()),
    'List<CoverageRuleDef>': TypeInfo(TypeOf.Class, create:() => <CoverageRuleDef>[]),
    'CoverageTemplateInfo': TypeInfo(TypeOf.Class, create:() => CoverageTemplateInfo()),
    'CoverageTemplatesResponse': TypeInfo(TypeOf.Class, create:() => CoverageTemplatesResponse()),
    'List<CoverageTemplateInfo>': TypeInfo(TypeOf.Class, create:() => <CoverageTemplateInfo>[]),
    'CoverageTemplatesRequest': TypeInfo(TypeOf.Class, create:() => CoverageTemplatesRequest()),
});

Dart CoverageTemplatesRequest 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.

GET /v1/coverage/policies/templates HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Templates: 
	[
		{
			Key: String,
			Name: String,
			Sub: String,
			Doc: 
			{
				Intro: String,
				LockLine: String,
				TemplateName: String,
				Prefs: 
				{
					AssignmentMode: String,
					RestHours: 0,
					OtThresholdHours: 0,
					RingWaitMinutes: 0,
					QuietStart: String,
					QuietEnd: String,
					RescheduleAllowed: False,
					QuietMode: String,
					Rings: 
					[
						{
							Key: String,
							Label: String,
							Sub: String,
							WaitMinutes: 0,
							Enabled: False
						}
					]
				},
				Rules: 
				[
					{
						RuleId: String,
						Name: String,
						Kind: String,
						Demand: String,
						SourcePolicyName: String,
						CascadeLevel: String,
						Why: String,
						Change: String,
						OverrideWho: String,
						OverrideConsequence: String,
						NoNote: String,
						Params: 
						{
							String: String
						},
						Doc: 
						[
							{
								H: String,
								T: String
							}
						],
						Tune: 
						{
							Intro: String,
							Options: 
							[
								{
									Label: String,
									Sub: String
								}
							]
						}
					}
				]
			}
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}