HomeByMe for Home Retailers Documentation

›Developer's Guide

Product Enhancements

  • Release Notes

Use the Home Planner

  • Overview
  • Get Started
  • From a HomeByMe Project
  • From a 2D Plan
  • From the Scratch
  • Add Products
  • Configure Products
  • Create Favorites
  • Finalize My Project
  • Access My Project
  • Recover My Project

Configuration Guide

  • Overview
  • Application Distribution Parameters
  • Sample of Application Distribution Parameters
  • Localizing Application and Content
  • Integrate Branding
  • Default Project
  • Default widgets
  • Print widget
  • Product Sheet widget
  • Project Overview widget
  • Projects List widget

Developer's Guide

  • Authentication Mechanism
  • Signing your Request
  • Integrate the Home Planner to your Website
  • Integrate with Ordering System
  • Bill of Material Reference
  • Home Planner iFrame Messages

Home Planner iFrame Messages

iFrame messages support the communication between the planner and the embeding Website to provide openness and integration. This section describes iFrame messages that are listen by the planner (input) to react to parent window actions or emitted by the planner (output) to enable parent window to react.

IFrame Communication Introduction

To have an overview of the subject, we advise you to read window.postMessage documentation on the web.

➡️ Refer to PostMessage documentation 🔗

Every message received by the application or sent by the application through window.postMessage must be an object of this format:

KeyTypeDescription
eventstringThe event name is used as unique identifier for a given event.
content*Content sent with the event. It is optional and can be anything: integer, array, object...
Template
{
   event:"Login",
   content:
   {
      token:"dez2fre589e"
   }
}

Overview of Data Synchronization

According to different integration context, the iframe messages that the Home Retailer Planner subscribe/publish can be divided into three parts.

Website

When Home Retailer Application is embeded in the client's Website, possible data synchronization could be as following:

For...Inputs MessagesOutputs Messages
AuthenticationAuthentication TokenRefreshed LoginAuthenticationRequired, AuthenticationSucceeded, AuthenticationFailed, TokenExpired, LoginRequired, LoginSucceeded, LoginFailed
ApplicationReady, CloseApp
Load/Save ProjectLoadProjectInfoRequestedProject,InfoRequestedUser,SaveStarted,ProjectSavingSucceeded, ProjectSavingFailed, ProjectLoadingSucceeded, ProjectLoadingFailed, ProductListWithBOM
ShareShareMedia, ShareProduct
Buying ExperienceAddToBasket
Bill Of Material (BOM)BOMComputationReady

Third-party Application

When a third-party application (like furniture configurator) is embeded in the Home Retailer Application as an iframe, possible data synchronization could be as following:

For...Inputs MessagesOutputs Messages
External ConfiguratorListening, ProductSaved, BadRequestConfigureProduct, BadResponse

Default Widget

When a widget is embeded in the Home Retailer Application as an iframe, possible data synchronization could be as following:

For...Inputs MessagesOutputs Messages
PrintListening, ClosePrintLayerOpenPrintLayer
Product SheetListening, AddProduct, CloseProductSheet, ShareProductByOption, AddToFavorite, ProductClicked, ShowPreviousProduct, ConfigureProductOpenProductSheet
Project OverviewCloseProjectOverview, Listening, AddToBasket, FormattedPricesRequested, ShareMedia, DeleteMedia, OpenPrintOpenProjectOverview, FormattedPrices

Authentication

AuthenticationRequired

Output emitted when the application requests authentication parameters. Upon this request, the parent window must reply with an Authentication message.

KeyTypeValue/TemplateDescription
eventstringAuthenticationRequired–
content–––

Authentication

Input received when authentication is requested by the message AuthenticationRequired, the parent window must reply with the following message.

KeyTypeValueDescription
eventstringAuthentication–
contentobjecttoken
distributionID
token: The legal entity token generated by the client website.
distributionID: The specific distribution in the legal entity.

Template

{
 "token": string
 "distributionID": string
}

AuthenticationSucceeded

Output emitted by the application to acknowledge that authentication is successful.

KeyTypeValue/TemplateDescription
eventstringAuthenticationSucceeded–
contentobjectorigin
appID
distributionID
distributionParams
origin: The domain from which the message originated.
appID: The application ID associated with the provided credentials.
distributionID: The distribution ID associated with the provided credentials.
distributionParams: The distribution-specific parameters, if any, of the distribution associated with the provided credentials.

Template

{
    "origin": string,
    "appID": string,
    "distributionID": string,
    "distributionParams": object
}

AuthenticationFailed

Output emitted by the application to inform that authentication has failed.

KeyTypeValue/TemplateDescription
eventstringAuthenticationFailed–
contentobjecthttpCode
id
message
httpCode: The HTTP error code for the request.
id: The error id
message: The detailed error message.

Template

{
    "httpCode": HttpErrorCode,
    "id": string,
    "message": string
}

TokenExpired

Output emitted and sent to the parent window when a token is expired, subsequent calls to the web-services will fail with a 401 error.

KeyTypeValue/TemplateDescription
eventstringTokenExpired–
contentobjectnull–

TokenRefreshed

Input received from the parent window. This message is send by the parent window when receiving TokenExpired. This message provides a new valid token to the application to authentify subsequent calls to web services.

KeyTypeValueDescription
eventstringTokenRefreshed–
contentobjecttoken
distributionID
token: The legal entity token generated by the client website.
distributionID: The specific distribution in the legal entity.

Template

{
 "token": string,
 "distributionID": string
}

LoginRequired

Output emitted when an action requires a logged user and none is currently logged in the application, this message will be sent.

KeyTypeValue/TemplateDescription
eventstringLoginRequired–
content–––

Login

Input received from the parent window when the user has successfully logged in and the user token is generated.

KeyTypeValue/TemplateDescription
eventstringLogin–
contentobjecttoken: stringtoken: Token generated by client website.

LoginSucceeded

Output emitted when the application succeeded to log in the user (from a token for example), it will send this message.

KeyTypeValue/TemplateDescription
eventstringLoginSucceeded–
content–––

LoginFailed

Output emitted when the application failed to log in the user (from a token for example), it will send this message.

KeyTypeValue/TemplateDescription
eventstringLoginFailed–
content–––

Application

Ready

Output emitted by the planner. The application needs some time to be ready to listen to messages. Listen to this message and ensure that it has been emitted before sending any other iFrame message.

KeyTypeValue/TemplateDescription
eventstringReady–
content–––

CloseApp

Output emitted when the user clicks on the cross button to close the application.

KeyTypeValue/TemplateDescription
eventstringCloseApp–
content–––

Load/Save Project

LoadProject

For performance reasons, it is recommended if applicable, to start the planner by providing the project UUID as an URL parameter. This message should be used only for other scenarios.

Input request for project load in kitchen application.

KeyTypeValue/TemplateDescription
eventstringLoadProject–
contentobjectid: stringProject UUID from the ByMe platform.

InfoRequestedProject

Output emitted with additional information about the current project.

KeyTypeValue/TemplateDescription
eventstringInfoRequestedProject–
contentobjectprojectID
projectName
projectDesc
ProjectDateCreation
ProjectDateUpdate
projectID: UUID of the project.
projectName: Name of the project.
projectDesc: Description of the project.
ProjectDateCreation: Creation date of the project.
ProjectDateUpdate: Update date of the project.

InfoRequestedUser

Output emitted with additional information about the current user.

KeyTypeValue/TemplateDescription
eventstringInfoRequestedUser–
contentobjectuserIDuserID: ID of the user.

SaveStarted

Output emitted when the save process of a project is started in the planner, with additional information about the saved project.

KeyTypeValue/TemplateDescription
eventstringSaveStarted–
contentobjectProjectID: string
BOM : object
Project UUID from the ByMe platform.
Product List, refer to Bill of Material Reference for a complete description of BOM in JSON format.

ProjectSavingSucceeded

Output emitted when the project is saved in the planner, with additional information about the saved project.

KeyTypeValue/TemplateDescription
eventstringProjectSavingSucceeded–
contentobjectid
name
description
id: Project UUID from the ByMe platform.
name: The name of the saved project.
description: The description of the saved project.

ProjectSavingFailed

Output emitted when the project is try to save and failed in the planner, with additional information about the project.

KeyTypeValue/TemplateDescription
eventstringProjectSavingFailed–
content–––

ProjectLoadingSucceeded

Output emitted when the project is loading with success in the planner.

KeyTypeValue/TemplateDescription
eventstringProjectLoadingSucceeded–
content–––

ProjectLoadingFailed

Output emitted when the project is loading in the planner and failed.

KeyTypeValue/TemplateDescription
eventstringProjectLoadingFailed–
content–––

ProductListWithBOM

Output emitted when the project is loading in the planner and failed.

KeyTypeValue/TemplateDescription
eventstringProductListWithBOM–
contentobjectBOMProduct List, refer to Bill of Material Reference for a complete description of BOM in JSON format.

Bill Of Material (BOM)

BOMComputationReady

Output emitted at the first time when the BOM is able to be computed by the planner (e.g. after opening a project).

KeyTypeValue/TemplateDescription
eventstringBOMComputationReady–
contentobjectBOMProduct List, refer to Bill of Material Reference for a complete description of BOM in JSON format.

External Configurator

Listening

Input emitted for the initialization of each module of the application.

KeyTypeValue/TemplateDescription
eventstringListening–
content–––

ProductSaved

Input emitted when the product is saved in the external configurator.

KeyTypeValue/TemplateDescription
eventstringProductSaved–
contentobjectconfiguratorData : String
configuratorID : String
description : String
extension : String
modelBuffer : ArrayBuffer
name : String
price : Float
thumbnail : ArrayBuffer
thumbnailExtension : String
configuratorData: The product new configurationData. This value is stored by the platform, to give back to the configurator for any future modification of the product.
configuratorID : ID of the configurator
description: (Optional) description of the product
extension : the 3D model file’s extension (only BM3 currently supported)
modelBuffer: the 3D model file as an ArrayBuffer
name: name of the product
price : (Optional) the product’s price
thumbnail : The thumbnail of the final configured product as an ArrayBuffer
thumbnailExtension : the thumbnail file’s extension (only JPG currently supported)

Template

{
  configuratorData: "B61-315 Module L50 x H231||C||S|Material__zone1|Chene_Structure||S|Material__zone2|Tex-Style",
  configuratorID: "gautier_innersense",
  description: "Module L50 H231 P37  - L50 / B61-315 Module L50 x H231 / Chêne structuré / 0",
  extension: "BM3",
  modelBuffer: ArrayBuffer(492018) {}",
  name: "B61-315 Module L50 x H231",
  price: 0,
  thumbnail: ArrayBuffer(6110) {},
  thumbnailExtension: "JPG"
}

BadRequest

Input emitted when the request is not valid or the user encounters another error like a network issue.

KeyTypeValue/TemplateDescription
eventstringBadRequest–
contentobjecterror : Stringerror: error message explaining the issue.

Template

{
  error: "The detailed message of the encountered error."
}

ConfigureProduct

Input emmited when the user want to configure the product with external configurator (add/remove/edit assembly component etc.).

KeyTypeValue/TemplateDescription
eventstringConfigureProduct–
contentobjectconfigurationData : StringconfigurationData: The configuration data of the product

Template

{
  configurationData: "Table Module L50 x H231"
}

BadResponse

Output emmited when the user encounters an error when the product is saved.

KeyTypeValue/TemplateDescription
eventstringBadResponse–
contentobjecterror : Stringerror: error message explaining the issue..

Template

{
  error: "error message explaining the issue."
}

Print

OpenPrintLayer

Output emitted for opening print layer with requested parameters. Those are described below:

KeyTypeValue/TemplateDescription
eventstringOpenPrintLayer–
contentobjecttranslation
language
namespace
roomsBOM
projectBOM
translation: Print name translation
language: Language of the application
namespace: Configure i18n translations
roomsBOM: Get BOM products for each level of the project.
projectBOM: Get BOM materials contained in the project.

Template

{
 "translation": object,
 "language": string,
 "namespace": string,
 "roomsBOM": object,
 "projectBOM": object,
}

Listening

Input emitted for the initialization of each module of the application.

KeyTypeValue/TemplateDescription
eventstringListening–
contentobject––

ClosePrintLayer

Input emmited when the user wants to close the print layer.

KeyTypeValue/TemplateDescription
eventstringClosePrintLayer–
content–––

Product Sheet

OpenProductSheet

Output requested when the ProductSheet widget has finished being loaded (thus with the reception of message "Listening" from widget), the application will send "OpenProductSheet" event to ProductSheet widget to ask for visulization of product informations.

KeyTypeValue/TemplateDescription
eventstringOpenProductSheet–
contentobjectisConfigurable
isProductSet
subProducts
sharingOptions
hasBackButton
translation
language
namespace
isConfigurable: If the product can be configured by an external configurator
isProductSet: If the product is a product set
subProducts: Object contains the similar product of the current product
sharingOptions: List of shared options.
hasBackButton: If several visited products.
translation: 2 translations keys, one for the website, one for the widget
language: Language of the application.
namespace: Configure i18n translations.

Template

{
  "event": "OpenProductSheet",
  "content": {
    "dbID": "GENERIC_FURNITURE_0158",
    "reference": "lit_double_06",
    "name": "Double Bed",
    "typeID": 108,
    "type": "furniture",
    "freeTags": [],
    "commercialDescription": "King size with blue linen",
    "shortDescription": "Double bed",
    "thumbnailURLLarge": "https://d15x0cs0o0urpo.cloudfront.net/286A8CED-9ADD-4345-A7FF-FF9462024168/Thumbnails/512.jpg",
    "thumbnailURLMedium": "https://d15x0cs0o0urpo.cloudfront.net/286A8CED-9ADD-4345-A7FF-FF9462024168/Thumbnails/256.jpg",
    "thumbnailURLSmall": "https://d15x0cs0o0urpo.cloudfront.net/286A8CED-9ADD-4345-A7FF-FF9462024168/Thumbnails/64.jpg",
    "startDate": null,
    "endDate": null,
    "isExpired": false,
    "brandID": 5,
    "brandName": "BryoForHR",
    "clientMetadata": null,
    "width": 1704,
    "height": 853,
    "depth": 2147,
    "price": {
      "regular": {
        "value": 700,
        "type": "regular",
        "startDate": null,
        "endDate": null,
        "additionalData": null
      },
      "current": {
        "value": 640,
        "type": "reduced",
        "startDate": null,
        "endDate": null,
        "additionalData": null
      },
      "discountType": "reduced"
    },
    "prices": {
      "regularPrice": "£700.00",
      "discountType": "reduced",
      "currentPrice": "£640.00"
    },
    "regularPriceLabel": "Regular price",
    "reduced": true,
    "subProducts": [
      {
        "dbID": "GENERIC_FURNITURE_0155",
        "reference": "lit_double_03",
        "name": "",
        "typeID": 108,
        "type": "furniture",
        "freeTags": [],
        "commercialDescription": "",
        "shortDescription": "",
        "thumbnailURLLarge": "https://d15x0cs0o0urpo.cloudfront.net/3CF77789-92E4-450F-8555-8082961591F4/Thumbnails/512.jpg",
        "thumbnailURLMedium": "https://d15x0cs0o0urpo.cloudfront.net/3CF77789-92E4-450F-8555-8082961591F4/Thumbnails/256.jpg",
        "thumbnailURLSmall": "https://d15x0cs0o0urpo.cloudfront.net/3CF77789-92E4-450F-8555-8082961591F4/Thumbnails/64.jpg",
        "startDate": null,
        "endDate": null,
        "isExpired": false,
        "brandID": 5,
        "brandName": "BryoForHR",
        "clientMetadata": null,
        "width": 1937,
        "height": 667,
        "depth": 2182
      },
      {
        "dbID": "GENERIC_FURNITURE_0179",
        "reference": "lit_double_04",
        "name": "",
        "typeID": 108,
        "type": "furniture",
        "freeTags": [],
        "commercialDescription": "",
        "shortDescription": "",
        "thumbnailURLLarge": "https://d15x0cs0o0urpo.cloudfront.net/F923B35A-4323-4C05-ADB7-CDF262C3DA1E/Thumbnails/512.jpg",
        "thumbnailURLMedium": "https://d15x0cs0o0urpo.cloudfront.net/F923B35A-4323-4C05-ADB7-CDF262C3DA1E/Thumbnails/256.jpg",
        "thumbnailURLSmall": "https://d15x0cs0o0urpo.cloudfront.net/F923B35A-4323-4C05-ADB7-CDF262C3DA1E/Thumbnails/64.jpg",
        "startDate": null,
        "endDate": null,
        "isExpired": false,
        "brandID": 5,
        "brandName": "BryoForHR",
        "clientMetadata": null,
        "width": 1800,
        "height": 2197,
        "depth": 2327
      },
      {
        "dbID": "GENERIC_FURNITURE_0445",
        "reference": "generique_lit_standart_01",
        "name": "Double bed",
        "typeID": 108,
        "type": "furniture",
        "freeTags": [],
        "commercialDescription": "",
        "shortDescription": "",
        "thumbnailURLLarge": "https://d15x0cs0o0urpo.cloudfront.net/37E1B42A-81BB-4513-9899-AE7610D2D481/Thumbnails/512.jpg",
        "thumbnailURLMedium": "https://d15x0cs0o0urpo.cloudfront.net/37E1B42A-81BB-4513-9899-AE7610D2D481/Thumbnails/256.jpg",
        "thumbnailURLSmall": "https://d15x0cs0o0urpo.cloudfront.net/37E1B42A-81BB-4513-9899-AE7610D2D481/Thumbnails/64.jpg",
        "startDate": null,
        "endDate": null,
        "isExpired": false,
        "brandID": 5,
        "brandName": "BryoForHR",
        "clientMetadata": null,
        "width": 1607.438,
        "height": 610.3379999515712,
        "depth": 2005.66
      }
    ],
    "sharingOptions": [
      {
        "name": "facebook",
        "enabled": true
      },
      {
        "name": "twitter",
        "enabled": true
      },
      {
        "name": "pinterest",
        "enabled": true
      },
      {
        "name": "mail",
        "enabled": true
      },
      {
        "name": "embed",
        "enabled": true
      }
    ],
    "hasBackButton": false,
    "productSheetURL": ""
  }
}

Listening

Input emitted for the initialization of each module of the application.

KeyTypeValue/TemplateDescription
eventstringListening–
contentobject––

AddProduct

Input emmited when user clicks on "Add to project" button on te ProductSheet widget, send "AddProduct" message to application to inform request of product insertion.

KeyTypeValue/TemplateDescription
eventstringAddProduct–
content–––

CloseProductSheet

Input emmited when the user clicks on "close" icon on the ProductSheet widget, send "CloseProductSheet" message to inform the application that the ProductSheet widget has been destroyed.

KeyTypeValue/TemplateDescription
eventstringCloseProductSheet–
content–––

ShowPreviousProduct

Input emmited when user clicks on “back” button on the product sheet view, he asks to see the previous product to be displayed in the product sheet.

KeyTypeValue/TemplateDescription
eventstringShowPreviousProduct–
contentobjectdbIddbId: the dbId of the product
{
 "dbId": "GENERIC_FURNITURE_0270"
}

ShareProductByOption

Input emmited when the user wants to share the product through a specific social network.

KeyTypeValue/TemplateDescription
eventstringShareProductByOption–
contentobjectoption
name
productSheetURL
option: the name of the option clicked
name: name of the product
productSheetURL: The URL of the product sheet
{
 "option": pinterest,
 "name": "Service Porcelaine 18 pces PERLE CHIC",
 "productSheetURL": " http://www.customer.html"
}

ShareProduct

Output emmited when the user wants to share the product through a specific social network.

KeyTypeValue/TemplateDescription
eventstringShareProduct–
contentobjectoption
name
option: the name of the option clicked
name: name of the product
{
 "option": pinterest,
 "name": "Service Porcelaine 18 pces PERLE CHIC",
 "productSheetURL": " http://www.customer.html"
}

AddToFavorite

Input emmited when the user wants to add the product into favorite.

KeyTypeValue/TemplateDescription
eventstringAddToFavorite–
contentobjectdbId
from
dbId: the dbId of the product
from: Indicates where does the request comes from.
{
 "dbId": "GENERIC_FURNITURE_0270",
 "from": "product-sheet",
}

ProductClicked

Input emmited when the user clicks on one of the product in the similar product section, this message is sent to the planner to display the selected product.

KeyTypeValue/TemplateDescription
eventstringProductClicked–
contentobjectdbIddbId: the dbId of the product
{
 "dbId": "GENERIC_FURNITURE_0270"
}

Project Overview

OpenProjectOverview

Output emitted for opening project overview of the user with several parameters. Those are described below:

KeyTypeValue/TemplateDescription
eventstringOpenProjectOverview–
contentobjecttranslation
language
namespace
roomsBOM
projectBOM
translation: 2 translations keys, one for the website, one for the widget
language: Language of the application.
namespace: Configure i18n translations.
roomsBOM: Get BOM products for each level of the project.
projectBOM: Get BOM materials contained in the project.

Template

{
 "translation": object,
 "language": string,
 "namespace": string,
 "roomsBOM": object,
 "projectBOM": object,
}

AddToBasket

Input requested when the user clicks on "Add to basket" button on the ProjectOverview default widget. He should be able to select some or all of the products presented in the item list, when the selection has been done, send "AddToBasket" event to inform the application of the user selection.

KeyTypeValue/TemplateDescription
eventstringAddToBasket–
contentobjectproductsproducts: Array of products that user want to buy, each element in the array must be an object containing the dedicated properties.

Listening

Input emitted for the initialization of each module of the application.

KeyTypeValue/TemplateDescription
eventstringListening–
contentobject––

ShareMedia

Input emmited when the user want to share one of his generated media, he click on "share" media button, Widget will send iframe message "ShareMedia" with related media information to ask for share.

KeyTypeValue/TemplateDescription
eventstringShareMedia–
contentobjectshareTarget
media
shareTarget: The social media's target
media: The URL of the media
{
  "event": "ShareMedia",
  "content": {
    "shareTarget": "twitter",
    "media": "https://byme-enterprise-preprod.s3.eu-west-1.amazonaws.com/data/homebymeProjects/9FD743DB-D854-46A5-B968-D3B33F3854E1/images/renderHQ/CE1737A6-8929-4A2A-B9C7-455DE5B7BCDA_468_351.jpg"
  }
}

DeleteMedia

Input emmited when the user wants to remove one of his generated media, he click on "delete" media button. The widget will send iframe message "DeleteMedia" with related media information to ask for deletion. The App will then send the "WsMediaDeleted" iframe message once media is deleted.

KeyTypeValue/TemplateDescription
eventstringDeleteMedia–
contentobjectimageIDimageID: The ID of the image which is necessary to delete
{
  "event": "DeleteMedia",
  "content": {
    "imageID": 49540
  }
}

CloseProjectOverview

Input emmited when the user click on "close" icon on the ProjectOverview default widget, send "CloseProjectOverview" event to inform the application that the default widget has been destroyed.

KeyTypeValue/TemplateDescription
eventstringCloseProjectOverview–
content–––

OpenPrint

Input emitted for opening print widget.

KeyTypeValue/TemplateDescription
eventstringOpenPrint–
content–––

FormattedPricesRequested

Input emmited when the user is selecting the products to be added to his basket. We need to update the total price based on the selected products. The calculated total price does not have the local format, so we need to send the prices information to the application to have the correcting formatting.

KeyTypeValue/TemplateDescription
eventstringFormattedPricesRequested–
contentobjectprices
from
prices: Array of product prices which are not yet formatted in the current local
from: Indicates where does the request comes from.
{
  "event": "FormattedPricesRequested",
  "content": {
    "prices": {
      "regular": 0,
      "current": 0,
      "discountType": null,
      "vatInformation": null
    },
    "from": "ItemList"
  }
}

FormattedPrices

Output emmited when user is selecting the products to be added to his basket. We need to update the total price based on the selected products. At this time, the calculated total price does not have the local format, so we need to send the prices information to the application to have the correct formatting.

KeyTypeValue/TemplateDescription
eventstringFormattedPrices–
contentobjectprices
from
prices: Array of product prices formatted in the current locale
from: Indicates where does the request comes from.

Template

{
 "prices": {
      "regular": 0,
      "current": 0,
      "discountType": null,
      "vatInformation": null
    },
 "from": "ItemList",
}

WsMediaDeleted

Output emmited when user has deleted a media from his generated medias and WS call is done.

KeyTypeValue/TemplateDescription
eventstringDeleteMedia–
contentobjectimageID
remainingSum
imageID: The ID of the image which is necessary to delete
remainingSum: number of remaining medias
{
  "event": "WsMediaDeleted",
  "content": {
    "imageID": 49540,
    "remainingSum": 37
  }
}

SendUpdatedMedias

Output emmited when user has deleted a media from his generated medias and default widget has requested the updated medias object.

KeyTypeValue/TemplateDescription
eventString"SendUpdatedMedias"
contentObject[]: Array- []: Array of all available medias
{
  "event": "SendUpdatedMedias",
  "content": [
    {
      "creationDate": "2020-08-03T09:59:53.000Z",
      "id": 74502,
      "metadata": {media: "images/render360/3DCE4252-EA9B-4DF3-8F25-C6F74C299…/3DCE4252-EA9B-4DF3-8F25-C6F74C29934C_468_351.jpg", gallery: "images/render360/3DCE4252-EA9B-4DF3-8F25-C6F74C299…/3DCE4252-EA9B-4DF3-8F25-C6F74C29934C_960_540.jpg", quality: "High", krpanoTour: "images/render360/3DCE4252-EA9B-4DF3-8F25-C6F74C29934C/vtour/tour.xml", compensated: false, …},
      "name": null,
      "typeMediaID": 1,
      "url": "https://byme-enterprise-preprod.s3.eu-west-1.amazonaws.com/data/homebymeProjects/22FEF3D1-F6C1-4656-8578-B68A29D426C6/images/render360/3DCE4252-EA9B-4DF3-8F25-C6F74C29934C"
    },
    {
      "creationDate": "2020-03-05T11:16:29.000Z",
      "id": 50414,
      "metadata": {media: "images/5-3-2020_12-16-28_468_351.jpg", gallery: "images/5-3-2020_12-16-28_960_540.jpg"},
      "name": "Snapshot",
      "type": 2,
      "typeMediaID": 3,
      "url": "https://byme-enterprise-preprod.s3.eu-west-1.amazonaws.com/data/homebymeProjects/22FEF3D1-F6C1-4656-8578-B68A29D426C6/images/5-3-2020_12-16-28_960_540.jpg"
    }
    ...
  ]
}

Template

{
 "prices": {
      "regular": 0,
      "current": 0,
      "discountType": null,
      "vatInformation": null
    },
 "from": "ItemList",
}
← Bill of Material Reference
  • IFrame Communication Introduction
  • Overview of Data Synchronization
    • Website
    • Third-party Application
    • Default Widget
  • Authentication
    • AuthenticationRequired
    • Authentication
    • AuthenticationSucceeded
    • AuthenticationFailed
    • TokenExpired
    • TokenRefreshed
    • LoginRequired
    • Login
    • LoginSucceeded
    • LoginFailed
  • Application
    • Ready
    • CloseApp
  • Load/Save Project
    • LoadProject
    • InfoRequestedProject
    • InfoRequestedUser
    • SaveStarted
    • ProjectSavingSucceeded
    • ProjectSavingFailed
    • ProjectLoadingSucceeded
    • ProjectLoadingFailed
    • ProductListWithBOM
  • Bill Of Material (BOM)
    • BOMComputationReady
  • External Configurator
    • Listening
    • ProductSaved
    • BadRequest
    • ConfigureProduct
    • BadResponse
  • Print
    • OpenPrintLayer
    • Listening
    • ClosePrintLayer
  • Product Sheet
    • OpenProductSheet
    • Listening
    • AddProduct
    • CloseProductSheet
    • ShowPreviousProduct
    • ShareProductByOption
    • ShareProduct
    • AddToFavorite
    • ProductClicked
  • Project Overview
    • OpenProjectOverview
    • AddToBasket
    • Listening
    • ShareMedia
    • DeleteMedia
    • CloseProjectOverview
    • OpenPrint
    • FormattedPricesRequested
    • FormattedPrices
    • WsMediaDeleted
    • SendUpdatedMedias
3DVIA Documentation
Copyright © 2021 Dassault Systèmes