Input URI
|
{base url} + DB/SSEIS |
|---|
JSON Schema
Details
{
"type": "object",
"additionalProperties": false,
"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",
"additionalProperties": false,
"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",
"additionalProperties": false,
"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",
"additionalProperties": false,
"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."
}
}
},
"IIINHERENT_TORSION": {
"type": "boolean",
"default": false,
"description": "Whether to consider inherent torsion."
}
}
}
},
"additionalProperties": false
}
}
}
Examples
Static Seismic Load - User Type
{
"Assign": {
"1": {
"SEIS_CODE": "USER TYPE",
"DESC": "",
"SCALE_FACTOR_X": 1,
"SCALE_FACTOR_Y": 1,
"ACCIDENT_ECCEN_X": 0,
"ACCIDENT_ECCEN_Y": 0,
"ACCIDENT_TORSION": false,
"NHERENT_TORSION": false,
"SEISMIC_FORCE": [
{
"STORY_NAME": "Roof",
"FORCE_X": 1250.5,
"FORCE_Y": 1180.75
},
{
"STORY_NAME": "Story3",
"FORCE_X": 980.25,
"FORCE_Y": 925.5
},
{
"STORY_NAME": "Story2",
"FORCE_X": 710,
"FORCE_Y": 665.25
},
{
"STORY_NAME": "Story1",
"FORCE_X": 420.75,
"FORCE_Y": 390.5
}
],
"ADDITIONAL_LOAD": {
"STORY_NAME": "Roof",
"ALONG_X": 35.5,
"ALONG_Y": 28.25,
"TORSIONAL_RZ": 12.75
}
}
}
}
Specifications
| No. | Description | Key | Value Type | Default | Required | |||
|---|---|---|---|---|---|---|---|---|
1 |
Seismic load code. |
"SEIS_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 |
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 |
Whether to consider inherent torsion. |
"IIINHERENT_TORSION" |
boolean |
false |
Optional |
|||
9 |
User-defined story-level seismic force list. |
"SEISMIC_FORCE" |
array [object] |
- |
Required |
|||
(1) | Story name. |
"STORY_NAME" |
string |
- |
Required |
|||
(2) | User-defined seismic force in X direction. |
"FORCE_X" |
number |
- |
Required |
|||
(3) | User-defined seismic force in Y direction. |
"FORCE_Y" |
number |
- |
Required |
|||
10 |
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 |
|||