Skip to main content
JSON Manual Created Edited

DESIGN/STEEL/KDS-41-30-2022/CODE-ANAL : Steel Code Check Perform

Input URI

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



Active Methods

POST



JSON Schema

Details

{
  "type""object",
  "required": [
    "Argument"
  ],
  "additionalProperties"false,
  "properties": {
    "Argument": {
      "type""object",
      "description""Execute design calculation",
      "additionalProperties"false,
      "oneOf": [
        {
          "required": [
            "ELEMS"
          ]
        },
        {
          "required": [
            "SECTIONS"
          ]
        }
      ],
      "properties": {
        "PERFORM_TYPE": {
          "type""string",
          "description""Select target type for design calculation.",
          "oneOf": [
            {
              "title""All Elements",
              "const""ALL"
            },
            {
              "title""By Element No.",
              "const""ELEMS"
            },
            {
              "title""By Section No.",
              "const""SECTIONS"
            }
          ],
          "default""ALL"
        },
        "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""Section No. Input.",
          "items": {
            "type""integer"
          }
        }
      }
    }
  }
}


Request Examples

Example

{
  "Argument": {
    "PERFORM_TYPE": "ALL"
  }
}


Response Examples

Example

{
  "message": "success"
}


Specifications

Keyed Object Entry

No. Description Key Value Type Default Required

Root Object

1

Execute design calculation

"Argument"

object

-

Required



Item (Value Object Schema)

No. Description Key Value Type Default Required

General

1

Perform Target

• All Elements: "ALL"

• By Element No.: "ELEMS"

• By Section No.: "SECTIONS"

"PERFORM_TYPE"

string

"ALL"

Optional

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 No.

Use either ELEMS or SECTIONS, not both.

"SECTIONS"

Array [integer]

-

Optional



0
Was this article helpful?