Skip to main content
JSON Manual Created Edited

Finishing Material Loads

Input URI

{base url} + db/FMLD



Active Methods

POST, GET, PUT, DELETE



JSON Schema

Details

{
    "FMLD": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "properties": {
            "ITEMS": {
                "description": "Items",
                "type": "array",
                "items": {
                    "type": "object",
                    "properties": {
                        "ID": {
                            "description": "ID",
                            "type": "integer"
                        },
                        "LCNAME": {
                            "description": "LoadCaseName",
                            "type": "string"
                        },
                        "GROUP_NAME": {
                            "description": "LoadGroupName",
                            "type": "string"
                        },
                        "COVERING_TYPE": {
                            "description": "CoveringType",
                            "type": "string"
                        },
                        "COVERING_RANGE": {
                            "description": "CoveringRange(Face)",
                            "type": "array",
                            "items": {
                                "type": "string"
                            }
                        },
                        "THICKNESS": {
                            "description": "Thickness",
                            "type": "number"
                        },
                        "DENSITY": {
                            "description": "Density",
                            "type": "number"
                        },
                        "DIR": {
                            "description": "Direction",
                            "type": "string"
                        },
                        "SCALE_FACTOR": {
                            "description": "ScaleFactor",
                            "type": "number"
                        }
                    }
                }
            }
        }
    }
}


Examples

Finishing Material Loads

{
    "Assign": {
        "448": {
            "ITEMS": [
                {
                    "ID": 1,
                    "LCNAME": "FMLD_examples",
                    "GROUP_NAME": "LoadGroups",
                    "COVERING_TYPE": "ENVELOP",
                    "COVERING_RANGE": [
                        "HALF",
                        "HALF",
                        "FULL",
                        "FULL"
                    ],
                    "THICKNESS": 0.2,
                    "DENSITY": 24.5,
                    "DIR": "GZ",
                    "SCALE_FACTOR": -1
                },
                {
                    "ID": 2,
                    "LCNAME": "FMLD_examples",
                    "GROUP_NAME": "LoadGroups",
                    "COVERING_TYPE": "FILL",
                    "COVERING_RANGE": [
                        "HALF",
                        "HALF",
                        "FULL",
                        "FULL"
                    ],
                    "THICKNESS": 0.2,
                    "DENSITY": 24.5,
                    "DIR": "GZ",
                    "SCALE_FACTOR": -1
                },
                {
                    "ID": 3,
                    "LCNAME": "FMLD_examples",
                    "GROUP_NAME": "LoadGroups",
                    "COVERING_TYPE": "SURROUND",
                    "COVERING_RANGE": [
                        "HALF",
                        "HALF",
                        "FULL",
                        "FULL"
                    ],
                    "THICKNESS": 0.2,
                    "DENSITY": 24.5,
                    "DIR": "GZ",
                    "SCALE_FACTOR": -1
                }
            ]
        }
    }
}


Specifications

No. Description Key Value Type Default Required

1

Finishing Material Loads

 • Insert the data as an object

"ITEMS"

Array
[Object]

-

Required

(1)

Serial Number

"ID"

Integer

0

Optional

(2)

Load Case Name

"LCNAME"

String

-

Required

(3)

Load Group Name

"GROUP_NAME"

String

Blank

Optional

(4)

Covering Type

 • Envelop: "ENVELOP"

 • Fill: "FILL"

 • Surround: "SURROUND"

"COVERING_TYPE"

String

"ENVELOP"

Optional

(5)

Covering Range

 • Full: "FULL"

 • Half: "HALF"

 • [+x dir. face, -y dir. face, -x dir. face, +y dir. face]

"COVERING_RANGE"

Array
[String, 4]

-

Required

(6)

Covering Thickness (d)

"THICKNESS"

Number

0

Optional

(7)

Filling Property (Density)

"DENSITY"

Number

0

Optional

(8)

Direction

 • Global X: "GX"

 • Global Y: "GY"

 • Global Z: "GZ"

"DIR"

String

"GZ"

Optional

(9)

Scale Factor

"SCALE_FACTOR"

Number

0

Required



0
Was this article helpful?