Input URI
|
{base url} + /db/SWIND |
|---|
JSON Schema
Details
"type": "object",
"required": [
"Assign"
],
"properties": {
"Assign": {
"type": "object",
"description": "Keys are string indices; each value is a SWIND User Type request item.",
"minProperties": 1,
"patternProperties": {
"^[0-9]+$": {
"type": "object",
"description": "SWIND User Type request item. DESC and ADDITIONAL_LOAD are optional. PROFILE and story geometry fields are GET-only and must not be sent in Assign request payloads.",
"required": [
"WIND_CODE",
"SCALE_FACTOR_X",
"SCALE_FACTOR_Y",
"STORY_WIND_PRESSURE"
],
"properties": {
"WIND_CODE": {
"type": "string",
"const": "USER TYPE",
"description": "Wind load code. User Type uses user-defined story wind pressure.",
"enum": [
"USER TYPE"
]
},
"DESC": {
"type": "string",
"default": "",
"description": "Optional description."
},
"WIND_ECCEN_X": {
"type": "integer",
"description": "Wind eccentricity option for X direction.",
"enum": [
0,
1,
2
],
"default": 2
},
"WIND_ECCEN_Y": {
"type": "integer",
"description": "Wind eccentricity option for Y direction.",
"enum": [
0,
1,
2
],
"default": 2
},
"SCALE_FACTOR_X": {
"type": "number",
"description": "Scale factor for X direction."
},
"SCALE_FACTOR_Y": {
"type": "number",
"description": "Scale factor for Y direction."
},
"STORY_WIND_PRESSURE": {
"type": "array",
"description": "User-defined story-level wind pressure list. In request payloads, each item requires STORY_NAME, PRESS_X, and PRESS_Y only.",
"minItems": 1,
"items": {
"type": "object",
"description": "One story-level user-defined wind pressure row for request payloads. ELEV, LOAD_H, LOAD_BX, and LOAD_BY are GET-only and must not be sent.",
"required": [
"STORY_NAME",
"PRESS_X",
"PRESS_Y"
],
"properties": {
"STORY_NAME": {
"type": "string",
"description": "Story name."
},
"PRESS_X": {
"type": "number",
"description": "User-defined wind pressure in X direction."
},
"PRESS_Y": {
"type": "number",
"description": "User-defined wind pressure in Y direction."
}
}
}
},
"ADDITIONAL_LOAD": {
"type": "array",
"description": "Additional story-level wind load list.",
"minItems": 1,
"items": {
"type": "object",
"description": "Additional story-level wind load item.",
"properties": {
"STORY_NAME": {
"type": "string",
"description": "Story name."
},
"ALONG_X": {
"type": "number",
"description": "Additional along-wind load in X direction."
},
"ALONG_Y": {
"type": "number",
"description": "Additional along-wind load in Y direction."
},
"TORSIONAL_RZ": {
"type": "number",
"description": "Additional torsional wind load RZ."
}
}
}
}
}
}
}
}
}
}
Examples
When INPUT_METHOD = 0
{
"Assign": {
"1": {
"WIND_CODE": "KDS(41-12: 2022)",
"DESC": "",
"SCALE_FACTOR_X": 1,
"SCALE_FACTOR_Y": 1,
"PARAMETERS": {
"INPUT_METHOD": 0,
"WIND_SPEED": 34,
"ROOF_HEIGHT": 45,
"CE": 1
},
"ADDITIONAL_LOAD": [
{
"STORY_NAME": "RF",
"ALONG_X": 12.5,
"ALONG_Y": 11.8,
"TORSIONAL_RZ": 2.4
},
{
"STORY_NAME": "15F",
"ALONG_X": 10.7,
"ALONG_Y": 10.1,
"TORSIONAL_RZ": 2.1
},
{
"STORY_NAME": "10F",
"ALONG_X": 8.9,
"ALONG_Y": 8.2,
"TORSIONAL_RZ": 1.7
},
{
"STORY_NAME": "5F",
"ALONG_X": 6.4,
"ALONG_Y": 5.9,
"TORSIONAL_RZ": 1.2
}
]
}
}
}
When INPUT_METHOD = 1
{
"Assign": {
"1": {
"WIND_CODE": "KDS(41-12: 2022)",
"DESC": "",
"SCALE_FACTOR_X": 1,
"SCALE_FACTOR_Y": 1,
"PARAMETERS": {
"INPUT_METHOD": 1,
"EXP_CATEGORY": 0,
"WIND_SPEED": 28,
"IMPORTANCE_FACTOR": 1,
"ROOF_HEIGHT": 60,
"TOPOGRAPHIC_EFFECT": {
"OPT_USE": true,
"KZT": 1
},
"DIRECTION_FACTOR_X": 1,
"DIRECTION_FACTOR_Y": 1,
"RIGIDITY": 0,
"GUST_FACTOR_X": 2.2,
"GUST_FACTOR_Y": 2.2,
"FORCE_COEF": {
"OPT_USE": true,
"FORCE_COEF": 1.3
},
"BUILDING_TYPE": 0,
"VIBRATION_PARAMS": {
"ACROSS_WIND": true,
"TORSIONAL_WIND": true,
"WIND_RESPONSE": true,
"BL_X": 20,
"BL_Y": 33,
"NO_X": 0.17,
"NO_Y": 0.2,
"NO_T": 0.3,
"M": 11090,
"MX": 3700,
"MY": 3700,
"MI": 465000,
"ZF": 0.015,
"VIBRATION_MODE": 0.5
},
"ADDITIONAL_LOAD": [
{
"STORY_NAME": "RF",
"ALONG_X": 28.5,
"ALONG_Y": 26.8,
"ACROSS_X": 9.5,
"ACROSS_Y": 8.8,
"TORSIONAL_RZ_X": 4.2,
"TORSIONAL_RZ_Y": 4
},
{
"STORY_NAME": "30F",
"ALONG_X": 25.2,
"ALONG_Y": 23.7,
"ACROSS_X": 8.4,
"ACROSS_Y": 7.9,
"TORSIONAL_RZ_X": 3.8,
"TORSIONAL_RZ_Y": 3.6
},
{
"STORY_NAME": "20F",
"ALONG_X": 20.4,
"ALONG_Y": 19.1,
"ACROSS_X": 6.9,
"ACROSS_Y": 6.3,
"TORSIONAL_RZ_X": 3,
"TORSIONAL_RZ_Y": 2.8
},
{
"STORY_NAME": "10F",
"ALONG_X": 14.6,
"ALONG_Y": 13.5,
"ACROSS_X": 4.7,
"ACROSS_Y": 4.2,
"TORSIONAL_RZ_X": 2.1,
"TORSIONAL_RZ_Y": 1.9
},
{
"STORY_NAME": "5F",
"ALONG_X": 9.8,
"ALONG_Y": 9.1,
"ACROSS_X": 3.1,
"ACROSS_Y": 2.8,
"TORSIONAL_RZ_X": 1.4,
"TORSIONAL_RZ_Y": 1.3
}
]
}
}
}
}
When INPUT_METHOD = 2
{
"Assign": {
"1": {
"WIND_CODE": "KDS(41-12: 2022)",
"DESC": "",
"SCALE_FACTOR_X": 1,
"SCALE_FACTOR_Y": 1,
"PARAMETERS": {
"INPUT_METHOD": 2,
"ROOF_HEIGHT": 60,
"DM": 20,
"DB": 20,
"N": 0.17,
"M": 11090,
"ZF": 0.015
}
},
"ADDITIONAL_LOAD": [
{
"STORY_NAME": "RF",
"ALONG_X": 18.5,
"ALONG_Y": 17.8,
"TORSIONAL_RZ": 3.6
},
{
"STORY_NAME": "30F",
"ALONG_X": 16.4,
"ALONG_Y": 15.6,
"TORSIONAL_RZ": 3.1
},
{
"STORY_NAME": "20F",
"ALONG_X": 13.2,
"ALONG_Y": 12.4,
"TORSIONAL_RZ": 2.5
},
{
"STORY_NAME": "10F",
"ALONG_X": 9.1,
"ALONG_Y": 8.6,
"TORSIONAL_RZ": 1.8
}
]
}
}
Specifications
| No. | Description | Key | Value Type | Default | Required | |||
|---|---|---|---|---|---|---|---|---|
1 |
Wind load code. |
"WIND_CODE" |
string (enum) |
- |
Required |
|||
2 |
Optional description. |
"DESC" |
string |
Optional |
||||
3 |
Scale factor for X direction. |
"SCALE_FACTOR_X" |
number |
- |
Required |
|||
4 |
Scale factor for Y direction. |
"SCALE_FACTOR_Y" |
number |
- |
Required |
|||
5 |
KDS(41-12:2022) wind parameters. |
"PARAMETERS" |
object |
- |
Required |
|||
(1) |
Input method for KDS(41-12:2022) wind parameters. • 0 : Simplified Method • 1 : General Method • 2 : General Method - Vortex Shedding |
"INPUT_METHOD" |
integer (enum) |
- |
Required |
|||
When INPUT_METHOD = 0 |
||||||||
(1) |
Basic wind speed. |
"WIND_SPEED" |
number |
- |
Required |
|||
(2) |
Roof height. |
"ROOF_HEIGHT" |
number |
system |
Optional |
|||
(3) |
Exposure coefficient. |
"CE" |
number |
1 |
Optional |
|||
When INPUT_METHOD = 1 |
||||||||
(1) |
Exposure category. • 0 : A • 1 : B • 2 : C • 3 : D |
"EXP_CATEGORY" |
integer (enum) |
- |
Required |
|||
(2) |
Basic wind speed. |
"WIND_SPEED" |
number |
- |
Required |
|||
(3) |
Importance factor. |
"IMPORTANCE_FACTOR" |
number |
- |
Required |
|||
(4) |
Roof height. |
"ROOF_HEIGHT" |
number |
system |
Optional |
|||
(5) |
Optional topographic effect. |
"TOPOGRAPHIC_EFFECT" |
object |
- |
Optional |
|||
a |
Whether to use topographic effect. |
"OPT_USE" |
boolean |
false |
Optional |
|||
When TOPOGRAPHIC_EFFECT.OPT_USE = true |
||||||||
a |
Topographic factor. |
"KZT" |
number |
- |
Conditional |
|||
(6) |
Direction factor for X direction. |
"DIRECTION_FACTOR_X" |
number |
1 |
Optional |
|||
(7) |
Direction factor for Y direction. |
"DIRECTION_FACTOR_Y" |
number |
1 |
Optional |
|||
(8) |
Rigidity classification. |
"RIGIDITY" |
integer |
- |
Required |
|||
(9) |
Gust factor for X direction. |
"GUST_FACTOR_X" |
number |
- |
Required |
|||
(10) |
Gust factor for Y direction. |
"GUST_FACTOR_Y" |
number |
- |
Required |
|||
(11) |
Optional force coefficient. |
"FORCE_COEF" |
object |
- |
Optional |
|||
a |
Whether to use user-defined force coefficient. |
"OPT_USE" |
boolean |
false |
Optional |
|||
When FORCE_COEF.OPT_USE = true |
||||||||
a |
Force coefficient value. |
"FORCE_COEF" |
number |
- |
Conditional |
|||
(12) |
Building type. • 0 : Middle Low Rise Building • 1 : High Rise Building |
"BUILDING_TYPE" |
integer (enum) |
- |
Optional |
|||
(13) |
Conditional vibration parameters. |
"VIBRATION_PARAMS" |
object |
- |
Optional |
|||
a |
Across-wind vibration option. |
"ACROSS_WIND" |
boolean |
false |
Optional |
|||
b |
Torsional-wind vibration option. |
"TORSIONAL_WIND" |
boolean |
false |
Optional |
|||
c |
Wind response option. |
"WIND_RESPONSE" |
boolean |
false |
Optional |
|||
d |
Building Length X. |
"BL_X" |
number |
- |
Required |
|||
e |
Building Length Y. |
"BL_Y" |
number |
- |
Required |
|||
f |
Natural frequency in X direction. |
"NO_X" |
number |
- |
Required |
|||
g |
Natural frequency in Y direction. |
"NO_Y" |
number |
- |
Required |
|||
h |
Torsional natural frequency. |
"NO_T" |
number |
- |
Required |
|||
i |
Mass. |
"M" |
number |
system |
Optional |
|||
j |
Mass in X direction. |
"MX" |
number |
system |
Optional |
|||
k |
Mass in Y direction. |
"MY" |
number |
system |
Optional |
|||
l |
Mass moment of inertia. |
"MI" |
number |
system |
Optional |
|||
m |
Damping ratio. |
"ZF" |
number |
- |
Required |
|||
n |
Vibration mode coefficient. |
"VIBRATION_MODE" |
number |
- |
Required |
|||
When INPUT_METHOD = 2 |
||||||||
(1) |
Roof height. If omitted, the product system value is used. |
"ROOF_HEIGHT" |
number |
system |
Optional |
|||
(2) |
Vortex shedding parameter DM. |
"DM" |
number |
- |
Required |
|||
(3) |
Vortex shedding parameter DB. |
"DB" |
number |
- |
Required |
|||
(4) |
Natural frequency for vortex shedding check. |
"N" |
number |
- |
Required |
|||
(5) |
Mass for vortex shedding check. |
"M" |
number |
system |
Optional |
|||
(6) |
Damping ratio for vortex shedding check. |
"ZF" |
number |
- |
Required |
|||
6 |
Additional story-level wind load list. |
"ADDITIONAL_LOAD" |
array [object] |
- |
Optional |
|||
(1) |
Story name. |
"STORY_NAME" |
string |
- |
Required |
|||
(2) |
Additional along-wind load in X direction. |
"ALONG_X" |
number |
- |
Optional |
|||
(3) |
Additional along-wind load in Y direction. |
"ALONG_Y" |
number |
- |
Optional |
|||
(4) |
Additional across-wind load in X direction. |
"ACROSS_X" |
number |
- |
Optional |
|||
(5) |
Additional across-wind load in Y direction. |
"ACROSS_Y" |
number |
- |
Optional |
|||
(6) |
Additional torsional wind load RZ. |
"TORSIONAL_RZ" |
number |
- |
Optional |
|||
(7) |
Additional torsional wind load RZ for X direction. |
"TORSIONAL_RZ_X" |
number |
- |
Optional |
|||
(8) |
Additional torsional wind load RZ for Y direction. |
"TORSIONAL_RZ_Y" |
number |
- |
Optional |
|||