Input URI
|
{base url} + /db/SSEIS |
|---|
Active Methods
|
POST, GET, PUT, DELETE |
|---|
JSON Schema
Details
"type": "object",
"required": [
"Assign"
],
"properties": {
"Assign": {
"type": "object",
"description": "Keys are string indices; each value is a USER TYPE SSEIS request item.",
"minProperties": 1,
"patternProperties": {
"^[0-9]+$": {
"type": "object",
"description": "SSEIS USER TYPE request item. DESC, ACCIDENT_ECCEN_X, ACCIDENT_ECCEN_Y, ACCIDENT_TORSION, IINHERENT_TORSION, and ADDITIONAL_LOAD are optional. PROFILE is GET-only and must not be sent in Assign request payloads.",
"required": [
"SEIS_CODE",
"SCALE_FACTOR_X",
"SCALE_FACTOR_Y",
"SEISMIC_FORCE"
],
"properties": {
"SEIS_CODE": {
"type": "string",
"const": "USER TYPE",
"description": "Seismic load code. This schema is for user-defined seismic force input.",
"enum": [
"USER TYPE"
]
},
"DESC": {
"type": "string",
"default": "",
"description": "Optional description."
},
"SCALE_FACTOR_X": {
"type": "number",
"description": "Scale factor for X direction."
},
"SCALE_FACTOR_Y": {
"type": "number",
"description": "Scale factor for Y direction."
},
"ACCIDENT_ECCEN_X": {
"type": "integer",
"default": 0,
"description": "Accidental eccentricity option for X direction.",
"enum": [
0,
1,
2
]
},
"ACCIDENT_ECCEN_Y": {
"type": "integer",
"default": 0,
"description": "Accidental eccentricity option for Y direction.",
"enum": [
0,
1,
2
]
},
"ACCIDENT_TORSION": {
"type": "boolean",
"default": false,
"description": "Whether to consider accidental torsion."
},
"SEISMIC_FORCE": {
"type": "array",
"description": "User-defined story-level seismic force list.",
"minItems": 1,
"items": {
"type": "object",
"description": "One user-defined story-level seismic force row for request. STORY_NAME, FORCE_X, and FORCE_Y are required.",
"required": [
"STORY_NAME",
"FORCE_X",
"FORCE_Y"
],
"properties": {
"STORY_NAME": {
"type": "string",
"description": "Story name."
},
"FORCE_X": {
"type": "number",
"description": "User-defined seismic force in X direction."
},
"FORCE_Y": {
"type": "number",
"description": "User-defined seismic force in Y direction."
}
}
}
},
"ADDITIONAL_LOAD": {
"type": "object",
"description": "Additional story-level seismic load.",
"required": [
"STORY_NAME",
"ALONG_X",
"ALONG_Y",
"TORSIONAL_RZ"
],
"properties": {
"STORY_NAME": {
"type": "string",
"description": "Story name."
},
"ALONG_X": {
"type": "number",
"description": "Additional seismic load in X direction."
},
"ALONG_Y": {
"type": "number",
"description": "Additional seismic load in Y direction."
},
"TORSIONAL_RZ": {
"type": "number",
"description": "Additional torsional seismic load RZ."
}
}
},
"INHERENT_TORSION": {
"type": "boolean",
"default": false,
"description": "Whether to consider inherent torsion."
}
}
}
}
}
}
}
Examples
Static Seismic Load (KDS 2019)
{
"Assign": {
"1": {
"SEIS_CODE": "KDS(41-17-00: 2019)",
"DESC": "",
"SCALE_FACTOR_X": 1,
"SCALE_FACTOR_Y": 1,
"ACCIDENT_ECCEN_X": 0,
"ACCIDENT_ECCEN_Y": 0,
"ACCIDENT_TORSION": true,
"PARAMETERS": {
"SEIS_ZONE": 0,
"EPA": 0.22,
"SITE_CLASS": 3,
"FA": 1.36,
"FV": 1.96,
"SDS": 0.49867,
"SD1": 0.28747,
"SEIS_USE_GROUP": 1,
"IMPORTANCE_FACTOR": 1.2,
"PERIOD_METHOD": 0,
"PERIOD_ANALYSIS_X": 1.82,
"PERIOD_ANALYSIS_Y": 1.82,
"PERIOD_APPR_X": 1.53,
"PERIOD_APPR_Y": 1.53,
"RESPONSE_MOD_FACTOR_X": 4,
"RESPONSE_MOD_FACTOR_Y": 4
},
"ADDITIONAL_LOAD": {
"STORY_NAME": "RF",
"ALONG_X": 85,
"ALONG_Y": 72,
"TORSIONAL_RZ": 18.5
}
}
}
}
Specifications
| No. | Description | Key | Value Type | Default | Required | |||
|---|---|---|---|---|---|---|---|---|
1 |
Seismic load code |
"SEIS_CODE" |
string (enum) |
- |
Required |
|||
2 |
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 |
Accidental eccentricity option for X direction. • 0 : Positive • 1 : Negative • 2 : None |
"ACCIDENT_ECCEN_X" |
integer (enum) |
0 |
Optional |
|||
6 |
Accidental eccentricity option for Y direction. • 0 : Positive • 1 : Negative • 2 : None |
"ACCIDENT_ECCEN_Y" |
integer (enum) |
0 |
Optional |
|||
7 |
Whether to consider accidental torsion. |
"ACCIDENT_TORSION" |
boolean |
false |
Optional |
|||
8 |
KDS(41-17-00:2019) seismic parameters. |
"PARAMETERS" |
object |
- |
Required |
|||
(1) |
Seismic zone. • 0 : Zone 1 • 1 : Zone 2 |
"SEIS_ZONE" |
integer (enum) |
- |
Required |
|||
(2) |
Effective peak acceleration. |
"EPA" |
number |
- |
Required |
|||
(3) |
Site class. • 0 : S1 • 1 : S2 • 2 : S3 • 3 : S4 • 4 : S5 • 5 : S6 |
"SITE_CLASS" |
integer (enum) |
- |
Required |
|||
(4) |
Short-period site coefficient. |
"FA" |
number |
system |
Optional |
|||
(5) |
Long-period site coefficient. |
"FV" |
number |
system |
Optional |
|||
(6) |
Design spectral response acceleration at short period. |
"SDS" |
number |
system |
Optional |
|||
(7) |
Design spectral response acceleration at 1-second period. |
"SD1" |
number |
system |
Optional |
|||
(8) |
Seismic use group. • 0 : Special • 1 : I • 2 : II |
"SEIS_USE_GROUP" |
integer (enum) |
- |
Required |
|||
(9) |
Importance factor. |
"IMPORTANCE_FACTOR" |
number |
- |
Required |
|||
(10) |
Period input method. • 0 : Analytical Period • 1 : Approximate Period |
"PERIOD_METHOD" |
integer (enum) |
- |
Required |
|||
When PERIOD_METHOD = 0 |
||||||||
(1) |
Analytical period for X direction. |
"PERIOD_ANALYSIS_X" |
number |
- |
Required |
|||
(2) |
Analytical period for Y direction. |
"PERIOD_ANALYSIS_Y" |
number |
- |
Required |
|||
(3) |
Approximate period for X direction. |
"PERIOD_APPR_X" |
number |
- |
Required |
|||
(4) |
Approximate period for Y direction. |
"PERIOD_APPR_Y" |
number |
- |
Required |
|||
When PERIOD_METHOD = 1 |
||||||||
(1) |
Approximate period for X direction. |
"PERIOD_APPR_X" |
number |
- |
Required |
|||
(2) |
Approximate period for Y direction. |
"PERIOD_APPR_Y" |
number |
- |
Required |
|||
(3) |
Response modification factor for X direction. |
"RESPONSE_MOD_FACTOR_X" |
number |
- |
Required |
|||
(4) |
Response modification factor for Y direction. |
"RESPONSE_MOD_FACTOR_Y" |
number |
- |
Required |
|||
9 |
Additional story-level seismic load. |
"ADDITIONAL_LOAD" |
object |
- |
Optional |
|||
(1) |
Story name. |
"STORY_NAME" |
string |
- |
Required |
|||
(2) |
Additional seismic load in X direction. |
"ALONG_X" |
number |
- |
Required |
|||
(3) |
Additional seismic load in Y direction. |
"ALONG_Y" |
number |
- |
Required |
|||
(4) |
Additional torsional seismic load RZ. |
"TORSIONAL_RZ" |
number |
- |
Required |
|||