<back to all web services

SpecificListsGetRequest

The following routes are available for this service:
PUT/RestApi/lists-api/items
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Telerik.Sitefinity.Frontend.Services.ListsService.DTO;
using Telerik.Sitefinity.Web.Services;
using Telerik.Sitefinity.Modules.Lists.Web.Services.Data;
using Telerik.Sitefinity.Modules;
using Telerik.Sitefinity.Services;
using Telerik.Sitefinity.Workflow.Services.Data;
using Telerik.Sitefinity.Workflow.UI;
using Telerik.Sitefinity.Versioning.Web.Services;
using Telerik.Sitefinity.Model;

namespace Telerik.Sitefinity.Frontend.Services.ListsService.DTO
{
    public partial class SpecificListsGetRequest
    {
        public SpecificListsGetRequest()
        {
            Ids = new Guid[]{};
        }

        public virtual Guid[] Ids { get; set; }
        public virtual string Provider { get; set; }
    }

}

namespace Telerik.Sitefinity.Model
{
    [DataContract]
    public partial class WcfItemBase
    {
    }

}

namespace Telerik.Sitefinity.Modules
{
    [DataContract]
    public partial class ContentViewModelBase
        : ILocalizable
    {
        public ContentViewModelBase()
        {
            AvailableLanguages = new string[]{};
        }

        [DataMember]
        public virtual string ParentUrl { get; set; }

        [DataMember]
        public virtual bool IsEditable { get; set; }

        [DataMember]
        public virtual bool IsDeletable { get; set; }

        [DataMember]
        public virtual bool IsUnlockable { get; set; }

        [DataMember]
        public virtual string UIStatus { get; set; }

        [DataMember]
        public virtual Status AdditionalStatus { get; set; }

        [DataMember]
        public virtual int ItemsCount { get; set; }

        [DataMember]
        public virtual Guid Id { get; set; }

        [DataMember]
        public virtual Guid? LiveContentId { get; set; }

        [DataMember]
        public virtual string Title { get; set; }

        [DataMember]
        public virtual string Owner { get; set; }

        [DataMember]
        public virtual string Author { get; set; }

        [DataMember]
        public virtual DateTime DateCreated { get; set; }

        [DataMember]
        public virtual DateTime DateModified { get; set; }

        [DataMember]
        public virtual DateTime PublicationDate { get; set; }

        [DataMember]
        public virtual string ProviderName { get; set; }

        [DataMember]
        public virtual DateTime ExpirationDate { get; set; }

        [DataMember]
        public virtual string Status { get; set; }

        [DataMember]
        public virtual int CommentsCount { get; set; }

        [DataMember]
        public virtual WcfContentLifecycleStatus LifecycleStatus { get; set; }

        [DataMember]
        public virtual IList<WorkflowVisualElement> WorkflowOperations { get; set; }

        [DataMember]
        public virtual WcfChange VersionInfo { get; set; }

        [DataMember]
        public virtual Guid? DefaultPageId { get; set; }

        [DataMember]
        public virtual WcfApprovalTrackingRecord LastApprovalTrackingRecord { get; set; }

        [DataMember]
        public virtual int Version { get; set; }

        [DataMember]
        public virtual string[] AvailableLanguages { get; set; }
    }

    [DataContract]
    public partial class HierarchicalContentViewModelBase
        : ContentViewModelBase
    {
        [DataMember]
        public virtual string Url { get; set; }
    }

}

namespace Telerik.Sitefinity.Modules.Lists.Web.Services.Data
{
    public partial class ListViewModel
        : HierarchicalContentViewModelBase
    {
        [DataMember]
        public virtual int ListItemCount { get; set; }

        [DataMember]
        public virtual DateTime? LastItemDate { get; set; }
    }

}

namespace Telerik.Sitefinity.Services
{
    [DataContract]
    public partial class Status
    {
        [DataMember]
        public virtual string Text { get; set; }

        [DataMember]
        public virtual string PrimaryProvider { get; set; }
    }

}

namespace Telerik.Sitefinity.Versioning.Web.Services
{
    [DataContract]
    public partial class WcfChange
        : WcfItemBase
    {
        [DataMember]
        public virtual Guid Id { get; set; }

        [DataMember]
        public virtual int NextVersionNumber { get; set; }

        [DataMember]
        public virtual int PrevVersionNumber { get; set; }

        [DataMember]
        public virtual Guid ItemId { get; set; }

        [DataMember]
        public virtual int VersionNumber { get; set; }

        [DataMember]
        public virtual string Version { get; set; }

        [DataMember]
        public virtual Guid Owner { get; set; }

        [DataMember]
        public virtual string Comment { get; set; }

        [DataMember]
        public virtual string Label { get; set; }

        [DataMember]
        public virtual string ChangeType { get; set; }

        [DataMember]
        public virtual bool IsPublishedVersion { get; set; }

        [DataMember]
        public virtual bool IsLastPublishedVersion { get; set; }

        [DataMember]
        public virtual string ChangeDescription { get; set; }

        [DataMember]
        public virtual DateTime LastModified { get; set; }

        [DataMember]
        public virtual DateTime DateCreated { get; set; }

        [DataMember]
        public virtual string CreatedByUserName { get; set; }

        [DataMember]
        public virtual string PreviousId { get; set; }

        [DataMember]
        public virtual string NextId { get; set; }

        [DataMember]
        public virtual string Metadata { get; set; }

        [DataMember]
        public virtual string AdditionalInfo { get; set; }

        [DataMember]
        public virtual string Culture { get; set; }

        [DataMember]
        public virtual IList<string> AvailableLanguages { get; set; }
    }

}

namespace Telerik.Sitefinity.Web.Services
{
    [DataContract]
    public partial class CollectionContext<ListViewModel>
    {
        [DataMember]
        public virtual int TotalCount { get; set; }

        [DataMember]
        public virtual bool IsGeneric { get; set; }

        [DataMember]
        public virtual IDictionary<string, string> Context { get; set; }

        [DataMember]
        public virtual IEnumerable<ListViewModel> Items { get; set; }
    }

    [DataContract]
    public partial class WcfApprovalTrackingRecord
    {
        [DataMember]
        public virtual DateTime DateCreated { get; set; }

        [DataMember]
        public virtual string Note { get; set; }

        [DataMember]
        public virtual string Status { get; set; }

        [DataMember]
        public virtual string UIStatus { get; set; }

        [DataMember]
        public virtual string UserName { get; set; }
    }

    [DataContract]
    public partial class WcfContentLifecycleStatus
    {
        [DataMember]
        public virtual bool IsPublished { get; set; }

        [DataMember]
        public virtual string Message { get; set; }

        [DataMember]
        public virtual string LockedByUsername { get; set; }

        [DataMember]
        public virtual bool IsAdmin { get; set; }

        [DataMember]
        public virtual bool IsLocked { get; set; }

        [DataMember]
        public virtual bool IsLockedByMe { get; set; }

        [DataMember]
        public virtual bool SupportsContentLifecycle { get; set; }

        [DataMember]
        public virtual string ErrorMessage { get; set; }

        [DataMember]
        public virtual DateTime? LockedSince { get; set; }

        [DataMember]
        public virtual DateTime? LastModified { get; set; }

        [DataMember]
        public virtual string LastModifiedBy { get; set; }

        [DataMember]
        public virtual DateTime? PublicationDate { get; set; }

        [DataMember]
        public virtual string WorkflowStatus { get; set; }

        [DataMember]
        public virtual bool HasLiveVersion { get; set; }
    }

}

namespace Telerik.Sitefinity.Workflow.Services.Data
{
    [DataContract]
    public partial class WorkflowVisualElement
    {
        [DataMember]
        public virtual string Title { get; set; }

        [DataMember]
        public virtual string OperationName { get; set; }

        [DataMember]
        public virtual string ArgumentDialogName { get; set; }

        [DataMember]
        public virtual WorkflowVisualType VisualType { get; set; }

        [DataMember]
        public virtual string DecisionType { get; set; }

        [DataMember]
        public virtual bool PersistOnDecision { get; set; }

        [DataMember]
        public virtual bool ClosesForm { get; set; }

        [DataMember]
        public virtual string ContentCommandName { get; set; }

        [DataMember]
        public virtual string CssClass { get; set; }

        [DataMember]
        public virtual int Ordinal { get; set; }

        [DataMember]
        public virtual string WarningMessage { get; set; }

        [DataMember]
        public virtual bool RunAsUICommand { get; set; }

        [DataMember]
        public virtual Hashtable Parameters { get; set; }
    }

}

namespace Telerik.Sitefinity.Workflow.UI
{
    public enum WorkflowVisualType
    {
        Button,
        Link,
        Label,
    }

}

C# SpecificListsGetRequest 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.

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

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

{"TotalCount":0,"IsGeneric":false,"Items":[]}