<back to all web services

ContainerInfoMessage

The following routes are available for this service:
POST/RestApi/sitefinity/inlineediting/containersInfo

export class LifecycleStatusModel
{
    public DisplayStatus: string;
    public IsAdmin: boolean;
    public IsEditable: boolean;
    public IsStatusEditable: boolean;
    public IsLocked: boolean;
    public IsPublished: boolean;
    public IsLockedByMe: boolean;
    public LockedByUsername: string;
    public WorkflowStatus: string;

    public constructor(init?: Partial<LifecycleStatusModel>) { (Object as any).assign(this, init); }
}

export class FieldModel
{
    public Name: string;
    public Required: string;
    public MinDate: string;
    public MaxDate: string;
    public MinLength: number;
    public MaxLength: number;
    public Pattern: string;
    public MinValue: Object;
    public MaxValue: Object;
    public RequiredViolationMessage: string;
    public MinLengthViolationMessage: string;
    public MaxLengthViolationMessage: string;

    public constructor(init?: Partial<FieldModel>) { (Object as any).assign(this, init); }
}

export class ContainerInfoModel
{
    public ItemId: string;
    public ItemType: string;
    public DisplayType: string;
    public Provider: string;
    public ItemStatus: LifecycleStatusModel;
    public IsPageControl: boolean;
    public DetailsViewUrl: string;
    public Fields: FieldModel[];

    public constructor(init?: Partial<ContainerInfoModel>) { (Object as any).assign(this, init); }
}

export class ContainerInfoMessage
{
    public PageId: string;
    public PageTitle: string;
    public ContainersInfo: ContainerInfoModel[];

    public constructor(init?: Partial<ContainerInfoMessage>) { (Object as any).assign(this, init); }
}

TypeScript ContainerInfoMessage 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/inlineediting/containersInfo HTTP/1.1 
Host: www.asg.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"PageId":"String","PageTitle":"String","ContainersInfo":[{"ItemId":"String","ItemType":"String","DisplayType":"String","Provider":"String","ItemStatus":{"DisplayStatus":"String","IsAdmin":false,"IsEditable":false,"IsStatusEditable":false,"IsLocked":false,"IsPublished":false,"IsLockedByMe":false,"LockedByUsername":"String","WorkflowStatus":"String"},"IsPageControl":false,"DetailsViewUrl":"String","Fields":[{"Name":"String","Required":"String","MinDate":"String","MaxDate":"String","MinLength":0,"MaxLength":0,"Pattern":"String","MinValue":{},"MaxValue":{},"RequiredViolationMessage":"String","MinLengthViolationMessage":"String","MaxLengthViolationMessage":"String"}]}]}