<back to all web services

SpecificListsGetRequest

The following routes are available for this service:
PUT/RestApi/lists-api/items
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class SpecificListsGetRequest
    {
        public ArrayList<UUID> Ids = null;
        public String Provider = null;
        
        public ArrayList<UUID> getIds() { return Ids; }
        public SpecificListsGetRequest setIds(ArrayList<UUID> value) { this.Ids = value; return this; }
        public String getProvider() { return Provider; }
        public SpecificListsGetRequest setProvider(String value) { this.Provider = value; return this; }
    }

    @DataContract
    public static class CollectionContext<ListViewModel>
    {
        @DataMember
        public Integer TotalCount = null;

        @DataMember
        public Boolean IsGeneric = null;

        @DataMember
        public HashMap<String,String> Context = null;

        @DataMember
        public ArrayList<ListViewModel> Items = null;
        
        public Integer getTotalCount() { return TotalCount; }
        public CollectionContext<ListViewModel> setTotalCount(Integer value) { this.TotalCount = value; return this; }
        public Boolean getIsGeneric() { return IsGeneric; }
        public CollectionContext<ListViewModel> setIsGeneric(Boolean value) { this.IsGeneric = value; return this; }
        public HashMap<String,String> getContext() { return Context; }
        public CollectionContext<ListViewModel> setContext(HashMap<String,String> value) { this.Context = value; return this; }
        public ArrayList<ListViewModel> getItems() { return Items; }
        public CollectionContext<ListViewModel> setItems(ArrayList<ListViewModel> value) { this.Items = value; return this; }
    }

    public static class ListViewModel extends HierarchicalContentViewModelBase
    {
        @DataMember
        public Integer ListItemCount = null;

        @DataMember
        public Date LastItemDate = null;
        
        public Integer getListItemCount() { return ListItemCount; }
        public ListViewModel setListItemCount(Integer value) { this.ListItemCount = value; return this; }
        public Date getLastItemDate() { return LastItemDate; }
        public ListViewModel setLastItemDate(Date value) { this.LastItemDate = value; return this; }
    }

    @DataContract
    public static class HierarchicalContentViewModelBase extends ContentViewModelBase
    {
        @DataMember
        public String Url = null;
        
        public String getUrl() { return Url; }
        public HierarchicalContentViewModelBase setUrl(String value) { this.Url = value; return this; }
    }

    @DataContract
    public static class ContentViewModelBase implements ILocalizable
    {
        @DataMember
        public String ParentUrl = null;

        @DataMember
        public Boolean IsEditable = null;

        @DataMember
        public Boolean IsDeletable = null;

        @DataMember
        public Boolean IsUnlockable = null;

        @DataMember
        public String UIStatus = null;

        @DataMember
        public Status AdditionalStatus = null;

        @DataMember
        public Integer ItemsCount = null;

        @DataMember
        public UUID Id = null;

        @DataMember
        public UUID LiveContentId = null;

        @DataMember
        public String Title = null;

        @DataMember
        public String Owner = null;

        @DataMember
        public String Author = null;

        @DataMember
        public Date DateCreated = null;

        @DataMember
        public Date DateModified = null;

        @DataMember
        public Date PublicationDate = null;

        @DataMember
        public String ProviderName = null;

        @DataMember
        public Date ExpirationDate = null;

        @DataMember
        public String Status = null;

        @DataMember
        public Integer CommentsCount = null;

        @DataMember
        public WcfContentLifecycleStatus LifecycleStatus = null;

        @DataMember
        public IList<WorkflowVisualElement> WorkflowOperations = null;

        @DataMember
        public WcfChange VersionInfo = null;

        @DataMember
        public UUID DefaultPageId = null;

        @DataMember
        public WcfApprovalTrackingRecord LastApprovalTrackingRecord = null;

        @DataMember
        public Integer Version = null;

        @DataMember
        public ArrayList<String> AvailableLanguages = null;
        
        public String getParentUrl() { return ParentUrl; }
        public ContentViewModelBase setParentUrl(String value) { this.ParentUrl = value; return this; }
        public Boolean getIsEditable() { return IsEditable; }
        public ContentViewModelBase setIsEditable(Boolean value) { this.IsEditable = value; return this; }
        public Boolean getIsDeletable() { return IsDeletable; }
        public ContentViewModelBase setIsDeletable(Boolean value) { this.IsDeletable = value; return this; }
        public Boolean getIsUnlockable() { return IsUnlockable; }
        public ContentViewModelBase setIsUnlockable(Boolean value) { this.IsUnlockable = value; return this; }
        public String getUiStatus() { return UIStatus; }
        public ContentViewModelBase setUiStatus(String value) { this.UIStatus = value; return this; }
        public Status getAdditionalStatus() { return AdditionalStatus; }
        public ContentViewModelBase setAdditionalStatus(Status value) { this.AdditionalStatus = value; return this; }
        public Integer getItemsCount() { return ItemsCount; }
        public ContentViewModelBase setItemsCount(Integer value) { this.ItemsCount = value; return this; }
        public UUID getId() { return Id; }
        public ContentViewModelBase setId(UUID value) { this.Id = value; return this; }
        public UUID getLiveContentId() { return LiveContentId; }
        public ContentViewModelBase setLiveContentId(UUID value) { this.LiveContentId = value; return this; }
        public String getTitle() { return Title; }
        public ContentViewModelBase setTitle(String value) { this.Title = value; return this; }
        public String getOwner() { return Owner; }
        public ContentViewModelBase setOwner(String value) { this.Owner = value; return this; }
        public String getAuthor() { return Author; }
        public ContentViewModelBase setAuthor(String value) { this.Author = value; return this; }
        public Date getDateCreated() { return DateCreated; }
        public ContentViewModelBase setDateCreated(Date value) { this.DateCreated = value; return this; }
        public Date getDateModified() { return DateModified; }
        public ContentViewModelBase setDateModified(Date value) { this.DateModified = value; return this; }
        public Date getPublicationDate() { return PublicationDate; }
        public ContentViewModelBase setPublicationDate(Date value) { this.PublicationDate = value; return this; }
        public String getProviderName() { return ProviderName; }
        public ContentViewModelBase setProviderName(String value) { this.ProviderName = value; return this; }
        public Date getExpirationDate() { return ExpirationDate; }
        public ContentViewModelBase setExpirationDate(Date value) { this.ExpirationDate = value; return this; }
        public String getStatus() { return Status; }
        public ContentViewModelBase setStatus(String value) { this.Status = value; return this; }
        public Integer getCommentsCount() { return CommentsCount; }
        public ContentViewModelBase setCommentsCount(Integer value) { this.CommentsCount = value; return this; }
        public WcfContentLifecycleStatus getLifecycleStatus() { return LifecycleStatus; }
        public ContentViewModelBase setLifecycleStatus(WcfContentLifecycleStatus value) { this.LifecycleStatus = value; return this; }
        public IList<WorkflowVisualElement> getWorkflowOperations() { return WorkflowOperations; }
        public ContentViewModelBase setWorkflowOperations(IList<WorkflowVisualElement> value) { this.WorkflowOperations = value; return this; }
        public WcfChange getVersionInfo() { return VersionInfo; }
        public ContentViewModelBase setVersionInfo(WcfChange value) { this.VersionInfo = value; return this; }
        public UUID getDefaultPageId() { return DefaultPageId; }
        public ContentViewModelBase setDefaultPageId(UUID value) { this.DefaultPageId = value; return this; }
        public WcfApprovalTrackingRecord getLastApprovalTrackingRecord() { return LastApprovalTrackingRecord; }
        public ContentViewModelBase setLastApprovalTrackingRecord(WcfApprovalTrackingRecord value) { this.LastApprovalTrackingRecord = value; return this; }
        public Integer getVersion() { return Version; }
        public ContentViewModelBase setVersion(Integer value) { this.Version = value; return this; }
        public ArrayList<String> getAvailableLanguages() { return AvailableLanguages; }
        public ContentViewModelBase setAvailableLanguages(ArrayList<String> value) { this.AvailableLanguages = value; return this; }
    }

    @DataContract
    public static class Status
    {
        @DataMember
        public String Text = null;

        @DataMember
        public String PrimaryProvider = null;
        
        public String getText() { return Text; }
        public Status setText(String value) { this.Text = value; return this; }
        public String getPrimaryProvider() { return PrimaryProvider; }
        public Status setPrimaryProvider(String value) { this.PrimaryProvider = value; return this; }
    }

    @DataContract
    public static class WcfContentLifecycleStatus
    {
        @DataMember
        public Boolean IsPublished = null;

        @DataMember
        public String Message = null;

        @DataMember
        public String LockedByUsername = null;

        @DataMember
        public Boolean IsAdmin = null;

        @DataMember
        public Boolean IsLocked = null;

        @DataMember
        public Boolean IsLockedByMe = null;

        @DataMember
        public Boolean SupportsContentLifecycle = null;

        @DataMember
        public String ErrorMessage = null;

        @DataMember
        public Date LockedSince = null;

        @DataMember
        public Date LastModified = null;

        @DataMember
        public String LastModifiedBy = null;

        @DataMember
        public Date PublicationDate = null;

        @DataMember
        public String WorkflowStatus = null;

        @DataMember
        public Boolean HasLiveVersion = null;
        
        public Boolean getIsPublished() { return IsPublished; }
        public WcfContentLifecycleStatus setIsPublished(Boolean value) { this.IsPublished = value; return this; }
        public String getMessage() { return Message; }
        public WcfContentLifecycleStatus setMessage(String value) { this.Message = value; return this; }
        public String getLockedByUsername() { return LockedByUsername; }
        public WcfContentLifecycleStatus setLockedByUsername(String value) { this.LockedByUsername = value; return this; }
        public Boolean getIsAdmin() { return IsAdmin; }
        public WcfContentLifecycleStatus setIsAdmin(Boolean value) { this.IsAdmin = value; return this; }
        public Boolean getIsLocked() { return IsLocked; }
        public WcfContentLifecycleStatus setIsLocked(Boolean value) { this.IsLocked = value; return this; }
        public Boolean getIsLockedByMe() { return IsLockedByMe; }
        public WcfContentLifecycleStatus setIsLockedByMe(Boolean value) { this.IsLockedByMe = value; return this; }
        public Boolean isSupportsContentLifecycle() { return SupportsContentLifecycle; }
        public WcfContentLifecycleStatus setSupportsContentLifecycle(Boolean value) { this.SupportsContentLifecycle = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public WcfContentLifecycleStatus setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public Date getLockedSince() { return LockedSince; }
        public WcfContentLifecycleStatus setLockedSince(Date value) { this.LockedSince = value; return this; }
        public Date getLastModified() { return LastModified; }
        public WcfContentLifecycleStatus setLastModified(Date value) { this.LastModified = value; return this; }
        public String getLastModifiedBy() { return LastModifiedBy; }
        public WcfContentLifecycleStatus setLastModifiedBy(String value) { this.LastModifiedBy = value; return this; }
        public Date getPublicationDate() { return PublicationDate; }
        public WcfContentLifecycleStatus setPublicationDate(Date value) { this.PublicationDate = value; return this; }
        public String getWorkflowStatus() { return WorkflowStatus; }
        public WcfContentLifecycleStatus setWorkflowStatus(String value) { this.WorkflowStatus = value; return this; }
        public Boolean isHasLiveVersion() { return HasLiveVersion; }
        public WcfContentLifecycleStatus setHasLiveVersion(Boolean value) { this.HasLiveVersion = value; return this; }
    }

    @DataContract
    public static class WorkflowVisualElement
    {
        @DataMember
        public String Title = null;

        @DataMember
        public String OperationName = null;

        @DataMember
        public String ArgumentDialogName = null;

        @DataMember
        public WorkflowVisualType VisualType = null;

        @DataMember
        public String DecisionType = null;

        @DataMember
        public Boolean PersistOnDecision = null;

        @DataMember
        public Boolean ClosesForm = null;

        @DataMember
        public String ContentCommandName = null;

        @DataMember
        public String CssClass = null;

        @DataMember
        public Integer Ordinal = null;

        @DataMember
        public String WarningMessage = null;

        @DataMember
        public Boolean RunAsUICommand = null;

        @DataMember
        public Hashtable Parameters = null;
        
        public String getTitle() { return Title; }
        public WorkflowVisualElement setTitle(String value) { this.Title = value; return this; }
        public String getOperationName() { return OperationName; }
        public WorkflowVisualElement setOperationName(String value) { this.OperationName = value; return this; }
        public String getArgumentDialogName() { return ArgumentDialogName; }
        public WorkflowVisualElement setArgumentDialogName(String value) { this.ArgumentDialogName = value; return this; }
        public WorkflowVisualType getVisualType() { return VisualType; }
        public WorkflowVisualElement setVisualType(WorkflowVisualType value) { this.VisualType = value; return this; }
        public String getDecisionType() { return DecisionType; }
        public WorkflowVisualElement setDecisionType(String value) { this.DecisionType = value; return this; }
        public Boolean isPersistOnDecision() { return PersistOnDecision; }
        public WorkflowVisualElement setPersistOnDecision(Boolean value) { this.PersistOnDecision = value; return this; }
        public Boolean isClosesForm() { return ClosesForm; }
        public WorkflowVisualElement setClosesForm(Boolean value) { this.ClosesForm = value; return this; }
        public String getContentCommandName() { return ContentCommandName; }
        public WorkflowVisualElement setContentCommandName(String value) { this.ContentCommandName = value; return this; }
        public String getCssClass() { return CssClass; }
        public WorkflowVisualElement setCssClass(String value) { this.CssClass = value; return this; }
        public Integer getOrdinal() { return Ordinal; }
        public WorkflowVisualElement setOrdinal(Integer value) { this.Ordinal = value; return this; }
        public String getWarningMessage() { return WarningMessage; }
        public WorkflowVisualElement setWarningMessage(String value) { this.WarningMessage = value; return this; }
        public Boolean isRunAsUICommand() { return RunAsUICommand; }
        public WorkflowVisualElement setRunAsUICommand(Boolean value) { this.RunAsUICommand = value; return this; }
        public Hashtable getParameters() { return Parameters; }
        public WorkflowVisualElement setParameters(Hashtable value) { this.Parameters = value; return this; }
    }

    public static enum WorkflowVisualType
    {
        Button,
        Link,
        Label;
    }

    @DataContract
    public static class WcfChange extends WcfItemBase
    {
        @DataMember
        public UUID Id = null;

        @DataMember
        public Integer NextVersionNumber = null;

        @DataMember
        public Integer PrevVersionNumber = null;

        @DataMember
        public UUID ItemId = null;

        @DataMember
        public Integer VersionNumber = null;

        @DataMember
        public String Version = null;

        @DataMember
        public UUID Owner = null;

        @DataMember
        public String Comment = null;

        @DataMember
        public String Label = null;

        @DataMember
        public String ChangeType = null;

        @DataMember
        public Boolean IsPublishedVersion = null;

        @DataMember
        public Boolean IsLastPublishedVersion = null;

        @DataMember
        public String ChangeDescription = null;

        @DataMember
        public Date LastModified = null;

        @DataMember
        public Date DateCreated = null;

        @DataMember
        public String CreatedByUserName = null;

        @DataMember
        public String PreviousId = null;

        @DataMember
        public String NextId = null;

        @DataMember
        public String Metadata = null;

        @DataMember
        public String AdditionalInfo = null;

        @DataMember
        public String Culture = null;

        @DataMember
        public IList<String> AvailableLanguages = null;
        
        public UUID getId() { return Id; }
        public WcfChange setId(UUID value) { this.Id = value; return this; }
        public Integer getNextVersionNumber() { return NextVersionNumber; }
        public WcfChange setNextVersionNumber(Integer value) { this.NextVersionNumber = value; return this; }
        public Integer getPrevVersionNumber() { return PrevVersionNumber; }
        public WcfChange setPrevVersionNumber(Integer value) { this.PrevVersionNumber = value; return this; }
        public UUID getItemId() { return ItemId; }
        public WcfChange setItemId(UUID value) { this.ItemId = value; return this; }
        public Integer getVersionNumber() { return VersionNumber; }
        public WcfChange setVersionNumber(Integer value) { this.VersionNumber = value; return this; }
        public String getVersion() { return Version; }
        public WcfChange setVersion(String value) { this.Version = value; return this; }
        public UUID getOwner() { return Owner; }
        public WcfChange setOwner(UUID value) { this.Owner = value; return this; }
        public String getComment() { return Comment; }
        public WcfChange setComment(String value) { this.Comment = value; return this; }
        public String getLabel() { return Label; }
        public WcfChange setLabel(String value) { this.Label = value; return this; }
        public String getChangeType() { return ChangeType; }
        public WcfChange setChangeType(String value) { this.ChangeType = value; return this; }
        public Boolean getIsPublishedVersion() { return IsPublishedVersion; }
        public WcfChange setIsPublishedVersion(Boolean value) { this.IsPublishedVersion = value; return this; }
        public Boolean getIsLastPublishedVersion() { return IsLastPublishedVersion; }
        public WcfChange setIsLastPublishedVersion(Boolean value) { this.IsLastPublishedVersion = value; return this; }
        public String getChangeDescription() { return ChangeDescription; }
        public WcfChange setChangeDescription(String value) { this.ChangeDescription = value; return this; }
        public Date getLastModified() { return LastModified; }
        public WcfChange setLastModified(Date value) { this.LastModified = value; return this; }
        public Date getDateCreated() { return DateCreated; }
        public WcfChange setDateCreated(Date value) { this.DateCreated = value; return this; }
        public String getCreatedByUserName() { return CreatedByUserName; }
        public WcfChange setCreatedByUserName(String value) { this.CreatedByUserName = value; return this; }
        public String getPreviousId() { return PreviousId; }
        public WcfChange setPreviousId(String value) { this.PreviousId = value; return this; }
        public String getNextId() { return NextId; }
        public WcfChange setNextId(String value) { this.NextId = value; return this; }
        public String getMetadata() { return Metadata; }
        public WcfChange setMetadata(String value) { this.Metadata = value; return this; }
        public String getAdditionalInfo() { return AdditionalInfo; }
        public WcfChange setAdditionalInfo(String value) { this.AdditionalInfo = value; return this; }
        public String getCulture() { return Culture; }
        public WcfChange setCulture(String value) { this.Culture = value; return this; }
        public IList<String> getAvailableLanguages() { return AvailableLanguages; }
        public WcfChange setAvailableLanguages(IList<String> value) { this.AvailableLanguages = value; return this; }
    }

    @DataContract
    public static class WcfItemBase
    {
        
    }

    @DataContract
    public static class WcfApprovalTrackingRecord
    {
        @DataMember
        public Date DateCreated = null;

        @DataMember
        public String Note = null;

        @DataMember
        public String Status = null;

        @DataMember
        public String UIStatus = null;

        @DataMember
        public String UserName = null;
        
        public Date getDateCreated() { return DateCreated; }
        public WcfApprovalTrackingRecord setDateCreated(Date value) { this.DateCreated = value; return this; }
        public String getNote() { return Note; }
        public WcfApprovalTrackingRecord setNote(String value) { this.Note = value; return this; }
        public String getStatus() { return Status; }
        public WcfApprovalTrackingRecord setStatus(String value) { this.Status = value; return this; }
        public String getUiStatus() { return UIStatus; }
        public WcfApprovalTrackingRecord setUiStatus(String value) { this.UIStatus = value; return this; }
        public String getUserName() { return UserName; }
        public WcfApprovalTrackingRecord setUserName(String value) { this.UserName = value; return this; }
    }

}

Java SpecificListsGetRequest 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.

PUT /RestApi/lists-api/items HTTP/1.1 
Host: www.asg.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Ids: 
	[
		00000000-0000-0000-0000-000000000000
	],
	Provider: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TotalCount: 0,
	IsGeneric: False,
	Items: []
}