<back to all web services

SpecificListsGetRequest

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

Namespace Global

    Namespace Telerik.Sitefinity.Frontend.Services.ListsService.DTO

        Public Partial Class SpecificListsGetRequest
            Public Sub New()
                Ids = New Guid(){}
            End Sub

            Public Overridable Property Ids As Guid()
            Public Overridable Property Provider As String
        End Class
    End Namespace

    Namespace Telerik.Sitefinity.Model

        <DataContract>
        Public Partial Class WcfItemBase
        End Class
    End Namespace

    Namespace Telerik.Sitefinity.Modules

        <DataContract>
        Public Partial Class ContentViewModelBase
            Implements ILocalizable
            Public Sub New()
                AvailableLanguages = New String(){}
            End Sub

            <DataMember>
            Public Overridable Property ParentUrl As String

            <DataMember>
            Public Overridable Property IsEditable As Boolean

            <DataMember>
            Public Overridable Property IsDeletable As Boolean

            <DataMember>
            Public Overridable Property IsUnlockable As Boolean

            <DataMember>
            Public Overridable Property UIStatus As String

            <DataMember>
            Public Overridable Property AdditionalStatus As Status

            <DataMember>
            Public Overridable Property ItemsCount As Integer

            <DataMember>
            Public Overridable Property Id As Guid

            <DataMember>
            Public Overridable Property LiveContentId As Nullable(Of Guid)

            <DataMember>
            Public Overridable Property Title As String

            <DataMember>
            Public Overridable Property Owner As String

            <DataMember>
            Public Overridable Property Author As String

            <DataMember>
            Public Overridable Property DateCreated As Date

            <DataMember>
            Public Overridable Property DateModified As Date

            <DataMember>
            Public Overridable Property PublicationDate As Date

            <DataMember>
            Public Overridable Property ProviderName As String

            <DataMember>
            Public Overridable Property ExpirationDate As Date

            <DataMember>
            Public Overridable Property Status As String

            <DataMember>
            Public Overridable Property CommentsCount As Integer

            <DataMember>
            Public Overridable Property LifecycleStatus As WcfContentLifecycleStatus

            <DataMember>
            Public Overridable Property WorkflowOperations As IList(Of WorkflowVisualElement)

            <DataMember>
            Public Overridable Property VersionInfo As WcfChange

            <DataMember>
            Public Overridable Property DefaultPageId As Nullable(Of Guid)

            <DataMember>
            Public Overridable Property LastApprovalTrackingRecord As WcfApprovalTrackingRecord

            <DataMember>
            Public Overridable Property Version As Integer

            <DataMember>
            Public Overridable Property AvailableLanguages As String()
        End Class

        <DataContract>
        Public Partial Class HierarchicalContentViewModelBase
            Inherits ContentViewModelBase
            <DataMember>
            Public Overridable Property Url As String
        End Class
    End Namespace

    Namespace Telerik.Sitefinity.Modules.Lists.Web.Services.Data

        Public Partial Class ListViewModel
            Inherits HierarchicalContentViewModelBase
            <DataMember>
            Public Overridable Property ListItemCount As Integer

            <DataMember>
            Public Overridable Property LastItemDate As Nullable(Of Date)
        End Class
    End Namespace

    Namespace Telerik.Sitefinity.Services

        <DataContract>
        Public Partial Class Status
            <DataMember>
            Public Overridable Property Text As String

            <DataMember>
            Public Overridable Property PrimaryProvider As String
        End Class
    End Namespace

    Namespace Telerik.Sitefinity.Versioning.Web.Services

        <DataContract>
        Public Partial Class WcfChange
            Inherits WcfItemBase
            <DataMember>
            Public Overridable Property Id As Guid

            <DataMember>
            Public Overridable Property NextVersionNumber As Integer

            <DataMember>
            Public Overridable Property PrevVersionNumber As Integer

            <DataMember>
            Public Overridable Property ItemId As Guid

            <DataMember>
            Public Overridable Property VersionNumber As Integer

            <DataMember>
            Public Overridable Property Version As String

            <DataMember>
            Public Overridable Property Owner As Guid

            <DataMember>
            Public Overridable Property Comment As String

            <DataMember>
            Public Overridable Property Label As String

            <DataMember>
            Public Overridable Property ChangeType As String

            <DataMember>
            Public Overridable Property IsPublishedVersion As Boolean

            <DataMember>
            Public Overridable Property IsLastPublishedVersion As Boolean

            <DataMember>
            Public Overridable Property ChangeDescription As String

            <DataMember>
            Public Overridable Property LastModified As Date

            <DataMember>
            Public Overridable Property DateCreated As Date

            <DataMember>
            Public Overridable Property CreatedByUserName As String

            <DataMember>
            Public Overridable Property PreviousId As String

            <DataMember>
            Public Overridable Property NextId As String

            <DataMember>
            Public Overridable Property Metadata As String

            <DataMember>
            Public Overridable Property AdditionalInfo As String

            <DataMember>
            Public Overridable Property Culture As String

            <DataMember>
            Public Overridable Property AvailableLanguages As IList(Of String)
        End Class
    End Namespace

    Namespace Telerik.Sitefinity.Web.Services

        <DataContract>
        Public Partial Class CollectionContext(Of ListViewModel)
            <DataMember>
            Public Overridable Property TotalCount As Integer

            <DataMember>
            Public Overridable Property IsGeneric As Boolean

            <DataMember>
            Public Overridable Property Context As IDictionary(Of String, String)

            <DataMember>
            Public Overridable Property Items As IEnumerable(Of ListViewModel)
        End Class

        <DataContract>
        Public Partial Class WcfApprovalTrackingRecord
            <DataMember>
            Public Overridable Property DateCreated As Date

            <DataMember>
            Public Overridable Property Note As String

            <DataMember>
            Public Overridable Property Status As String

            <DataMember>
            Public Overridable Property UIStatus As String

            <DataMember>
            Public Overridable Property UserName As String
        End Class

        <DataContract>
        Public Partial Class WcfContentLifecycleStatus
            <DataMember>
            Public Overridable Property IsPublished As Boolean

            <DataMember>
            Public Overridable Property Message As String

            <DataMember>
            Public Overridable Property LockedByUsername As String

            <DataMember>
            Public Overridable Property IsAdmin As Boolean

            <DataMember>
            Public Overridable Property IsLocked As Boolean

            <DataMember>
            Public Overridable Property IsLockedByMe As Boolean

            <DataMember>
            Public Overridable Property SupportsContentLifecycle As Boolean

            <DataMember>
            Public Overridable Property ErrorMessage As String

            <DataMember>
            Public Overridable Property LockedSince As Nullable(Of Date)

            <DataMember>
            Public Overridable Property LastModified As Nullable(Of Date)

            <DataMember>
            Public Overridable Property LastModifiedBy As String

            <DataMember>
            Public Overridable Property PublicationDate As Nullable(Of Date)

            <DataMember>
            Public Overridable Property WorkflowStatus As String

            <DataMember>
            Public Overridable Property HasLiveVersion As Boolean
        End Class
    End Namespace

    Namespace Telerik.Sitefinity.Workflow.Services.Data

        <DataContract>
        Public Partial Class WorkflowVisualElement
            <DataMember>
            Public Overridable Property Title As String

            <DataMember>
            Public Overridable Property OperationName As String

            <DataMember>
            Public Overridable Property ArgumentDialogName As String

            <DataMember>
            Public Overridable Property VisualType As WorkflowVisualType

            <DataMember>
            Public Overridable Property DecisionType As String

            <DataMember>
            Public Overridable Property PersistOnDecision As Boolean

            <DataMember>
            Public Overridable Property ClosesForm As Boolean

            <DataMember>
            Public Overridable Property ContentCommandName As String

            <DataMember>
            Public Overridable Property CssClass As String

            <DataMember>
            Public Overridable Property Ordinal As Integer

            <DataMember>
            Public Overridable Property WarningMessage As String

            <DataMember>
            Public Overridable Property RunAsUICommand As Boolean

            <DataMember>
            Public Overridable Property Parameters As Hashtable
        End Class
    End Namespace

    Namespace Telerik.Sitefinity.Workflow.UI

        Public Enum WorkflowVisualType
            Button
            Link
            Label
        End Enum
    End Namespace
End Namespace

VB.NET 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: []
}