Input URI
{base url} + db/SPFC |
---|
Active Methods
POST, GET, PUT, DELETE |
---|
JSON Schema
Details
"SPFC": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"NAME": {
"description": "RS Functio Name",
"type": "string"
},
"iTYPE": {
"description": "Spectral Data Type",
"type": "integer"
},
"iMETHOD": {
"description": "Scaling Method",
"type": "integer"
},
"SCALE": {
"description": "Scale Factor or Maximum Value",
"type": "number"
},
"GRAV": {
"description": "Gravity",
"type": "number"
},
"DRATIO": {
"description": "Damping Ratio",
"type": "number"
},
"DESC": {
"description": "Description",
"type": "string"
},
"STR": {
"description": "String Data By Code",
"type": "object",
"properties": {
"SPEC_CODE": {
"description": "Design Spectrum Type",
"type": "string"
},
"SFI": {
"description": "Seismic Fortification",
"type": "string"
},
"SC_": {
"description": "Site Class or Seismic Criterion",
"type": "string"
},
"EQ_": {
"description": "Earth Response",
"type": "string"
},
"DIV": {
"description": "Division",
"type": "string"
},
"BT": {
"description": "Bridge Type",
"type": "string"
},
"ZM": {
"description": "ZoningMap",
"type": "string"
},
"ST": {
"description": "Site Type",
"type": "string"
},
"SI": {
"description": "Seismic Intensity",
"type": "string"
},
"SPECTYPE": {
"description": "Spectrum Type",
"type": "string"
},
"GROUTYPE": {
"description": "Ground Type",
"type": "string"
},
"PARATYPE": {
"description": "Parameter Type",
"type": "string"
},
"RESIONTYPE": {
"description": "Resion Type",
"type": "string"
},
"NATIONALANNEX": {
"description": "National Annex",
"type": "string"
},
"REGION": {
"description": "Region",
"type": "string"
},
"METHOD": {
"description": "Method",
"type": "string"
}
}
},
"OPT": {
"description": "Type or Option Data By Code",
"type": "object",
"properties": {
"NSC": {
"description": "Seismic Design Category",
"type": "integer"
},
"nLForce": {
"description": "nLForce",
"type": "integer"
},
"LARGEBRIDEGE": {
"description": "Large Bridege",
"type": "boolean"
},
"bVACC": {
"description": "Vertical Acceleration Spec",
"type": "boolean"
},
"iVACC": {
"description": "Vertical Acceleration Spec Type",
"type": "integer"
},
"bE2_005": {
"description": "Think E2 0.05",
"type": "boolean"
},
"SCCOPT": {
"description": "Seismic Coefficients Calculation Option",
"type": "integer"
},
"iSPTYPE": {
"description": "Soil Profile Type",
"type": "integer"
},
"iSEISZONEFACTOR": {
"description": "Seismic Zone Factor(Z)",
"type": "integer"
},
"iSEISSOURCETYPE": {
"description": "Seismic Source Type",
"type": "integer"
},
"SOILCLASS": {
"description": "Soil class",
"type": "integer"
},
"KD": {
"description": "Ductility class",
"type": "integer"
},
"KR": {
"description": "Structural Regularity in Elevation(Kr)",
"type": "integer"
},
"SC_": {
"description": "Site Class",
"type": "integer"
},
"SFI": {
"description": "Seismic Fortification Intensity",
"type": "integer"
},
"ZA": {
"description": "Acceleration Zone(Za)",
"type": "integer"
},
"ZV": {
"description": "Velocity Zone(Zv)",
"type": "integer"
},
"iSEISZONE": {
"description": "Seismic Zone",
"type": "integer"
},
"iEQMETHOD": {
"description": "Earthquake Input Method",
"type": "integer"
},
"bRELIEVE": {
"description": "Relieve",
"type": "boolean"
},
"iSPECTYPE": {
"description": "Spectrum Type",
"type": "integer"
},
"iSPECUSE": {
"description": "Spectrum Use Type",
"type": "integer"
},
"iSUBZONE": {
"description": "Sub Zone",
"type": "integer"
},
"iGROUTYPE": {
"description": "Ground Type",
"type": "integer"
},
"IMPORTANT_BRIDGE": {
"description": "Important bridge",
"type": "boolean"
},
"RESION_SEISMICITY": {
"description": "Region Seismicity",
"type": "integer"
},
"SOIL_CATEGORY": {
"description": "Soil Category",
"type": "integer"
},
"BYCODE": {
"description": "By code",
"type": "boolean"
},
"RISK_CATEGORY": {
"description": "Risk Category",
"type": "integer"
}
}
},
"VAL": {
"description": "Factor or Value Data By Code",
"type": "object",
"properties": {
"aTG": {
"description": "Design Characteristic Period of Ground Motion (TG, TG1, TG2)",
"type": "array",
"items": {
"type": "number",
"maxItems": 3
}
},
"aIF": {
"description": "Importance Factor (Ci, Cs, Cd)",
"type": "array",
"items": {
"type": "number",
"maxItems": 3
}
},
"aSRA": {
"description": "Spectral Response Acceleration (Sds, Sd1, Sms, Sm1)",
"type": "array",
"items": {
"type": "number",
"maxItems": 4
}
},
"aSRA_T": {
"description": "Spectral Response Acceleration (Sds_t, Sd1_t, Sms_t, Sm1_t)",
"type": "array",
"items": {
"type": "number",
"maxItems": 4
}
},
"aNSF": {
"description": "Near Source Factor (Nda, Ndv, Nma, Nmv)",
"type": "array",
"items": {
"type": "number",
"maxItems": 4
}
},
"aSC": {
"description": "Seismic Coefficient (Ca, Cv)",
"type": "array",
"items": {
"type": "number",
"maxItems": 2
}
},
"aMSRACC": {
"description": "Mapped Spectral Response Acceleration at Short Periods (Ss, S1)",
"type": "array",
"items": {
"type": "number",
"maxItems": 2
}
},
"aSMF": {
"description": "Site Magnify Factor (Fda, Fdv, Fma, Fmv)",
"type": "array",
"items": {
"type": "number",
"maxItems": 4
}
},
"aSCP": {
"description": "Site Coeff. at Short/1sec Period (Fa, Fv)",
"type": "array",
"items": {
"type": "number",
"maxItems": 2
}
},
"aEP": {
"description": "Effective Peak Acc/Vel (Aa, Av)",
"type": "array",
"items": {
"type": "number",
"maxItems": 2
}
},
"DP": {
"description": "Damping Ratio",
"type": "number"
},
"MaxEQ": {
"description": "Maximum Effect Coefficient",
"type": "number"
},
"G": {
"description": "Basic horizontal seismic acceleration alpha(g)",
"type": "number"
},
"EPA": {
"description": "Earthquake Area",
"type": "number"
},
"SMAX": {
"description": "",
"type": "number"
},
"PERIOD": {
"description": "Max Period",
"type": "number"
},
"DP2": {
"description": "Damping Ratio (By Code)",
"type": "number"
},
"ETA1": {
"description": "Eta1",
"type": "number"
},
"ETA2": {
"description": "Eta2",
"type": "number"
},
"GAMMA": {
"description": "Gamma",
"type": "number"
},
"A": {
"description": "Area",
"type": "number"
},
"SOILFACTOR": {
"description": "Soil Factor",
"type": "number"
},
"TB": {
"description": "Tb",
"type": "number"
},
"TC": {
"description": "Tc",
"type": "number"
},
"TD": {
"description": "Td",
"type": "number"
},
"AGR": {
"description": "Design Ground Acc. (Agr)",
"type": "number"
},
"I_": {
"description": "Importance Factor(I)",
"type": "number"
},
"XI": {
"description": "Viscous Damping Ratio(Xi)",
"type": "number"
},
"Q": {
"description": "Behavior Factor(q)",
"type": "number"
},
"B": {
"description": "Lower Bound Factor(h)",
"type": "number"
},
"TS": {
"description": "Site Natural Period",
"type": "number"
},
"SPTYPE": {
"description": "Soil Profile Type",
"type": "number"
},
"IE": {
"description": "Importance Factor (Ie)",
"type": "number"
},
"R_": {
"description": "Response Modification Coef. (R)",
"type": "number"
},
"CDISTANCE": {
"description": "Closest Distance to Known Seismic Source(km)",
"type": "number"
},
"Q0": {
"description": "Basic Behavior Factor(Q0)",
"type": "number"
},
"KW": {
"description": "Failure Mode Factor (Kw)",
"type": "number"
},
"ALPHA": {
"description": "Ratio of design ground acceleration to gravity acceleration",
"type": "number"
},
"CO": {
"description": "Base Shear Factor(Co)",
"type": "number"
},
"KH": {
"description": "Horizontal Seismic Coef.(Kh)",
"type": "number"
},
"CZ": {
"description": "General Effect Factor(Cz)",
"type": "number"
},
"V": {
"description": "Zonal Velocity Ratio(V)",
"type": "number"
},
"AG": {
"description": "Design Ground Acceleration(g)",
"type": "number"
},
"DPFAC": {
"description": "Damping Multiplying Factor",
"type": "number"
},
"IF": {
"description": "Importance Factor",
"type": "number"
},
"SMFACTOR": {
"description": "Seismic Magnify Factor",
"type": "number"
},
"RMFACTOR": {
"description": "Response Modify Factor",
"type": "number"
},
"ZONEFACTOR": {
"description": "Zone Factor (S)",
"type": "number"
},
"TL": {
"description": "Long Tran. Period(TL)",
"type": "number"
},
"PGA": {
"description": "PGA",
"type": "number"
},
"PHI": {
"description": "Phi",
"type": "number"
},
"DEPTH": {
"description": "Depth to MR",
"type": "number"
},
"FO": {
"description": "Amplification Factor (Fo)",
"type": "number"
},
"TCSTAR": {
"description": "Period of constant Hor. Acc. (Tc*)",
"type": "number"
},
"KP": {
"description": "kp",
"type": "number"
},
"Z": {
"description": "Z",
"type": "number"
},
"MU": {
"description": "Mu",
"type": "number"
},
"USERDEFSEISZONE": {
"description": "User Defined Seismic Zone",
"type": "number"
},
"FUNDAMENTAL_PERIOD": {
"description": "Fundamental Period (T1)",
"type": "number"
},
"K1": {
"description": "K1 Factor",
"type": "number"
},
"K2": {
"description": "K2 Factor",
"type": "number"
},
"K3": {
"description": "K3 Factor",
"type": "number"
},
"K4": {
"description": "K4 Factor",
"type": "number"
},
"KPSI": {
"description": "KPsi Factor",
"type": "number"
}
}
},
"aFUNC": {
"description": "Function Data List",
"type": "array",
"items": {
"type": "object",
"properties": {
"PERIOD": {
"description": "Period",
"type": "number"
},
"VALUE": {
"description": "Value",
"type": "number"
}
}
}
}
}
}
}
Examples
Eurocode-8(2004)
"Assign": {
"1": {
"NAME": "EURO2004 H-ELASTIC",
"iTYPE": 1,
"iMETHOD": 0,
"SCALE": 1,
"GRAV": 9.806,
"DRATIO": 0,
"DESC": "EURO2004 H-ELA: G=B,S=1.20,Tb=0.20,Tc=0.50,Td=2.00,AgR=0.08g,I=1.0,Damping=0.00",
"STR": {
"SPEC_CODE": "EURO2004",
"SPECTYPE": "HOR_ELA",
"GROUTYPE": "B",
"PARATYPE": "TYPE_1",
"NATIONALANNEX": "Recommended"
},
"VAL": {
"PERIOD": 6,
"SOILFACTOR": 1.2,
"TB": 0.2,
"TC": 0.5,
"TD": 2,
"AGR": 0.08,
"I_": 1,
"XI": 0
},
"CALC_OPT": true
}
}
}
Eurocode-8(1996) Design
"Assign": {
"1": {
"NAME": "EURO1996 DESIGN",
"iTYPE": 1,
"iMETHOD": 0,
"SCALE": 1,
"GRAV": 9.806,
"DRATIO": 0,
"DESC": "EURO1996 DESIGN: Soil=B qo=4.0 Kd=1.00 Kr=0.80 Kw=1.00 Alpha=0.20",
"STR": {
"SPEC_CODE": "EURO1996"
},
"OPT": {
"SOILCLASS": 1,
"KD": 0,
"KR": 1
},
"VAL": {
"PERIOD": 6,
"Q0": 4,
"KW": 1,
"ALPHA": 0.2
},
"CALC_OPT": true
}
}
}
Eurocode-8(1996) Elastic
"Assign": {
"1": {
"NAME": "EURO1996 ELASTIC",
"iTYPE": 1,
"iMETHOD": 0,
"SCALE": 1,
"GRAV": 9.806,
"DRATIO": 0.05,
"DESC": "EURO1996 ELASTIC: Soil=B Acc.=0.20g Damping=5.00",
"STR": {
"SPEC_CODE": "EURO1996_ELA"
},
"OPT": {
"SC_": 1
},
"VAL": {
"DP": 5,
"PERIOD": 6,
"AG": 0.2
},
"CALC_OPT": true
}
}
}
Specifications
No. | Description | Key | Value Type | Default | Required | |
---|---|---|---|---|---|---|
1 |
RS Function Name |
"NAME" |
String |
- |
Required |
|
2 |
Spectral Data Type • Normalized Accel.: 1 • Acceleration: 2 • Velocity: 3 • Displacement: 4 |
"iTYPE" |
Integer |
- |
Required |
|
3 |
Scaling Method • Scale Factor: 0 • Maximum Value: 1 |
"iMETHOD" |
Integer |
0 |
Optional |
|
4 |
Scaling Value |
"SCALE" |
Number |
- |
Required |
|
5 |
Gravity • Only for Normalized Accel. |
"GRAV" |
Number |
- |
Required |
|
6 |
Damping Ratio |
"DRATIO" |
Number |
0 |
Optional |
|
7 |
Description |
"DESC" |
String |
Blank |
Optional |
|
Eurocode-8(2004) |
||||||
8 |
String Data By Code |
"STR" |
Object |
- |
Required |
|
(1) |
Design Spectrum Type • Code: "EURO2004" |
"SPEC_CODE" |
String |
- |
Required |
|
(2) |
Spectrum Type • Horizontal Elastic Spectrum: "HOR_ELA" • Vertical Elastic Spectrum: "VER_ELA" • Horizontal Design Spectrum: "HOR_DGN" • Vertical Design Spectrum: "VER_DGN" |
"SPECTYPE" |
String |
- |
Required |
|
(3) |
Ground Type • A: "A" • B: "B" • C: "C" • D: "D" • E: "E" • S1: "S1" • S2: "S2" |
"GROUTYPE" |
String |
- |
Required |
|
(4) |
Spectrum Parameters • When National Annex is Recommended ◦ Type1: "TYPE_1" ◦ Type2: "TYPE_2" ◦ User Defined: "USER" |
"PARATYPE" |
String |
"TYPE_1" |
Optional |
|
(5) |
Region • When National Annex is Malaysia ◦ Peninsular: "RG1" ◦ Sabah: "RG2" ◦ Sarawak: "RG3" |
"RESIONTYPE" |
String |
"RG1" |
Optional |
|
(6) |
National Annex • Recommended: "Recommended" • Singapore: "Singapore" • Malaysia: "Malaysia" |
"NATIONALANNEX" |
String |
- |
Required |
|
9 |
Factor or Value Data By Code |
"VAL" |
Object |
- |
Required |
|
(1) |
Max Period |
"PERIOD" |
Number |
- |
Required |
|
(2) |
Soil Factor(S) ²⁾ |
"SOILFACTOR" |
Number |
- |
Required |
|
(3) |
Tb ²⁾ • "TYPE_1", "TYPE2": Value calculated • User Defined: Value input required |
"TB" |
Number |
- |
Required |
|
(4) |
Tc ²⁾ • "TYPE_1", "TYPE2": Value calculated • User Defined: Value input required |
"TC" |
Number |
- |
Required |
|
(5) |
Td ²⁾ • "TYPE_1", "TYPE2": Value calculated • User Defined: Value input required |
"TD" |
Number |
- |
Required |
|
(6) |
Ref. Peak Ground Acceleration(AgR) |
"AGR" |
Number |
- |
Required |
|
(7) |
Importance Factor(I) ¹⁾ • Preset Value: 0.8, 1.0, 1.2, 1.4 |
"I_" |
Number |
- |
Required |
|
(8) |
Viscous Damping Ratio(xi) • When Spectrum Type is Horizontal(Vertical) Elastic Spectrum |
"XI" |
Number |
- |
Required |
|
(9) |
Behavior Factor(q) • When Spectrum Type is Horizontal(Vertical) Design Spectrum |
"Q" |
Number |
- |
Required |
|
(10) |
Lower Bound Factor(b) • When Spectrum Type is Horizontal(Vertical) Design Spectrum |
"B" |
Number |
- |
Required |
|
10 |
Calculation Options |
"CALC_OPT" |
Boolean |
true |
Create |
|
Eurocode-8(1996) Design |
||||||
8 |
String Data By Code |
"STR" |
Object |
- |
Required |
|
(1) |
Design Spectrum Type • Code: "EURO1996" |
"SPEC_CODE" |
String |
- |
Required |
|
9 |
Type or Option Data By Code |
"OPT" |
Object |
- |
Optional |
|
(1) |
Soil Class(S) • A(1.0): 0 • B(1.0): 1 • C(0.9): 2 |
"SOILCLASS" |
Integer |
0 |
Optional |
|
(2) |
Ductility Class(Kd) • High(1.0): 0 • Medium(0.75): 1 • Low(0.5): 2 |
"KD" |
Integer |
0 |
Optional |
|
(3) |
Structural Regularity in Elevation(Kr) • Regular(1.0): 1 • Irregular(0.8): 1 |
"KR" |
Integer |
0 |
Optional |
|
10 |
Factor or Value Data By Code |
"VAL" |
Object |
- |
Required |
|
(1) |
Max Period |
"PERIOD" |
Number |
- |
Required |
|
(2) |
Basic Behavior Factor(qo) ¹⁾ • Preset Value: 5.0, 4.5, 4.0, 3.5, 2.0 |
"Q0" |
Number |
- |
Required |
|
(3) |
Failure Mode Factor(Kw) |
"KW" |
Number |
- |
Required |
|
(4) |
Ratio of design ground acceleration to gravity acceleration(alpha) |
"ALPHA" |
Number |
- |
Required |
|
11 |
Calculation Options |
"CALC_OPT" |
Boolean |
true |
Create |
|
Eurocode-8(1996) Elastic |
||||||
8 |
String Data By Code |
"STR" |
Object |
- |
Required |
|
(1) |
Design Spectrum Type • Code: "EURO1996_ELA" |
"SPEC_CODE" |
String |
- |
Required |
|
9 |
Type or Option Data By Code |
"OPT" |
Object |
- |
Optional |
|
(1) |
Soil Class(S) • A(1.0): 0 • B(1.0): 1 • C(0.9): 2 |
"SC_" |
Integer |
0 |
Optional |
|
10 |
Factor or Value Data By Code |
"VAL" |
Object |
- |
Required |
|
(1) |
Viscous Damping Ratio(%) |
"DP" |
Number |
- |
Required |
|
(2) |
Max Period |
"PERIOD" |
Number |
- |
Required |
|
(3) |
Design Ground Acceleration(g) |
"AG" |
Number |
- |
Required |
|
11 |
Calculation Options |
"CALC_OPT" |
Boolean |
true |
Create |
¹⁾ Preset Value: The value provided by the dialog.
When requesting API, even if a value other than the Preset Value is entered, the result will reflect that input.
²⁾ The value of this Key is calculated by MIDAS CIVIL NX based on the value of another keys, so even if a value is entered, it will not be reflected. Instead, the value calculated by MIDAS CIVIL NX will be applied.