Reference#

Complete GraphQL type reference for the GeoZone Tool API.

Enums#

LanguageEnum#

Value

Language

EN

English

DE

German

FR

French

IT

Italian

ES

Spanish

PT

Portuguese

PL

Polish

CS

Czech

RU

Russian

ZH

Chinese

LoadzoneTypeEnum#

Value

Description

SNOW

Snow load zones (EN 1991-1-3)

WIND

Wind load zones (EN 1991-1-4)

EARTHQUAKE

Seismic zones (EN 1998)

TORNADO

Tornado zones (US only)

RiskCategoryEnum#

Value

Description

I

Low hazard (agricultural, minor storage)

II

Standard occupancy (default for most buildings)

III

Substantial hazard (schools, jails, high occupancy)

IV

Essential facilities (hospitals, emergency services)

SiteClassEnum#

Value

Description

DEFAULT

Site class determined from USGS data

A

Hard rock (Vs30 > 1500 m/s)

B

Rock (760–1500 m/s)

BC

Very dense soil / soft rock (530–760 m/s)

C

Very dense soil (360–530 m/s)

CD

Stiff soil (270–360 m/s)

D

Stiff clay (180–270 m/s)

DE

Soft clay (100–180 m/s)

E

Soft clay soil (Vs30 < 100 m/s)

ScreenshotTypeEnum#

Value

Description

PNG

Lossless PNG image

JPEG

Compressed JPEG image


Input Types#

CharacteristicsInput#

Field

Type

Description

address

String!

Free-text address or place name

type

LoadzoneTypeEnum

Zone type filter (SNOW, WIND, EARTHQUAKE, TORNADO)

standard

String

Standard name filter

annex

String

Annex / national annex filter

layerId

Int

Layer ID within the standard

GetLoadzoneScreenshotPublicInput#

Field

Type

Description

address

String!

Free-text address or place name

type

LoadzoneTypeEnum

Zone type filter

standard

String

Standard name filter

annex

String

Annex filter

layerId

Int

Layer ID

zoom

Int

Map zoom level (default 5)

map

String

Map tile style

layerOrder

Int

Layer rendering order

screenshotType

ScreenshotTypeInput

Image format and quality

ScreenshotTypeInput#

Field

Type

Description

type

ScreenshotTypeEnum!

PNG or JPEG (default PNG)

quality

Int!

JPEG quality 0–100 (default 90)

GetLoadzonePdfInput#

Field

Type

Description

address

String!

Free-text address or place name

standard

String

Standard name filter

annex

String

Annex filter

layerId

Int

Layer ID


Output Types#

CharacteristicsResponseMiaType#

Field

Type

Description

code

String!

Response status code (OK, COUNTRY_CHANGED, ANNEX_CHANGED, ERROR)

message

String

Human-readable message when code ≠ OK

geoLocation

GeofinderDataType

Resolved location data

characteristics

[CharacteristicsLoadzoneType2]

Per-standard zone results

noLiability

String

Disclaimer text

CharacteristicsLoadzoneType2#

Field

Type

Description

standard

String!

Standard name

annex

String!

Annex name

zoneCharacteristics

CharacteristicsLayerType2!

Layer result

CharacteristicsLayerType2#

Field

Type

Description

id

Int!

Layer ID

zone

CharacteristicsZoneType2!

Matched zone value

characteristics

[CharacteristicsVariableType]!

Ordered load values

CharacteristicsVariableType#

Field

Type

Description

name

String!

Parameter name (plain text)

nameHtml

String!

Parameter name (HTML)

calculatedValue

String

Computed value

unitsHtml

String!

Units (HTML)

description

String!

Parameter description

decimalPlaces

Int!

Display precision

sequence

Int!

Display order

GeofinderDataType#

Field

Type

Description

latitude

String!

Resolved latitude

longitude

String!

Resolved longitude

altitude

String!

Elevation

street

String

Street name and number

zip

String

Postal code

city

String

City / municipality

state

String

State or region

country

String

Country name

countryCode

String

ISO country code

GeoLocationType#

Field

Type

Description

latitude

String!

Latitude

longitude

String!

Longitude

altitude

String!

Elevation

displayName

String

Full formatted address

street

String

Street name and number

zip

String

Postal code

city

String

City / municipality

state

String

State or region

country

String

Country name

countryCode

String

ISO country code

UserDataType#

Field

Type

Description

email

String!

Account email address

clicks

Int!

Remaining API calls this billing period

LoadzoneGroupShortType#

Field

Type

Description

country

String!

Country name

countryCode

String!

ISO country code

typeGroups

[LoadzoneTypeGroupType]!

Zones grouped by type

LoadzoneShortType#

Field

Type

Description

standard

String!

Standard name

annex

String!

Annex name

loadzoneId

String!

Unique load zone identifier

layers

[LoadzoneLayerShortType]!

Available layers

Asce722ResponseType#

Field

Type

Description

code

String!

Response status code

message

String

Error or informational message

referenceDocument

String

USGS reference document URL

data

Asce722DataType

Seismic design parameters

Asce722DataType#

Field

Type

Description

ss

Float

Mapped MCEr spectral acceleration, short period

s1

Float

Mapped MCEr spectral acceleration, 1-second period

sms

Float

Site-adjusted MCEr, short period

sm1

Float

Site-adjusted MCEr, 1-second period

sds

Float

Design spectral acceleration, short period

sd1

Float

Design spectral acceleration, 1-second period

pgam

Float

Site-adjusted MCEr peak ground acceleration

sdc

String

Seismic design category (A–F)

ts

Float

Ts = SD1 / SDS

t0

Float

T0 = 0.2 × Ts

tl

Float

Long-period transition period

cv

Float

Vertical seismic coefficient

twoPeriodDesignSpectrum

SpectrumType

Two-period design response spectrum

twoPeriodMcErSpectrum

SpectrumType

Two-period MCEr response spectrum

multiPeriodDesignSpectrum

SpectrumType

Multi-period design response spectrum

multiPeriodMcErSpectrum

SpectrumType

Multi-period MCEr response spectrum

verticalDesignSpectrum

SpectrumType

Vertical design response spectrum

verticalMcErSpectrum

SpectrumType

Vertical MCEr response spectrum

SpectrumType#

Field

Type

Description

periods

[Float!]!

Period values in seconds

ordinates

[Float!]!

Spectral acceleration values (g)

warning

String

Optional data quality warning

PdfProgressType#

Field

Type

Description

currentStep

Int!

Steps completed

steps

Int!

Total steps

message

String!

Status message

pdfResult

PdfResultType

Present on final message only

PdfResultType#

Field

Type

Description

pdf

String!

Base64-encoded PDF

name

String!

Suggested filename