Reference#
Complete GraphQL type reference for the GeoZone Tool API.
Enums#
LanguageEnum#
Value |
Language |
|---|---|
|
English |
|
German |
|
French |
|
Italian |
|
Spanish |
|
Portuguese |
|
Polish |
|
Czech |
|
Russian |
|
Chinese |
LoadzoneTypeEnum#
Value |
Description |
|---|---|
|
Snow load zones (EN 1991-1-3) |
|
Wind load zones (EN 1991-1-4) |
|
Seismic zones (EN 1998) |
|
Tornado zones (US only) |
RiskCategoryEnum#
Value |
Description |
|---|---|
|
Low hazard (agricultural, minor storage) |
|
Standard occupancy (default for most buildings) |
|
Substantial hazard (schools, jails, high occupancy) |
|
Essential facilities (hospitals, emergency services) |
SiteClassEnum#
Value |
Description |
|---|---|
|
Site class determined from USGS data |
|
Hard rock (Vs30 > 1500 m/s) |
|
Rock (760–1500 m/s) |
|
Very dense soil / soft rock (530–760 m/s) |
|
Very dense soil (360–530 m/s) |
|
Stiff soil (270–360 m/s) |
|
Stiff clay (180–270 m/s) |
|
Soft clay (100–180 m/s) |
|
Soft clay soil (Vs30 < 100 m/s) |
ScreenshotTypeEnum#
Value |
Description |
|---|---|
|
Lossless PNG image |
|
Compressed JPEG image |
Input Types#
CharacteristicsInput#
Field |
Type |
Description |
|---|---|---|
|
String! |
Free-text address or place name |
|
LoadzoneTypeEnum |
Zone type filter (SNOW, WIND, EARTHQUAKE, TORNADO) |
|
String |
Standard name filter |
|
String |
Annex / national annex filter |
|
Int |
Layer ID within the standard |
GetLoadzoneScreenshotPublicInput#
Field |
Type |
Description |
|---|---|---|
|
String! |
Free-text address or place name |
|
LoadzoneTypeEnum |
Zone type filter |
|
String |
Standard name filter |
|
String |
Annex filter |
|
Int |
Layer ID |
|
Int |
Map zoom level (default 5) |
|
String |
Map tile style |
|
Int |
Layer rendering order |
|
ScreenshotTypeInput |
Image format and quality |
ScreenshotTypeInput#
Field |
Type |
Description |
|---|---|---|
|
ScreenshotTypeEnum! |
PNG or JPEG (default PNG) |
|
Int! |
JPEG quality 0–100 (default 90) |
GetLoadzonePdfInput#
Field |
Type |
Description |
|---|---|---|
|
String! |
Free-text address or place name |
|
String |
Standard name filter |
|
String |
Annex filter |
|
Int |
Layer ID |
Output Types#
CharacteristicsResponseMiaType#
Field |
Type |
Description |
|---|---|---|
|
String! |
Response status code ( |
|
String |
Human-readable message when code ≠ OK |
|
GeofinderDataType |
Resolved location data |
|
[CharacteristicsLoadzoneType2] |
Per-standard zone results |
|
String |
Disclaimer text |
CharacteristicsLoadzoneType2#
Field |
Type |
Description |
|---|---|---|
|
String! |
Standard name |
|
String! |
Annex name |
|
CharacteristicsLayerType2! |
Layer result |
CharacteristicsLayerType2#
Field |
Type |
Description |
|---|---|---|
|
Int! |
Layer ID |
|
CharacteristicsZoneType2! |
Matched zone value |
|
[CharacteristicsVariableType]! |
Ordered load values |
CharacteristicsVariableType#
Field |
Type |
Description |
|---|---|---|
|
String! |
Parameter name (plain text) |
|
String! |
Parameter name (HTML) |
|
String |
Computed value |
|
String! |
Units (HTML) |
|
String! |
Parameter description |
|
Int! |
Display precision |
|
Int! |
Display order |
GeofinderDataType#
Field |
Type |
Description |
|---|---|---|
|
String! |
Resolved latitude |
|
String! |
Resolved longitude |
|
String! |
Elevation |
|
String |
Street name and number |
|
String |
Postal code |
|
String |
City / municipality |
|
String |
State or region |
|
String |
Country name |
|
String |
ISO country code |
GeoLocationType#
Field |
Type |
Description |
|---|---|---|
|
String! |
Latitude |
|
String! |
Longitude |
|
String! |
Elevation |
|
String |
Full formatted address |
|
String |
Street name and number |
|
String |
Postal code |
|
String |
City / municipality |
|
String |
State or region |
|
String |
Country name |
|
String |
ISO country code |
UserDataType#
Field |
Type |
Description |
|---|---|---|
|
String! |
Account email address |
|
Int! |
Remaining API calls this billing period |
LoadzoneGroupShortType#
Field |
Type |
Description |
|---|---|---|
|
String! |
Country name |
|
String! |
ISO country code |
|
[LoadzoneTypeGroupType]! |
Zones grouped by type |
LoadzoneShortType#
Field |
Type |
Description |
|---|---|---|
|
String! |
Standard name |
|
String! |
Annex name |
|
String! |
Unique load zone identifier |
|
[LoadzoneLayerShortType]! |
Available layers |
Asce722ResponseType#
Field |
Type |
Description |
|---|---|---|
|
String! |
Response status code |
|
String |
Error or informational message |
|
String |
USGS reference document URL |
|
Asce722DataType |
Seismic design parameters |
Asce722DataType#
Field |
Type |
Description |
|---|---|---|
|
Float |
Mapped MCEr spectral acceleration, short period |
|
Float |
Mapped MCEr spectral acceleration, 1-second period |
|
Float |
Site-adjusted MCEr, short period |
|
Float |
Site-adjusted MCEr, 1-second period |
|
Float |
Design spectral acceleration, short period |
|
Float |
Design spectral acceleration, 1-second period |
|
Float |
Site-adjusted MCEr peak ground acceleration |
|
String |
Seismic design category (A–F) |
|
Float |
Ts = SD1 / SDS |
|
Float |
T0 = 0.2 × Ts |
|
Float |
Long-period transition period |
|
Float |
Vertical seismic coefficient |
|
SpectrumType |
Two-period design response spectrum |
|
SpectrumType |
Two-period MCEr response spectrum |
|
SpectrumType |
Multi-period design response spectrum |
|
SpectrumType |
Multi-period MCEr response spectrum |
|
SpectrumType |
Vertical design response spectrum |
|
SpectrumType |
Vertical MCEr response spectrum |
SpectrumType#
Field |
Type |
Description |
|---|---|---|
|
[Float!]! |
Period values in seconds |
|
[Float!]! |
Spectral acceleration values (g) |
|
String |
Optional data quality warning |
PdfProgressType#
Field |
Type |
Description |
|---|---|---|
|
Int! |
Steps completed |
|
Int! |
Total steps |
|
String! |
Status message |
|
PdfResultType |
Present on final message only |
PdfResultType#
Field |
Type |
Description |
|---|---|---|
|
String! |
Base64-encoded PDF |
|
String! |
Suggested filename |