Set Up Openings through API

 

➡️ See the API Reference documentation 🔗 for detailed information.

Parameters

❗️ Following parameters need to be set up in parameters key of the product.

Set Up the Dimensions of the Openings

Parameter	Type	Possible values
width	real	[0 ;∞]
depth	real	[0 ;∞]
height	real	[0 ;∞]

"width": {
    "typeID": 1,
    "values": [
        133
    ],
    "editable": null,
    "translation": {
        "name": {
            "1": "Longueur",
            "2": "Width",
            "3": "Anchura",
            "4": "Breite"
        },
        "values": {
            "2": {
                "133": "133"
            }
        }
    },
    "defaultValue": 133
}

Set Up the Opening Side of the Openings

Parameter	Type	Possible values
opening_side	boolean	[TRUE ; FALSE]

"opening_side": {
    "typeID": 3,
    "editable": "RW",
    "translation": {
        "name": {
            "1": "Opening side",
            "2": "Opening side",
            "3": "Opening side",
            "4": "Opening side"
        }
    },
    "defaultValue": 1
},

Set Up the Installation Position of the Openings

Parameter	Type	Possible values
installation_position	boolean	[-1 ;1]

"installation_position": {
    "max": 1,
    "min": -1,
    "step": 0.1,
    "typeID": 2,
    "editable": null,
    "translation": {
        "name": {
            "2": "installation_position"
        }
    },
    "defaultValue": 0
}

---

Behaviors

❗️ Following values need to be set up in behaviors key of the product.

Specify the defaultAltitude behavior

Key Name	Key Type	Possible Values
defaultAltitude	real	[0 ;∞]

Specify the targetPositionID behavior

Key Name	Key Type	Possible Values
targetPositionID	integer	[1,2,4,8,16,32,64]

Partial behaviors sample

"behaviors": {
    "targetPositionID": 2,
    "defaultAltitude": 180,
  },

➡️ Click here 🔗 to open the complete definition of product behaviors.