Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 2.32 KB

ViewLayoutResponseSchema.md

File metadata and controls

32 lines (23 loc) · 2.32 KB

ViewLayoutResponseSchema

A view resolved into a layout: every unit to draw, flat and in final render order, each naming its section; the ordered section index; and what was rendered. The units are under units rather than the platform's data: this is not a collection of the resource in the path — it is one layout, whose parts happen to include units. Deliberately unpaginated. A partial layout is not a layout: the calendar needs every row before it can draw one, so paging this would mean N requests before first paint. Bounded by construction instead — a stored view is capped on write, a built-in by the property's inventory.

Properties

Name Type Description Notes
units List[UnitResponseSchema] Units in final render order, each carrying its `sectionId`.
sections List[SectionResponseSchema] The ordered section index. What it contains depends on how the view resolved. A view resolved from a stored definition ends with the uncategorized tail, always last and always present even when every unit is placed. The two derived built-ins have no tail: `accommodation-type` returns one section per unit type, and `alphabetical` returns a single band. Do not index off the last section to find the tail — match on `systemLabel`.
meta LayoutMetaResponseSchema

Example

from cloudbeds_pms.models.view_layout_response_schema import ViewLayoutResponseSchema

# TODO update the JSON string below
json = "{}"
# create an instance of ViewLayoutResponseSchema from a JSON string
view_layout_response_schema_instance = ViewLayoutResponseSchema.from_json(json)
# print the JSON string representation of the object
print(ViewLayoutResponseSchema.to_json())

# convert the object into a dict
view_layout_response_schema_dict = view_layout_response_schema_instance.to_dict()
# create an instance of ViewLayoutResponseSchema from a dict
view_layout_response_schema_from_dict = ViewLayoutResponseSchema.from_dict(view_layout_response_schema_dict)

[Back to Model list] [Back to API list] [Back to README]