ProjectPolygon

  • assets
    Type: array object[] ยท ProjectAsset[]
    • filePath
      Type: string

      Asset file path

    • id
      Type: integer

      ID of the asset

    • isMain
      Type: boolean

      Whether this is the main asset for the polygon (only for gallery assets with polygonId)

    • listingId
      Type: integer

      ID of the listing

    • order
      Type: integer

      Order of the asset

    • polygonId
      Type: integer

      ID of the polygon

    • projectId
      Type: integer

      ID of the project

    • title
      Type: string

      Title of the asset

    • type
      Type: string enum

      Type of the asset

      values
      • gallery
      • logo
      • mainImage
      • hoverImage
      • vsObject
    • url
      Type: string

      Asset file url

    • urlLarge
      Type: string

      Asset file url large (width 1024px)

    • urlMedium
      Type: string

      Asset file url medium (width 300px)

    • urlSmall
      Type: string

      Asset file url small (width 150px)

    • yad2CrmId
      Type: string

      Yad2CrmId from API

  • balconyArea
    Type: number Format: float

    Balcony area

  • balconyMetadata
    Type: object

    Additional metadata about the balcony

  • buildingNumber
    Type: integer

    Building number of the project polygon

  • createdAt
    Type: string Format: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • elevator
    Type: boolean

    Indicates if the project polygon has an elevator

  • id
    Type: integer

    Integer numbers.

  • isPublic
    Type: boolean

    Flag indicating if the project polygon is public

  • livingArea
    Type: number Format: float

    Living area of the living room

  • maxFloor
    Type: number

    Max Floor of the polygon

  • minFloor
    Type: number

    Min Floor of the polygon

  • name
    Type: string
  • number
    Type: number Format: int32

    Number of appartment ( for example )

  • positionX
    Type: number Format: float

    Position of the polygon on the X-axis

  • positionY
    Type: number Format: float

    Position of the polygon on the Y-axis

  • positionZ
    Type: number Format: float

    Position of the polygon on the Z-axis

  • price
    Type: number Format: float

    Price of the polygon

  • priceBy
    Type: string enum

    Price calculation method

    values
    • total
    • m2
  • projectId
    Type: integer

    Integer numbers.

  • projectObjectId
    Type: number Format: int64

    ID of object assigned with current polygon

  • rooms
    Type: number Format: float

    Amount of rooms in current polygon

  • rotationX
    Type: number Format: float

    Rotation of the polygon on the X-axis

  • rotationY
    Type: number Format: float

    Rotation of the polygon on the Y-axis

  • rotationZ
    Type: number Format: float

    Rotation of the polygon on the Z-axis

  • scaleX
    Type: number Format: float

    Scale of the polygon on the X-axis

  • scaleY
    Type: number Format: float

    Scale of the polygon on the Y-axis

  • scaleZ
    Type: number Format: float

    Scale of the polygon on the Z-axis

  • shelter
    Type: boolean

    Indicates if the project polygon has a shelter

  • showPrice
    Type: boolean
  • status
    Type: string enum

    Actual status of polygon (available / sold / reserved)

    values
    • available
    • sold
    • reserved
    • unavailable
  • tourUrl
    Type: string

    Tour URL

  • type
    Type: string enum
    values
    • apartment
    • patio
    • studioLoft
    • cottage
    • penthouse
  • updatedAt
    Type: string Format: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z