<back to all web services

AddonMessage

The following routes are available for this service:
GET POST/RestApi/Sitefinity/packaging/add-on
import 'package:servicestack/servicestack.dart';

class AddonMessage implements IConvertible
{
    String? Id;
    bool? IncludeContent;
    bool? Deactivate;

    AddonMessage({this.Id,this.IncludeContent,this.Deactivate});
    AddonMessage.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        IncludeContent = json['IncludeContent'];
        Deactivate = json['Deactivate'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'IncludeContent': IncludeContent,
        'Deactivate': Deactivate
    };

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

enum AddOnEntryType
{
    Content,
    Template,
    Custom,
    Module,
    Form,
    Classification,
    WebService,
}

class AddOnEntry implements IConvertible
{
    String? DisplayName;
    int? Count;
    AddOnEntryType? AddonEntryType;

    AddOnEntry({this.DisplayName,this.Count,this.AddonEntryType});
    AddOnEntry.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'DisplayName': DisplayName,
        'Count': Count,
        'AddonEntryType': JsonConverters.toJson(AddonEntryType,'AddOnEntryType',context!)
    };

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

class AddonInfo implements IConvertible
{
    String? Id;
    String? Name;
    bool? IsActive;
    String? Description;
    bool? IsDataImported;
    String? Version;
    String? Author;
    String? DataImportedToSiteName;
    List<AddOnEntry>? Entries;
    bool? HasErrorsOnContentImport;
    bool? HasErrorsOnStructureImport;
    bool? HasErrorsOnActivate;

    AddonInfo({this.Id,this.Name,this.IsActive,this.Description,this.IsDataImported,this.Version,this.Author,this.DataImportedToSiteName,this.Entries,this.HasErrorsOnContentImport,this.HasErrorsOnStructureImport,this.HasErrorsOnActivate});
    AddonInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Name = json['Name'];
        IsActive = json['IsActive'];
        Description = json['Description'];
        IsDataImported = json['IsDataImported'];
        Version = json['Version'];
        Author = json['Author'];
        DataImportedToSiteName = json['DataImportedToSiteName'];
        Entries = JsonConverters.fromJson(json['Entries'],'List<AddOnEntry>',context!);
        HasErrorsOnContentImport = json['HasErrorsOnContentImport'];
        HasErrorsOnStructureImport = json['HasErrorsOnStructureImport'];
        HasErrorsOnActivate = json['HasErrorsOnActivate'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Name': Name,
        'IsActive': IsActive,
        'Description': Description,
        'IsDataImported': IsDataImported,
        'Version': Version,
        'Author': Author,
        'DataImportedToSiteName': DataImportedToSiteName,
        'Entries': JsonConverters.toJson(Entries,'List<AddOnEntry>',context!),
        'HasErrorsOnContentImport': HasErrorsOnContentImport,
        'HasErrorsOnStructureImport': HasErrorsOnStructureImport,
        'HasErrorsOnActivate': HasErrorsOnActivate
    };

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

TypeContext _ctx = TypeContext(library: 'www.asg.com.au', types: <String, TypeInfo> {
    'AddonMessage': TypeInfo(TypeOf.Class, create:() => AddonMessage()),
    'AddOnEntryType': TypeInfo(TypeOf.Enum, enumValues:AddOnEntryType.values),
    'AddOnEntry': TypeInfo(TypeOf.Class, create:() => AddOnEntry()),
    'AddonInfo': TypeInfo(TypeOf.Class, create:() => AddonInfo()),
    'List<AddOnEntry>': TypeInfo(TypeOf.Class, create:() => <AddOnEntry>[]),
});

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

POST /RestApi/Sitefinity/packaging/add-on HTTP/1.1 
Host: www.asg.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"IncludeContent":false,"Deactivate":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Name":"String","IsActive":false,"Description":"String","IsDataImported":false,"Version":"String","Author":"String","DataImportedToSiteName":"String","HasErrorsOnContentImport":false,"HasErrorsOnStructureImport":false,"HasErrorsOnActivate":false}