Input URI
|
{base url} + DB/SWIND |
|---|
JSON Schema
Details
{
"type": "object",
"additionalProperties": false,
"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",
"additionalProperties": false,
"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",
"additionalProperties": false,
"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",
"additionalProperties": false,
"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."
}
}
}
}
}
}
},
"additionalProperties": false
}
}
}
Examples
Static Wind Load - User Type
{
"Assign": {
"1": {
"LC_NAME": "WX",
"WIND_CODE": "USER TYPE",
"DESC": "",
"WIND_ECCEN_X": 2,
"WIND_ECCEN_Y": 2,
"SCALE_FACTOR_X": 1,
"SCALE_FACTOR_Y": 1,
"STORY_WIND_PRESSURE": [
{
"STORY_NAME": "RF",
"PRESS_X": 1.2,
"PRESS_Y": 1
},
{
"STORY_NAME": "3F",
"PRESS_X": 1,
"PRESS_Y": 0.8
},
{
"STORY_NAME": "2F",
"PRESS_X": 0.8,
"PRESS_Y": 0.6
},
{
"STORY_NAME": "1F",
"PRESS_X": 0.6,
"PRESS_Y": 0.4
}
],
"ADDITIONAL_LOAD": [
{
"STORY_NAME": "RF",
"ALONG_X": 10,
"ALONG_Y": 8,
"TORSIONAL_RZ": 2.5
},
{
"STORY_NAME": "3F",
"ALONG_X": 7,
"ALONG_Y": 5,
"TORSIONAL_RZ": 1.5
}
]
}
}
}
Specifications
| No. | Description | Key | Value Type | Default | Required | |||
|---|---|---|---|---|---|---|---|---|
1 |
Wind load code. User Type uses user-defined story wind pressure. • USER TYPE : User Type |
"WIND_CODE" |
string (enum) |
- |
Required |
|||
2 |
Optional description. |
"DESC" |
string |
Optional |
||||
3 |
Wind eccentricity option for X direction. • 0 : Positive • 1 : Negative • 2 : None |
"WIND_ECCEN_X" |
integer (enum) |
2 |
Optional |
|||
4 |
Wind eccentricity option for Y direction. • 0 : Positive • 1 : Negative • 2 : None |
"WIND_ECCEN_Y" |
integer (enum) |
2 |
Optional |
|||
5 |
Scale factor for X direction. |
"SCALE_FACTOR_X" |
number |
- |
Required |
|||
6 |
Scale factor for Y direction. |
"SCALE_FACTOR_Y" |
number |
- |
Required |
|||
7 |
User-defined story-level wind pressure list. |
"STORY_WIND_PRESSURE" |
array [object] |
- |
Required |
|||
(1) | Story name. |
"STORY_NAME" |
string |
- |
Required |
|||
(2) | User-defined wind pressure in X direction. |
"PRESS_X" |
number |
- |
Required |
|||
(3) | User-defined wind pressure in Y direction. |
"PRESS_Y" |
number |
- |
Required |
|||
8 |
Additional story-level wind load list. |
"ADDITIONAL_LOAD" |
array [object] |
- |
Optional |
|||
(1) | Story name. |
"STORY_NAME" |
string |
- |
Optional |
|||
(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 torsional wind load RZ. |
"TORSIONAL_RZ" |
number |
- |
Optional |
|||