ProjectWithAllIncludes

  • address
    Type: string
  • apartments
    Type: integer

    Integer numbers.

  • apartmentSpecifications
    Type: array string[]
  • 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

  • assetUpdatedAt
    Type: string Format: date-time

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

  • backgroundPath
    Type: string
  • backgroundType
    Type: string enum
    values
    • multires
    • equirect
    • cube
    • none
  • boosted
    Type: boolean
  • buildings
    Type: integer

    Integer numbers.

  • clients
    Type: array object[] · ClientProject[]
    • description
      Type: string

      Clients description

    • id
      Type: integer

      User Id

    • logo
      Type: string

      URL of the user's logo

    • logoUrl
      Type: string

      URL of the user's logo

    • name
      Type: string

      The name of the user

  • completionDate
    Type: string Format: date

    full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

  • contactName
    Type: string
  • 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

  • dealType
    Type: string enum
    values
    • rent
    • sale
    • commercial
  • decorationPath
    Type: string
  • decorationType
    Type: string enum
    values
    • tiles
    • splats
    • model
    • none
  • description
    Type: string
  • emails
    Type: array string[]
  • floors
    Type: integer

    Integer numbers.

  • houseNumber
    Type: string
  • hoverImage
    Type: string
  • id
    Type: integer

    Integer numbers.

  • immediateOccupancy
    Type: boolean
  • isIsrael
    Type: boolean

    Flag that shows if is project Israeli

  • lat
    Type: number Format: float
  • listings
    Type: array object[] · ProjectListing[]
    • assets
      Type: array object[] · ProjectAsset[]
    • balconyArea
      Type: number Format: float

      Balcony area

    • balconyMetadata
      Type: object

      Additional metadata about the balcony

    • buildingNumber
      Type: integer

      Building number of the project listing

    • 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

    • description
      Type: string

      Description of the listing

    • elevator
      Type: boolean

      Indicates if the project listing has an elevator

    • features
      Type: array string[] enum

      Array of features available in the listing

      values
      • parking
      • storage
      • ac
      • elevator
      • shelter
    • id
      Type: integer

      Integer numbers.

    • isPublic
      Type: boolean

      Flag indicating if the project listing is public

    • livingArea
      Type: number Format: float

      Living area of the living room

    • maxFloor
      Type: number

      Max Floor of the listing

    • minFloor
      Type: number

      Min Floor of the listing

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

      Number of appartment ( for example )

    • positionX
      Type: number Format: float

      Position of the listing on the X-axis

    • positionY
      Type: number Format: float

      Position of the listing on the Y-axis

    • positionZ
      Type: number Format: float

      Position of the listing on the Z-axis

    • price
      Type: number Format: float

      Price of the listing

    • 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 listing

    • rooms
      Type: number Format: float

      Amount of rooms in current listing

    • rotationX
      Type: number Format: float

      Rotation of the listing on the X-axis

    • rotationY
      Type: number Format: float

      Rotation of the listing on the Y-axis

    • rotationZ
      Type: number Format: float

      Rotation of the listing on the Z-axis

    • scaleX
      Type: number Format: float

      Scale of the listing on the X-axis

    • scaleY
      Type: number Format: float

      Scale of the listing on the Y-axis

    • scaleZ
      Type: number Format: float

      Scale of the listing on the Z-axis

    • shelter
      Type: boolean

      Indicates if the project listing has a shelter

    • showPrice
      Type: boolean
    • status
      Type: string enum

      Actual status of listing (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

  • lng
    Type: number Format: float
  • logo
    Type: string
  • mainImage
    Type: string
  • objects
    Type: array object[] · ProjectObject[]
    • asset
      Type: array integer[]

      List of asset IDs associated with the object

    • 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

    • id
      Type: integer Format: int32

      Unique identifier for the project object

    • metadata
      Type: array object[]
      Empty object
    • name
      Type: string

      Name of the object

    • positionX
      Type: number Format: float

      Position of the object on the X-axis

    • positionY
      Type: number Format: float

      Position of the object on the Y-axis

    • positionZ
      Type: number Format: float

      Position of the object on the Z-axis

    • projectId
      Type: integer Format: int32

      ID of the associated project

    • rotationX
      Type: number Format: float

      Rotation of the object on the X-axis

    • rotationY
      Type: number Format: float

      Rotation of the object on the Y-axis

    • rotationZ
      Type: number Format: float

      Rotation of the object on the Z-axis

    • scaleX
      Type: number Format: float

      Scale of the object on the X-axis

    • scaleY
      Type: number Format: float

      Scale of the object on the Y-axis

    • scaleZ
      Type: number Format: float

      Scale of the object on the Z-axis

    • showcaseEntityType
      Type: string enum

      Type of showcase entity associated with the object

      values
      • tileset
      • model
      • splat
      • instancedModel
      • lodModel
    • 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

  • orderType
    Type: string enum
    values
    • 3d
    • 2d
    • combined
  • phoneDesktop
    Type: string
  • phoneMobile
    Type: string
  • polygons
    Type: array object[] · ProjectPolygon[]
    • assets
      Type: array object[] · ProjectAsset[]
    • 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

  • products
    Type: array integer[]

    Project products

  • projectPromotions
    Type: array object[] · ProjectPromotion[]
    • bgColor
      Type: string

      Background Color

    • bgIcon
      Type: string

      Background icon

    • bgImage
      Type: string

      Background image

    • bgType
      Type: string

      Background type

    • 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

    • description
      Type: string

      Description of the timeline

    • id
      Type: integer

      ID of the promotion

    • name
      Type: string

      Title of the timeline

    • projectId
      Type: integer

      ID of the project

    • 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

  • projectUpdatedAt
    Type: string Format: date-time

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

  • promotionalLabel
    Type: string
  • promotions
    Type: boolean
  • propsConfigPath
    Type: string
  • slug
    Type: string
  • specifications
    Type: array string[]
  • status
    Type: string enum
    values
    • activeOnSite
    • activeNotOnSite
    • off
    • frozen
    • pendingApproval
    • expired
    • awaitingRepair
    • waitingForOrderTransfer
  • subTitle
    Type: string
  • timelines
    Type: array object[] · ProjectTimeline[]
    • date
      Type: string Format: date-time

      Date of the timeline

    • description
      Type: string

      Description of the timeline

    • id
      Type: integer

      ID of the timeline

    • projectId
      Type: integer

      ID of the project

    • title
      Type: string

      Title of the timeline

  • title
    Type: string
  • type
    Type: array string[] enum
    values
    • duplex
    • seaside
    • investment
    • new
    • garden
  • 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

  • users
    Type: array object[] · UserProject[]
    • id
      Type: integer

      User Id

    • logo
      Type: string

      URL of the user's logo

    • logoUrl
      Type: string

      URL of the user's logo

    • name
      Type: string

      The name of the user

    • yad2Id
      Type: integer

      User Yad2Id

    • yad2Subscription
      Type: boolean

      Flag that displays if user has a subscription

  • vPhoneReSatira
    Type: string
  • vPhoneYad2Publish
    Type: string
  • yad2AddressMasterId
    Type: string
  • yad2Area
    Type: string
  • yad2AreaId
    Type: string
  • yad2ChelkaId
    Type: string
  • yad2City
    Type: string
  • yad2CityId
    Type: string
  • yad2CrmId
    Type: string
  • yad2GushId
    Type: string
  • yad2Hood
    Type: string
  • yad2HoodId
    Type: string
  • yad2NoAmId
    Type: integer

    Integer numbers.

  • yad2Street
    Type: string
  • yad2StreetId
    Type: string
  • yad2TopArea
    Type: string
  • yad2TopAreaId
    Type: string
  • yzerId
    Type: integer

    Integer numbers.