<back to all web services

SpecificListsGetRequest

The following routes are available for this service:
PUT/RestApi/lists-api/items
namespace Telerik.Sitefinity.Frontend.Services.ListsService.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type SpecificListsGetRequest() = 
        member val Ids:Guid[] = [||] with get,set
        member val Provider:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type Status() = 
        [<DataMember>]
        member val Text:String = null with get,set

        [<DataMember>]
        member val PrimaryProvider:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type WcfContentLifecycleStatus() = 
        [<DataMember>]
        member val IsPublished:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Message:String = null with get,set

        [<DataMember>]
        member val LockedByUsername:String = null with get,set

        [<DataMember>]
        member val IsAdmin:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val IsLocked:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val IsLockedByMe:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val SupportsContentLifecycle:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val ErrorMessage:String = null with get,set

        [<DataMember>]
        member val LockedSince:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val LastModified:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val LastModifiedBy:String = null with get,set

        [<DataMember>]
        member val PublicationDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val WorkflowStatus:String = null with get,set

        [<DataMember>]
        member val HasLiveVersion:Boolean = new Boolean() with get,set

    type WorkflowVisualType =
        | Button = 0
        | Link = 1
        | Label = 2

    [<DataContract>]
    [<AllowNullLiteral>]
    type WorkflowVisualElement() = 
        [<DataMember>]
        member val Title:String = null with get,set

        [<DataMember>]
        member val OperationName:String = null with get,set

        [<DataMember>]
        member val ArgumentDialogName:String = null with get,set

        [<DataMember>]
        member val VisualType:WorkflowVisualType = new WorkflowVisualType() with get,set

        [<DataMember>]
        member val DecisionType:String = null with get,set

        [<DataMember>]
        member val PersistOnDecision:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val ClosesForm:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val ContentCommandName:String = null with get,set

        [<DataMember>]
        member val CssClass:String = null with get,set

        [<DataMember>]
        member val Ordinal:Int32 = new Int32() with get,set

        [<DataMember>]
        member val WarningMessage:String = null with get,set

        [<DataMember>]
        member val RunAsUICommand:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Parameters:Hashtable = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type WcfItemBase() = 
        class end

    [<DataContract>]
    [<AllowNullLiteral>]
    type WcfChange() = 
        inherit WcfItemBase()
        [<DataMember>]
        member val Id:Guid = new Guid() with get,set

        [<DataMember>]
        member val NextVersionNumber:Int32 = new Int32() with get,set

        [<DataMember>]
        member val PrevVersionNumber:Int32 = new Int32() with get,set

        [<DataMember>]
        member val ItemId:Guid = new Guid() with get,set

        [<DataMember>]
        member val VersionNumber:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Version:String = null with get,set

        [<DataMember>]
        member val Owner:Guid = new Guid() with get,set

        [<DataMember>]
        member val Comment:String = null with get,set

        [<DataMember>]
        member val Label:String = null with get,set

        [<DataMember>]
        member val ChangeType:String = null with get,set

        [<DataMember>]
        member val IsPublishedVersion:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val IsLastPublishedVersion:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val ChangeDescription:String = null with get,set

        [<DataMember>]
        member val LastModified:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val DateCreated:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val CreatedByUserName:String = null with get,set

        [<DataMember>]
        member val PreviousId:String = null with get,set

        [<DataMember>]
        member val NextId:String = null with get,set

        [<DataMember>]
        member val Metadata:String = null with get,set

        [<DataMember>]
        member val AdditionalInfo:String = null with get,set

        [<DataMember>]
        member val Culture:String = null with get,set

        [<DataMember>]
        member val AvailableLanguages:IList<String> = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type WcfApprovalTrackingRecord() = 
        [<DataMember>]
        member val DateCreated:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val Note:String = null with get,set

        [<DataMember>]
        member val Status:String = null with get,set

        [<DataMember>]
        member val UIStatus:String = null with get,set

        [<DataMember>]
        member val UserName:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ContentViewModelBase() = 
        [<DataMember>]
        member val ParentUrl:String = null with get,set

        [<DataMember>]
        member val IsEditable:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val IsDeletable:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val IsUnlockable:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val UIStatus:String = null with get,set

        [<DataMember>]
        member val AdditionalStatus:Status = null with get,set

        [<DataMember>]
        member val ItemsCount:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Id:Guid = new Guid() with get,set

        [<DataMember>]
        member val LiveContentId:Nullable<Guid> = new Nullable<Guid>() with get,set

        [<DataMember>]
        member val Title:String = null with get,set

        [<DataMember>]
        member val Owner:String = null with get,set

        [<DataMember>]
        member val Author:String = null with get,set

        [<DataMember>]
        member val DateCreated:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val DateModified:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val PublicationDate:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val ProviderName:String = null with get,set

        [<DataMember>]
        member val ExpirationDate:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val Status:String = null with get,set

        [<DataMember>]
        member val CommentsCount:Int32 = new Int32() with get,set

        [<DataMember>]
        member val LifecycleStatus:WcfContentLifecycleStatus = null with get,set

        [<DataMember>]
        member val WorkflowOperations:IList<WorkflowVisualElement> = null with get,set

        [<DataMember>]
        member val VersionInfo:WcfChange = null with get,set

        [<DataMember>]
        member val DefaultPageId:Nullable<Guid> = new Nullable<Guid>() with get,set

        [<DataMember>]
        member val LastApprovalTrackingRecord:WcfApprovalTrackingRecord = null with get,set

        [<DataMember>]
        member val Version:Int32 = new Int32() with get,set

        [<DataMember>]
        member val AvailableLanguages:String[] = [||] with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type HierarchicalContentViewModelBase() = 
        inherit ContentViewModelBase()
        [<DataMember>]
        member val Url:String = null with get,set

    [<AllowNullLiteral>]
    type ListViewModel() = 
        inherit HierarchicalContentViewModelBase()
        [<DataMember>]
        member val ListItemCount:Int32 = new Int32() with get,set

        [<DataMember>]
        member val LastItemDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type CollectionContext<ListViewModel>() = 
        [<DataMember>]
        member val TotalCount:Int32 = new Int32() with get,set

        [<DataMember>]
        member val IsGeneric:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Context:IDictionary<String, String> = null with get,set

        [<DataMember>]
        member val Items:IEnumerable<ListViewModel> = null with get,set

F# 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":[]}