Skip to main content
JSON Manual Created Edited

Settlement Load Cases

Input URI

{base url} + db/SMLC



Active Methods

POST, GET, PUT, DELETE



JSON Schema

Details

{
    "SMLC": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "properties": {
            "NAME": {
                "description": "SettlementLoadCaseName",
                "type": "string"
            },
            "DESC": {
                "description": "SettlementLoadCaseDescription",
                "type": "string"
            },
            "FACTOR": {
                "description": "SettlementScaleFactor",
                "type": "number"
            },
            "MIN": {
                "description": "SettlementMin",
                "type": "integer"
            },
            "MAX": {
                "description": "SettlementMax",
                "type": "integer"
            },
            "ST_GROUPS": {
                "description": "SettlementGroups(Const)",
                "type": "array",
                "items": {
                    "type": "string"
                }
            }
        }
    }
}


Examples

Settlement Load Cases

{
    "Assign": {
        "1": {
            "NAME": "SMLC1",
            "DESC": "",
            "FACTOR": 1.2,
            "MIN": 1,
            "MAX": 1,
            "ST_GROUPS": [
                "SG1",
                "SG2"
            ]
        },
        "2": {
            "NAME": "SMLC2",
            "DESC": "",
            "FACTOR": 1,
            "MIN": 1,
            "MAX": 1,
            "ST_GROUPS": [
                "SG1",
                "SG2"
            ]
        }
    }
}


Specifications

No. Description Key Value Type Default Required

1

Settlement Load Case No.

"KEY"

Integer

-

Required

2

Settlement Load Case Name

"NAME"

String

-

Required

3

Description

"DESC"

String

-

Required

4

Settlement Scale Factor

"FACTOR"

Number

-

Required

5

Settlement - Min. Group Nos.

"MIN"

Integer

-

Required

6

Settlement - Max. Group Nos.

"MAX"

Integer

-

Required

7

Selected Settlement Group Name

"ST_GROUPS"

Array
[String]

-

Required



0
Was this article helpful?