TeaserTemplate

Describes what the author is allowed to choose right now per teaser field, given the active billing plan, the underlying property data, and the parent context. Also carries the property's full tag pool.

  • avgContractLength
    Type: object · TeaserOptionTemplate nullable

    Average remaining contract length (years).

    • allowedDisplays
      Type: array string[] · TeaserDisplayPatchValue[]enum

      Display modes the author may choose for this field right now — a subset of actual, hidden, span, custom_span. Fields with no allowed mode (plan-locked, no underlying value, or extra-confidential) are absent from the parent template object.

      values
      • actual
      • hidden
      • span
      • custom_span
  • categories
    Type: object · TeaserOptionTemplate nullable

    Asset-category mix.

    • allowedDisplays
      Type: array string[] · TeaserDisplayPatchValue[]enum

      Display modes the author may choose for this field right now — a subset of actual, hidden, span, custom_span. Fields with no allowed mode (plan-locked, no underlying value, or extra-confidential) are absent from the parent template object.

      values
      • actual
      • hidden
      • span
      • custom_span
  • conversions
    Type: object · TeaserOptionTemplate nullable

    Suggested alternative-use categories.

    • allowedDisplays
      Type: array string[] · TeaserDisplayPatchValue[]enum

      Display modes the author may choose for this field right now — a subset of actual, hidden, span, custom_span. Fields with no allowed mode (plan-locked, no underlying value, or extra-confidential) are absent from the parent template object.

      values
      • actual
      • hidden
      • span
      • custom_span
  • country
    Type: object · TeaserOptionTemplate nullable

    ISO 3166-1 alpha-2 country code.

    • allowedDisplays
      Type: array string[] · TeaserDisplayPatchValue[]enum

      Display modes the author may choose for this field right now — a subset of actual, hidden, span, custom_span. Fields with no allowed mode (plan-locked, no underlying value, or extra-confidential) are absent from the parent template object.

      values
      • actual
      • hidden
      • span
      • custom_span
  • investmentSize
    Type: object · TeaserOptionTemplate nullable

    Total investment size (ticket size).

    • allowedDisplays
      Type: array string[] · TeaserDisplayPatchValue[]enum

      Display modes the author may choose for this field right now — a subset of actual, hidden, span, custom_span. Fields with no allowed mode (plan-locked, no underlying value, or extra-confidential) are absent from the parent template object.

      values
      • actual
      • hidden
      • span
      • custom_span
  • leasableUnits
    Type: object · TeaserOptionTemplate nullable

    Leasable area in sqm.

    • allowedDisplays
      Type: array string[] · TeaserDisplayPatchValue[]enum

      Display modes the author may choose for this field right now — a subset of actual, hidden, span, custom_span. Fields with no allowed mode (plan-locked, no underlying value, or extra-confidential) are absent from the parent template object.

      values
      • actual
      • hidden
      • span
      • custom_span
  • locality
    Type: object · TeaserOptionTemplate nullable

    City / municipality.

    • allowedDisplays
      Type: array string[] · TeaserDisplayPatchValue[]enum

      Display modes the author may choose for this field right now — a subset of actual, hidden, span, custom_span. Fields with no allowed mode (plan-locked, no underlying value, or extra-confidential) are absent from the parent template object.

      values
      • actual
      • hidden
      • span
      • custom_span
  • locationClasses
    Type: object · TeaserOptionTemplate nullable

    Per-category location class (A/B/C).

    • allowedDisplays
      Type: array string[] · TeaserDisplayPatchValue[]enum

      Display modes the author may choose for this field right now — a subset of actual, hidden, span, custom_span. Fields with no allowed mode (plan-locked, no underlying value, or extra-confidential) are absent from the parent template object.

      values
      • actual
      • hidden
      • span
      • custom_span
  • noi
    Type: object · TeaserOptionTemplate nullable

    Net operating income.

    • allowedDisplays
      Type: array string[] · TeaserDisplayPatchValue[]enum

      Display modes the author may choose for this field right now — a subset of actual, hidden, span, custom_span. Fields with no allowed mode (plan-locked, no underlying value, or extra-confidential) are absent from the parent template object.

      values
      • actual
      • hidden
      • span
      • custom_span
  • parcelArea
    Type: object · TeaserOptionTemplate nullable

    Parcel area in sqm.

    • allowedDisplays
      Type: array string[] · TeaserDisplayPatchValue[]enum

      Display modes the author may choose for this field right now — a subset of actual, hidden, span, custom_span. Fields with no allowed mode (plan-locked, no underlying value, or extra-confidential) are absent from the parent template object.

      values
      • actual
      • hidden
      • span
      • custom_span
  • propertyCount
    Type: object · TeaserOptionTemplate nullable

    Number of properties in the portfolio.

    • allowedDisplays
      Type: array string[] · TeaserDisplayPatchValue[]enum

      Display modes the author may choose for this field right now — a subset of actual, hidden, span, custom_span. Fields with no allowed mode (plan-locked, no underlying value, or extra-confidential) are absent from the parent template object.

      values
      • actual
      • hidden
      • span
      • custom_span
  • rentalIncome
    Type: object · TeaserOptionTemplate nullable

    Annualised rental income.

    • allowedDisplays
      Type: array string[] · TeaserDisplayPatchValue[]enum

      Display modes the author may choose for this field right now — a subset of actual, hidden, span, custom_span. Fields with no allowed mode (plan-locked, no underlying value, or extra-confidential) are absent from the parent template object.

      values
      • actual
      • hidden
      • span
      • custom_span
  • rentedPercent
    Type: object · TeaserOptionTemplate nullable

    Occupied-space percentage.

    • allowedDisplays
      Type: array string[] · TeaserDisplayPatchValue[]enum

      Display modes the author may choose for this field right now — a subset of actual, hidden, span, custom_span. Fields with no allowed mode (plan-locked, no underlying value, or extra-confidential) are absent from the parent template object.

      values
      • actual
      • hidden
      • span
      • custom_span
  • tags
    Type: array string[]

    The property's full tag pool. The author picks a subset of these for the teaser's tags snapshot. Empty array when the property has no tags or the active plan does not expose tags.

  • tenure
    Type: object · TeaserOptionTemplate nullable

    Property tenure: freehold or leasehold.

    • allowedDisplays
      Type: array string[] · TeaserDisplayPatchValue[]enum

      Display modes the author may choose for this field right now — a subset of actual, hidden, span, custom_span. Fields with no allowed mode (plan-locked, no underlying value, or extra-confidential) are absent from the parent template object.

      values
      • actual
      • hidden
      • span
      • custom_span
  • totalCosts
    Type: object · TeaserOptionTemplate nullable

    Total operating costs.

    • allowedDisplays
      Type: array string[] · TeaserDisplayPatchValue[]enum

      Display modes the author may choose for this field right now — a subset of actual, hidden, span, custom_span. Fields with no allowed mode (plan-locked, no underlying value, or extra-confidential) are absent from the parent template object.

      values
      • actual
      • hidden
      • span
      • custom_span
  • yearBuilt
    Type: object · TeaserOptionTemplate nullable

    Year built.

    • allowedDisplays
      Type: array string[] · TeaserDisplayPatchValue[]enum

      Display modes the author may choose for this field right now — a subset of actual, hidden, span, custom_span. Fields with no allowed mode (plan-locked, no underlying value, or extra-confidential) are absent from the parent template object.

      values
      • actual
      • hidden
      • span
      • custom_span
  • yield
    Type: object · TeaserOptionTemplate nullable

    Gross yield.

    • allowedDisplays
      Type: array string[] · TeaserDisplayPatchValue[]enum

      Display modes the author may choose for this field right now — a subset of actual, hidden, span, custom_span. Fields with no allowed mode (plan-locked, no underlying value, or extra-confidential) are absent from the parent template object.

      values
      • actual
      • hidden
      • span
      • custom_span
  • zoningCategory
    Type: object · TeaserOptionTemplate nullable

    Zoning category.

    • allowedDisplays
      Type: array string[] · TeaserDisplayPatchValue[]enum

      Display modes the author may choose for this field right now — a subset of actual, hidden, span, custom_span. Fields with no allowed mode (plan-locked, no underlying value, or extra-confidential) are absent from the parent template object.

      values
      • actual
      • hidden
      • span
      • custom_span
  • zoningGfa
    Type: object · TeaserOptionTemplate nullable

    Zoning permitted gross floor area (sqm).

    • allowedDisplays
      Type: array string[] · TeaserDisplayPatchValue[]enum

      Display modes the author may choose for this field right now — a subset of actual, hidden, span, custom_span. Fields with no allowed mode (plan-locked, no underlying value, or extra-confidential) are absent from the parent template object.

      values
      • actual
      • hidden
      • span
      • custom_span

Propstreet API Documentation