<back to all web services

ContainerInfoMessage

The following routes are available for this service:
POST/RestApi/sitefinity/inlineediting/containersInfo
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LifecycleStatusModel:
    display_status: Optional[str] = None
    is_admin: bool = False
    is_editable: bool = False
    is_status_editable: bool = False
    is_locked: bool = False
    is_published: bool = False
    is_locked_by_me: bool = False
    locked_by_username: Optional[str] = None
    workflow_status: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FieldModel:
    name: Optional[str] = None
    required: Optional[str] = None
    min_date: Optional[str] = None
    max_date: Optional[str] = None
    min_length: int = 0
    max_length: int = 0
    pattern: Optional[str] = None
    min_value: Optional[Object] = None
    max_value: Optional[Object] = None
    required_violation_message: Optional[str] = None
    min_length_violation_message: Optional[str] = None
    max_length_violation_message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContainerInfoModel:
    item_id: Optional[str] = None
    item_type: Optional[str] = None
    display_type: Optional[str] = None
    provider: Optional[str] = None
    item_status: Optional[LifecycleStatusModel] = None
    is_page_control: bool = False
    details_view_url: Optional[str] = None
    fields: Optional[List[FieldModel]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContainerInfoMessage:
    page_id: Optional[str] = None
    page_title: Optional[str] = None
    containers_info: Optional[List[ContainerInfoModel]] = None

Python ContainerInfoMessage DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<ContainerInfoMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Services.InlineEditing.Messages">
  <ContainersInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Services.InlineEditing">
    <d2p1:ContainerInfoModel>
      <d2p1:DetailsViewUrl>String</d2p1:DetailsViewUrl>
      <d2p1:DisplayType>String</d2p1:DisplayType>
      <d2p1:Fields>
        <d2p1:FieldModel>
          <d2p1:MaxDate>String</d2p1:MaxDate>
          <d2p1:MaxLength>0</d2p1:MaxLength>
          <d2p1:MaxLengthViolationMessage>String</d2p1:MaxLengthViolationMessage>
          <d2p1:MaxValue />
          <d2p1:MinDate>String</d2p1:MinDate>
          <d2p1:MinLength>0</d2p1:MinLength>
          <d2p1:MinLengthViolationMessage>String</d2p1:MinLengthViolationMessage>
          <d2p1:MinValue />
          <d2p1:Name>String</d2p1:Name>
          <d2p1:Pattern>String</d2p1:Pattern>
          <d2p1:Required>String</d2p1:Required>
          <d2p1:RequiredViolationMessage>String</d2p1:RequiredViolationMessage>
        </d2p1:FieldModel>
      </d2p1:Fields>
      <d2p1:IsPageControl>false</d2p1:IsPageControl>
      <d2p1:ItemId>String</d2p1:ItemId>
      <d2p1:ItemStatus>
        <d2p1:DisplayStatus>String</d2p1:DisplayStatus>
        <d2p1:IsAdmin>false</d2p1:IsAdmin>
        <d2p1:IsEditable>false</d2p1:IsEditable>
        <d2p1:IsLocked>false</d2p1:IsLocked>
        <d2p1:IsLockedByMe>false</d2p1:IsLockedByMe>
        <d2p1:IsPublished>false</d2p1:IsPublished>
        <d2p1:IsStatusEditable>false</d2p1:IsStatusEditable>
        <d2p1:LockedByUsername>String</d2p1:LockedByUsername>
        <d2p1:WorkflowStatus>String</d2p1:WorkflowStatus>
      </d2p1:ItemStatus>
      <d2p1:ItemType>String</d2p1:ItemType>
      <d2p1:Provider>String</d2p1:Provider>
    </d2p1:ContainerInfoModel>
  </ContainersInfo>
  <PageId>String</PageId>
  <PageTitle>String</PageTitle>
</ContainerInfoMessage>