<back to all web services

AddonMessage

The following routes are available for this service:
GET POST/RestApi/Sitefinity/packaging/add-on
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class AddonMessage
    {
        public UUID Id = null;
        public Boolean IncludeContent = null;
        public Boolean Deactivate = null;
        
        public UUID getId() { return Id; }
        public AddonMessage setId(UUID value) { this.Id = value; return this; }
        public Boolean isIncludeContent() { return IncludeContent; }
        public AddonMessage setIncludeContent(Boolean value) { this.IncludeContent = value; return this; }
        public Boolean isDeactivate() { return Deactivate; }
        public AddonMessage setDeactivate(Boolean value) { this.Deactivate = value; return this; }
    }

    public static class AddonInfo
    {
        public UUID Id = null;
        public String Name = null;
        public Boolean IsActive = null;
        public String Description = null;
        public Boolean IsDataImported = null;
        public String Version = null;
        public String Author = null;
        public String DataImportedToSiteName = null;
        public ArrayList<AddOnEntry> Entries = null;
        public Boolean HasErrorsOnContentImport = null;
        public Boolean HasErrorsOnStructureImport = null;
        public Boolean HasErrorsOnActivate = null;
        
        public UUID getId() { return Id; }
        public AddonInfo setId(UUID value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public AddonInfo setName(String value) { this.Name = value; return this; }
        public Boolean getIsActive() { return IsActive; }
        public AddonInfo setIsActive(Boolean value) { this.IsActive = value; return this; }
        public String getDescription() { return Description; }
        public AddonInfo setDescription(String value) { this.Description = value; return this; }
        public Boolean getIsDataImported() { return IsDataImported; }
        public AddonInfo setIsDataImported(Boolean value) { this.IsDataImported = value; return this; }
        public String getVersion() { return Version; }
        public AddonInfo setVersion(String value) { this.Version = value; return this; }
        public String getAuthor() { return Author; }
        public AddonInfo setAuthor(String value) { this.Author = value; return this; }
        public String getDataImportedToSiteName() { return DataImportedToSiteName; }
        public AddonInfo setDataImportedToSiteName(String value) { this.DataImportedToSiteName = value; return this; }
        public ArrayList<AddOnEntry> getEntries() { return Entries; }
        public AddonInfo setEntries(ArrayList<AddOnEntry> value) { this.Entries = value; return this; }
        public Boolean isHasErrorsOnContentImport() { return HasErrorsOnContentImport; }
        public AddonInfo setHasErrorsOnContentImport(Boolean value) { this.HasErrorsOnContentImport = value; return this; }
        public Boolean isHasErrorsOnStructureImport() { return HasErrorsOnStructureImport; }
        public AddonInfo setHasErrorsOnStructureImport(Boolean value) { this.HasErrorsOnStructureImport = value; return this; }
        public Boolean isHasErrorsOnActivate() { return HasErrorsOnActivate; }
        public AddonInfo setHasErrorsOnActivate(Boolean value) { this.HasErrorsOnActivate = value; return this; }
    }

    public static class AddOnEntry
    {
        public String DisplayName = null;
        public Integer Count = null;
        public AddOnEntryType AddonEntryType = null;
        
        public String getDisplayName() { return DisplayName; }
        public AddOnEntry setDisplayName(String value) { this.DisplayName = value; return this; }
        public Integer getCount() { return Count; }
        public AddOnEntry setCount(Integer value) { this.Count = value; return this; }
        public AddOnEntryType getAddonEntryType() { return AddonEntryType; }
        public AddOnEntry setAddonEntryType(AddOnEntryType value) { this.AddonEntryType = value; return this; }
    }

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

}

Java AddonMessage DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

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

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