<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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
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"}]}]}