Skip to main content
JSON Manual Created Edited

DESIGN/STEEL/KDS-41-30-2022/CODE-TABLE : Steel Code Check Table

Input URI

{base url} + DESIGN/STEEL/KDS-41-30-2022/CODE-TABLE



Active Methods

POST



JSON Schema

Details

{
  "type""object",
  "required": [
    "Argument"
  ],
  "additionalProperties"false,
  "properties": {
    "Argument": {
      "type""object",
      "required": [
        "TABLE_TYPE"
      ],
      "additionalProperties"false,
      "oneOf": [
        {
          "required": [
            "ELEMS"
          ]
        },
        {
          "required": [
            "SECTIONS"
          ]
        }
      ],
      "properties": {
        "TABLE_TYPE": {
          "type""string",
          "description""Result Table Type",
          "enum": [
            "MEMB",
            "PROP"
          ]
        },
        "ELEMS": {
          "type""object",
          "description""Element No. Input.",
          "additionalProperties"false,
          "properties": {
            "KEYS": {
              "type""array",
              "description""Specify Each ID",
              "items": {
                "type""integer"
              }
            },
            "TO": {
              "type""string",
              "description""Specify ID Range (e.g., '1to160')"
            },
            "STRUCTURE_GROUP_NAME": {
              "type""string",
              "description""Specify Structure Group Name"
            }
          },
          "oneOf": [
            {
              "required": [
                "KEYS"
              ],
              "not": {
                "anyOf": [
                  {
                    "required": [
                      "TO"
                    ]
                  },
                  {
                    "required": [
                      "STRUCTURE_GROUP_NAME"
                    ]
                  }
                ]
              }
            },
            {
              "required": [
                "TO"
              ],
              "not": {
                "anyOf": [
                  {
                    "required": [
                      "KEYS"
                    ]
                  },
                  {
                    "required": [
                      "STRUCTURE_GROUP_NAME"
                    ]
                  }
                ]
              }
            },
            {
              "required": [
                "STRUCTURE_GROUP_NAME"
              ],
              "not": {
                "anyOf": [
                  {
                    "required": [
                      "KEYS"
                    ]
                  },
                  {
                    "required": [
                      "TO"
                    ]
                  }
                ]
              }
            }
          ]
        },
        "SECTIONS": {
          "type""array",
          "description""List of section numbers to include in the table.",
          "items": {
            "type""integer"
          }
        },
        "PRI_SORT": {
          "type""integer",
          "description""Sorting criteria for member-based output (by Section No. or Member No.)",
          "default"1,
          "oneOf": [
            {
              "title""SECT",
              "const"0
            },
            {
              "title""MEMB",
              "const"1
            }
          ]
        },
        "RESULT": {
          "type""integer",
          "description""Filter results by check status",
          "default"0,
          "oneOf": [
            {
              "title""All",
              "const"0
            },
            {
              "title""OK",
              "const"1
            },
            {
              "title""NG",
              "const"2
            }
          ]
        },
        "VIEW_RATPC": {
          "type""boolean",
          "description""Filter to show only members with RatPc greater than 0.4",
          "default"false
        },
        "TABLE_NAME": {
          "type""string",
          "description""Response Table Title",
          "default"""
        },
        "EXPORT_PATH": {
          "type""string",
          "description""Result Table Save Path"
        },
        "UNIT": {
          "type""object",
          "description""Response Unit Setting",
          "properties": {
            "FORCE": {
              "type""string",
              "description""Force unit"
            },
            "DIST": {
              "type""string",
              "description""Length/Distance unit"
            },
            "HEAT": {
              "type""string",
              "description""Heat unit"
            },
            "TEMP": {
              "type""string",
              "description""Temperature unit"
            }
          }
        },
        "STYLES": {
          "type""object",
          "description""Response Number Format",
          "properties": {
            "FORMAT": {
              "type""string",
              "description""Number format",
              "enum": [
                "Default",
                "Fixed",
                "Scientific",
                "General"
              ]
            },
            "PLACE": {
              "type""integer",
              "description""Digit place",
              "minimum"0,
              "maximum"15
            }
          }
        },
        "COMPONENTS": {
          "type""array",
          "description""Components of Result Table",
          "items": {
            "type""string",
            "enum": [
              "CHK",
              "MEMB",
              "COM",
              "SECT",
              "SHR",
              "Section",
              "Material",
              "Fy",
              "LCB",
              "Len",
              "Lb",
              "Ly",
              "Lz",
              "Cb",
              "Ky",
              "Kz",
              "B1y",
              "B1z",
              "B2y",
              "B2z",
              "RatPc",
              "Pu",
              "pPn",
              "Muy",
              "pMny",
              "Muz",
              "pMnz",
              "Vuy",
              "pVny",
              "Vuz",
              "pVnz",
              "Tu",
              "pTn",
              "Def",
              "Defa"
            ]
          }
        }
      }
    }
  }
}


Request Examples

Example

{
  "Argument": {
    "TABLE_TYPE": "PROP",
    "PRI_SORT": 1,
    "RESULT": 0,
    "COMPONENTS": [
      "CHK",
      "MEMB",
      "COM",
      "SECT",
      "SHR",
      "Section",
      "Material",
      "Fy",
      "LCB",
      "Len",
      "Lb",
      "Ly",
      "Lz",
      "Cb",
      "Ky",
      "Kz",
      "B1y",
      "B1z",
      "B2y",
      "B2z",
      "RatPc",
      "Pu",
      "pPn",
      "Muy",
      "pMny",
      "Muz",
      "pMnz",
      "Vuy",
      "pVny",
      "Vuz",
      "pVnz",
      "Tu",
      "pTn",
      "Def",
      "Defa"
    ],
    "ELEMS": {
      "KEYS": [
        888
      ]
    }
  }
}


Response Examples

Example

{
  "Result Table": {
    "FORCE": "KN",
    "DIST": "M",
    "HEAD": [
      "CHK",
      "MEMB",
      "COM",
      "SECT",
      "SHR",
      "Section",
      "Material",
      "Fy",
      "LCB",
      "Len",
      "Lb",
      "Ly",
      "Lz",
      "Cb",
      "Ky",
      "Kz",
      "B1y",
      "B1z",
      "B2y",
      "B2z",
      "RatPc",
      "Pu",
      "pPn",
      "Muy",
      "pMny",
      "Muz",
      "pMnz",
      "Vuy",
      "pVny",
      "Vuz",
      "pVnz",
      "Tu",
      "pTn",
      "Def",
      "Defa"
    ],
    "DATA": [
      [
        "OK",
        "888",
        "0.000",
        "1",
        "0.000",
        "400x600, BT 600x400x6/6",
        "SM355",
        "355000",
        "10",
        "3.25000",
        "3.25000",
        "3.25000",
        "3.25000",
        "1.000",
        "1.000",
        "1.000",
        "1.000",
        "1.000",
        "1.000",
        "1.000",
        "0.000",
        "0.00000",
        "1905.50",
        "0.00000",
        "150.596",
        "0.00000",
        "51.1371",
        "0.00000",
        "460.080",
        "0.00000",
        "73.9731",
        "-",
        "-",
        "-",
        "-"
      ]
    ]
  }
}


Specifications

Keyed Object Entry

No. Description Key Value Type Default Required

Root Object

1

Map of keyed objects where each key is a string identifier.

"Argument"

object

-

Required



Item (Value Object Schema)

No. Description Key Value Type Default Required

General

1

Table Type

• MEMB: "MEMB"

• PROP: "PROP"

"TABLE_TYPE"

string

-

Required

oneOf Choose exactly one of the following keys: "ELEMS" or "SECTIONS".

2

Element No.

Use either ELEMS or SECTIONS, not both.

"ELEMS"

object

-

Optional

oneOf Choose exactly one of the following keys: "KEYS", "TO", or "STRUCTURE_GROUP_NAME".

2.1

Specify Each ID

"KEYS"

Array [integer]

-

Optional

2.2

Specify ID Range

"TO"

string

-

Optional

2.3

Structure Group Name

"STRUCTURE_GROUP_NAME"

string

-

Optional

3

Section Numbers

Use either ELEMS or SECTIONS, not both.

"SECTIONS"

Array [integer]

-

Optional

4

Primary Sorting Option

• SECT: "0"

• MEMB: "1"

"PRI_SORT"

integer

1

Optional

5

Result View Option

• All: "0"

• OK: "1"

• NG: "2"

"RESULT"

integer

0

Optional

6

View RatPc > 0.4

"VIEW_RATPC"

boolean

false

Optional

7

Table Name

Output table title in response

"TABLE_NAME"

string

""

Optional

8

Export Path

Optional: Save results to file path

"EXPORT_PATH"

string

-

Optional

9

Unit Settings

"UNIT"

object

System

Optional

9.1

Force unit

"FORCE"

string

-

Optional

9.2

Length/Distance unit

"DIST"

string

-

Optional

9.3

Heat unit

"HEAT"

string

-

Optional

9.4

Temperature unit

"TEMP"

string

-

Optional

10

Number Format

"STYLES"

object

System

Optional

10.1

Number format

• Default: "Default"

• Fixed: "Fixed"

• Scientific: "Scientific"

• General: "General"

"FORMAT"

string

-

Optional

10.2

Digit place

Constraints:

• Value Range: >= 0, <= 15

"PLACE"

integer

-

Optional

11

Components

• Strength Check Result: "CHK"

• Member Number: "MEMB"

• Max Combined Interaction Ratio: "COM"

• Section Number: "SECT"

• Shear Stress Ratio: "SHR"

• Section Name: "Section"

• Material Name: "Material"

• Yield Strength: "Fy"

• Critical Load Combination No.: "LCB"

• Member Length: "Len"

• Lateral Bracing Length: "Lb"

• Unbraced Length: "Ly"

• Unbraced Length: "Lz"

• Bending Coefficient: "Cb"

• Effective Length Factor: "Ky"

• Effective Length Factor: "Kz"

• Moment Magnification Factor B1: "B1y"

• Moment Magnification Factor B1: "B1z"

• Moment Magnification Factor B2: "B2y"

• Moment Magnification Factor B2: "B2z"

• Axial Strength Ratio: "RatPc"

• Required Axial Strength: "Pu"

• Design Axial Strength: "pPn"

• Required Flexural Strength: "Muy"

• Design Flexural Strength φMny: "pMny"

• Required Flexural Strength: "Muz"

• Design Flexural Strength φMnz: "pMnz"

• Required Shear Strength: "Vuy"

• Design Shear Strength φVny: "pVny"

• Required Shear Strength: "Vuz"

• Design Shear Strength φVnz: "pVnz"

• Required Torsional Strength: "Tu"

• Design Torsional Strength: "pTn"

• Serviceability Deflection: "Def"

• Allowable Deflection: "Defa"

"COMPONENTS"

Array [string]

-

Optional



0
Was this article helpful?