Supported Formats

json, xml

Errors

Code Description
401 Unauthorized - ensure token is being passed with each service call.
404 Unsupported operation
500 Unspecified error on server.

Params

Param name Description
window_layout_id
required

Window Layout ID. Specifies type of window layout to create. Must be greater than or equal to 0

Validations:

  • Must be a Integer

wall_id
optional

ID of wall assigned to this surface.

Validations:

  • Must be a Integer

window_id
optional

ID of window assigned to this surface.

Validations:

  • Must be a Integer

window_wall_ratio
optional

Window-to-wall ratio. Must be less than 0.95

Validations:

  • Must be a Float

edge_offset
optional

Edge Offset. Must be greater than or equal to 0

Validations:

  • Must be a Float

sill_height
optional

Sill Height. Must be between 0-6

Validations:

  • Must be a Float

shading_type_id
optional

Shading Type ID. Must be greater than or equal to 0

Validations:

  • Must be a Integer

number_of_windows
optional

Number of windows. Must be greater than or equal to 1

Validations:

  • Must be a Integer

width
optional

Width. Must be greater than or equal to 0

Validations:

  • Must be a Float

height
optional

Height. Must be greater than or equal to 0

Validations:

  • Must be a Float

overhang_height_above_window
optional

Overhang Height above window. Must be between 0-2

Validations:

  • Must be a Float

overhang_depth
optional

Overhang depth. Must be greater than or equal to 0

Validations:

  • Must be a Float

fin_depth
optional

Fin Depth. Must be greater than or equal to 0

Validations:

  • Must be a Float

fin_distance_between
optional

Distance between fins. Must be greater than or equal to 0

Validations:

  • Must be a Float

light_shelf_distance_from_top
optional

Light shelf distance from top. Must be greater than or equal to 0

Validations:

  • Must be a Float

light_shelf_ext_protrusion
optional

Light shelf exterior protrusion. Must be greater than or equal to 0

Validations:

  • Must be a Float

light_shelf_int_protrusion
optional

Light shelf internal protrusion. Must be greater than or equal to 0

Validations:

  • Must be a Float

window_width
optional

Window width. Must be greater than or equal to 0

Validations:

  • Must be a Float

window_height
optional

Window height. Must be greater than or equal to 0

Validations:

  • Must be a Float

daylight_controls
optional

True if daylight controls are used for this surface, false otherwise

Validations:

  • Must be one of: true, false.