Input URI
|
{base url} + /ope/GUSTFACTOR |
|---|
Active Methods
|
POST |
|---|
JSON Schema
Details
"type": "object",
"required": [
"Argument"
],
"properties": {
"Argument": {
"type": "object",
"description": "GUSTFACTOR request item. STRUCTURE_TYPE controls whether RIGID_PARAM or FLEXIBLE_PARAM is required.",
"required": [
"WIND_CODE",
"STRUCTURE_TYPE"
],
"properties": {
"WIND_CODE": {
"type": "string",
"enum": [
"KDS(41-12:2022)"
]
},
"STRUCTURE_TYPE": {
"type": "string",
"enum": [
"RIGID",
"FLEXIBLE"
],
"description": "Structure type classification."
},
"RIGID_PARAM": {
"type": "object",
"required": [
"EXP_CATEGORY",
"ROOF_HEIGHT",
"BREADTH_X",
"BREADTH_Y"
],
"properties": {
"EXP_CATEGORY": {
"type": "string",
"description": "Exposure category."
},
"ROOF_HEIGHT": {
"type": "number",
"minimum": 0,
"description": "Roof height."
},
"BREADTH_X": {
"type": "number",
"minimum": 0,
"description": "Plan breadth in global X direction."
},
"BREADTH_Y": {
"type": "number",
"minimum": 0,
"description": "Plan breadth in global Y direction."
}
}
},
"FLEXIBLE_PARAM": {
"type": "object",
"required": [
"EXP_CATEGORY",
"BASIC_WIND_SPEED",
"IMPORTANCE_FACTOR",
"DIRECTION_FACTOR_X",
"DIRECTION_FACTOR_Y",
"BREADTH_X",
"BREADTH_Y",
"STORY_HEIGHT_MAX",
"FREQUENCY_X",
"FREQUENCY_Y",
"DAMPING",
"TOTAL_MASS",
"MX",
"MY",
"VIBRATION"
],
"properties": {
"EXP_CATEGORY": {
"type": "string",
"description": "Exposure category."
},
"BASIC_WIND_SPEED": {
"type": "number",
"minimum": 0,
"description": "Basic wind speed."
},
"IMPORTANCE_FACTOR": {
"type": "number",
"minimum": 0,
"description": "Importance factor."
},
"TOPOGRAPHIC_EFFECT": {
"type": "object",
"required": [
"OPT_USE"
],
"properties": {
"OPT_USE": {
"type": "boolean",
"default": false,
"description": "Whether to use topographic effect."
},
"KZT": {
"type": "number",
"minimum": 0,
"description": "Topographic factor Kzt. Required only if OPT_USE=true."
}
},
"description": "Optional. If omitted, treated as OPT_USE=false."
},
"DIRECTION_FACTOR_X": {
"type": "number",
"minimum": 0,
"description": "Direction factor in X."
},
"DIRECTION_FACTOR_Y": {
"type": "number",
"minimum": 0,
"description": "Direction factor in Y."
},
"BREADTH_X": {
"type": "number",
"minimum": 0,
"description": "Plan breadth in global X direction."
},
"BREADTH_Y": {
"type": "number",
"minimum": 0,
"description": "Plan breadth in global Y direction."
},
"STORY_HEIGHT_MAX": {
"type": "number",
"minimum": 0,
"description": "Maximum story or roof height used for flexible response."
},
"FREQUENCY_X": {
"type": "number",
"minimum": 0,
"description": "Fundamental frequency in X."
},
"FREQUENCY_Y": {
"type": "number",
"minimum": 0,
"description": "Fundamental frequency in Y."
},
"DAMPING": {
"type": "number",
"minimum": 0,
"description": "Damping ratio, for example 0.03."
},
"TOTAL_MASS": {
"type": "number",
"minimum": 0,
"description": "Total mass."
},
"MX": {
"type": "number",
"minimum": 0,
"description": "Mass term in X."
},
"MY": {
"type": "number",
"minimum": 0,
"description": "Mass term in Y."
},
"VIBRATION": {
"type": "number",
"minimum": 0,
"description": "Vibration-related factor or flag."
}
}
}
}
}
}
}
Request Examples
Example
"Argument": {
"WIND_CODE": "KDS(41-12:2022)",
"STRUCTURE_TYPE": "FLEXIBLE",
"FLEXIBLE_PARAM": {
"EXP_CATEGORY": "B",
"BASIC_WIND_SPEED": 38,
"IMPORTANCE_FACTOR": 1,
"TOPOGRAPHIC_EFFECT": {
"OPT_USE": true,
"KZT": 1.1
},
"DIRECTION_FACTOR_X": 0.85,
"DIRECTION_FACTOR_Y": 0.85,
"BREADTH_X": 32,
"BREADTH_Y": 24,
"STORY_HEIGHT_MAX": 72,
"FREQUENCY_X": 0.42,
"FREQUENCY_Y": 0.48,
"DAMPING": 0.03,
"TOTAL_MASS": 85000,
"MX": 82000,
"MY": 80500,
"VIBRATION": 1
}
}
}
Response Examples
Example
"OPE_GUSTFACTOR_RESPONSE": {
"GUST_FACTOR_X": 1.7400999942907864,
"GUST_FACTOR_Y": 1.7513941589768178
}
}
Specifications
Keyed Object Entry
| No. | Description | Key | Value Type | Default | Required | |||
|---|---|---|---|---|---|---|---|---|
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 | |||
|---|---|---|---|---|---|---|---|---|
1 |
WIND_CODE • KDS(41-12:2022) |
"WIND_CODE" |
string (enum) |
- |
Required |
|||
2 |
Structure type classification. • RIGID • FLEXIBLE |
"STRUCTURE_TYPE" |
string (enum) |
- |
Required |
|||
When "STRUCTURE_TYPE" is RIGID | ||||||||
1 |
Parameters |
"RIGID_PARAM" |
object |
- |
Conditional |
|||
(1) | Exposure category. |
"EXP_CATEGORY" |
string |
- |
Required |
|||
(2) | Roof height. |
"ROOF_HEIGHT" |
number |
- |
Required |
|||
(3) | Plan breadth in global X direction. |
"BREADTH_X" |
number |
- |
Required |
|||
(4) | Plan breadth in global Y direction. |
"BREADTH_Y" |
number |
- |
Required |
|||
When "STRUCTURE_TYPE" is FLEXIBLE | ||||||||
1 |
Parameters |
"FLEXIBLE_PARAM" |
object |
- |
Conditional |
|||
(1) | Exposure category. |
"EXP_CATEGORY" |
string |
- |
Required |
|||
(2) | Basic wind speed (m/s). |
"BASIC_WIND_SPEED" |
number |
- |
Required |
|||
(3) | Importance factor. |
"IMPORTANCE_FACTOR" |
number |
- |
Required |
|||
(4) | Topographic effect. |
"TOPOGRAPHIC_EFFECT" |
object |
- |
Optional |
|||
a | Whether to use topographic effect. |
"OPT_USE" |
boolean |
false |
Required |
|||
When "TOPOGRAPHIC_EFFECT.OPT_USE" is true | ||||||||
a | Topographic factor. |
"KZT" |
number |
- |
Required |
|||
(5) | Direction factor in X. |
"DIRECTION_FACTOR_X" |
number |
- |
Required |
|||
(6) | Direction factor in Y. |
"DIRECTION_FACTOR_Y" |
number |
- |
Required |
|||
(7) | Plan breadth in global X direction. |
"BREADTH_X" |
number |
- |
Required |
|||
(8) | Plan breadth in global Y direction. |
"BREADTH_Y" |
number |
- |
Required |
|||
(9) | Maximum story/roof height used for flexible response. |
"STORY_HEIGHT_MAX" |
number |
- |
Required |
|||
(10) | Fundamental frequency in X (Hz). |
"FREQUENCY_X" |
number |
- |
Required |
|||
(11) | Fundamental frequency in Y (Hz). |
"FREQUENCY_Y" |
number |
- |
Required |
|||
(12) | Damping ratio. |
"DAMPING" |
number |
- |
Required |
|||
(13) | Total mass. |
"TOTAL_MASS" |
number |
- |
Required |
|||
(14) | Mass term in X. |
"MX" |
number |
- |
Required |
|||
(15) | Mass term in Y. |
"MY" |
number |
- |
Required |
|||
(16) | Vibration-related factor. |
"VIBRATION" |
number |
- |
Required |
|||