WADL documentation: Share-Services

Documentation of the web services to discover and deliver pre-calculated Data to evaluate earthquake hazard in Europe.

Summary

ResourceMethodDescription
http://appsrvr.share-eu.org:8080/share/mapGET (getMapModel) Model: provide an index of all hazard models that are defined for a specific point of interest
GET (getMapImt) Intensity measurement type: Provide all intensity measurement types (IMT) for which a specified model provides hazard information
GET (getMapPoe) Poe and timespan: Provide probability of exceedance and investigation timespan's with maps available, given model ID and intensity measurement types (IMT) for which a specified model provides hazard information
GET (getMapSoil) Site class: Provide site class with maps available, given model ID, IMT, POE, time span for which a specified model provides hazard information
GET (getMapAggreg) Aggregation: Provide aggregation types with maps available, given model ID, IMT, POE, time span, site class for which a specified model provides hazard information
GET (getMapId) Map id: Provide the map identity, and the layer reference for the web map service, of the hazard map for given model ID, IMT, POE, time span, site class and aggregation type.
GET (getMapValues) Map Data (text): Provide map values within a rectangle of the hazard map for given model ID, IMT, POE, time span, site clas and aggregation type.
http://appsrvr.share-eu.org:8080/share/curveGET (getCurveModels) Models: provide an index of all hazard models that are defined for a specific point of interest
GET (getCurveImt) IMT's: Provide all intensity measurement types (IMT) for which a specified model provides hazard curves information
GET (getCurveSoil) Site class: Provide site class with curves available, given model ID, IMT, POE, time span for which a specified model provides hazard information
GET (getCurveAggreg) Aggregation: Provide aggregation types with curves available, given model ID, IMT, POE, time span, site class for which a specified model provides hazard information
GET (getCurveNrml) Curve data (nrml): Provide the Curve in the Nrml Format for given model ID, IMT, site clas and aggregation type.
http://appsrvr.share-eu.org:8080/share/spectraGET (getSpectraModel) Models: provide an index of all hazard spectras that are defined for a specific point of interest
GET (getSpectraImt) IMT's: Provide all intensity measurement types (IMT) for which a specified model provides hazard information
GET (getSpectraPoe) Poe and Timespan: Provide probability of exceedance and investigation timespan's with maps available, given model ID and intensity measurement types (IMT) for which a specified model provides hazard information
GET (getSpectraSoil) Site class: Provide site class with maps available, given model ID, IMT, POE, time span for which a specified model provides hazard information
GET (getSpectraAggreg) Aggreagtion: Provide aggregation types with maps available, given model ID, IMT, POE, time span, site class for which a specified model provides hazard information
GET (getSpectra) Spectra Data: Provide the data for the selected hazard spectrum
http://appsrvr.share-eu.org:8080/share/design-spectra/design_spectra_elastic_ecGET (getDesignSpectra) Design Spectra: Get the data of the elastic design spectra EC8. (Values need to be cheked for correctness!)

Grammars

../documents/nrml/nrml.xsd

Resources


http://appsrvr.share-eu.org:8080/share/map

Hazard Maps: Methods to discover and deliver avilabel harzard maps

Methods
GETgetMapModel()

Model: provide an index of all hazard models that are defined for a specific point of interest

request
query params
latxs:double
(required)
default: 		Latitude of point to select from
lonxs:double
(required)
default: 		Longitude of point to select from

responses
status:
200
representations
application/xml
<xs:element name='models'>
<xs:complexType>
<xs:sequence>
<xs:element name='model'>
<xs:complexType>
<xs:sequence>
<xs:element name='id' type='xs:integer'>
</xs:element>
<xs:element name='name' type='xs:string'>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
GETgetMapImt()

Intensity measurement type: Provide all intensity measurement types (IMT) for which a specified model provides hazard information

request
query params
idxs:int
(required)
default: 		Index of Hazard model

responses
status:
200
representations
application/xml
<xs:element name='imtcodes'>
<xs:complexType>
<xs:sequence>
<xs:element name='imtcode'>
<xs:complexType>
<xs:sequence>
<xs:element name='code' type='xs:string'>
</xs:element>
<xs:element name='imunittype' type='xs:string'>
</xs:element>
<xs:element name='imunitdescr' type='xs:string'>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
GETgetMapPoe()

Poe and timespan: Provide probability of exceedance and investigation timespan's with maps available, given model ID and intensity measurement types (IMT) for which a specified model provides hazard information

request
query params
idxs:int
(required)
default: 		Index of Hazard model
imtxs:string
(required)		Intensity measure type

responses
status:
200
representations
application/xml
<xs:element name='exceedances'>
<xs:complexType>
<xs:sequence>
<xs:element name='exceedance'>
<xs:complexType>
<xs:sequence>
<xs:element name='hmapexceedprob' type='xs:double'>
</xs:element>
<xs:element name='hmapexceedyears' type='xs:integer'>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
GETgetMapSoil()

Site class: Provide site class with maps available, given model ID, IMT, POE, time span for which a specified model provides hazard information

request
query params
idxs:int
(required)
default: 		Index of Hazard model
imtxs:string
(required)		Intensity measure type
poexs:double
(required)		Probability of exceedance
timespanpoexs:int
(required)		Investigation timespan

responses
status:
200
representations
application/xml
<xs:element name='soiltype'>
<xs:complexType>
<xs:sequence>
<xs:element name='type' type='xs:string'>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
GETgetMapAggreg()

Aggregation: Provide aggregation types with maps available, given model ID, IMT, POE, time span, site class for which a specified model provides hazard information

request
query params
idxs:int
(required)
default: 		Index of Hazard model
imtxs:string
(required)		Intensity measure type
poexs:double
(required)		Probability of exceedance
timespanpoexs:int
(required)		Investigation timespan
soilTypexs:string
(required)		Soil type or site characterization

responses
status:
200
representations
application/xml
<xs:element name='fractiles'>
<xs:complexType>
<xs:sequence>
<xs:element name='fractile'>
<xs:complexType>
<xs:sequence>
<xs:element name='aggregationtype' type='xs:string'>
</xs:element>
<xs:element name='aggregationlevel' type='xs:double'>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
GETgetMapId()

Map id: Provide the map identity, and the layer reference for the web map service, of the hazard map for given model ID, IMT, POE, time span, site class and aggregation type.

request
query params
idxs:int
(required)
default: 		Index of Hazard model
imtxs:string
(required)		Intensity measure type
hmapexceedprobxs:double
(required)		Probability of exceedance
hmapexceedyearsxs:int
(required)		 Investigation timespan
soilTypexs:string
(required)		Soil type or site characterization
aggregationtypexs:String
(required)
options: single, arithmetic, ordinal		Single (single value, if no branching) , arithmetic (for mean) or ordinal (for median and quantiles), and NULL, if map refers to a single endbranch of a multibranch model';
aggregationlevelxs:double
(required)		Ranging from 0 to 1 and having 0.5 for median / mean

responses
status:
200
representations
application/xml
<xs:element name='hazardmaplocation'>
<xs:complexType>
<xs:sequence>
<xs:element name='hmapid' type='xs:integer'>
</xs:element>
<xs:element name='hmapwms' type='xs:string'>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
GETgetMapValues()

Map Data (text): Provide map values within a rectangle of the hazard map for given model ID, IMT, POE, time span, site clas and aggregation type.

request
query params
lon1xs:double
(required)
default: 		Longitude of upper left point from rectangle to select from
lat1xs:double
(required)
default: 		Latitude of upper left point from rectangle to select from
lon2xs:double
(required)
default: 		Longitude of lower right point from rectangle to select from
lat2xs:double
(required)
default: 		Latitude of lower right point from rectangle to select from
idxs:int
(required)
default: 		Index of Hazard model
imtxs:string
(required)		Intensity measure type
hmapexceedprobxs:double
(required)		Probability of exceedance
hmapexceedyearsxs:int
(required)		 Investigation timespan
soilTypexs:string
(required)		Soil type or site characterization
aggregationtypexs:String
(required)
options: single, arithmetic, ordinal		Single (single value, if no branching) , arithmetic (for mean) or ordinal (for median and quantiles), and NULL, if map refers to a single endbranch of a multibranch model';
aggregationlevelxs:double
(required)		Ranging from 0 to 1 and having 0.5 for median / mean

responses
status:
200
representations
text/plain

http://appsrvr.share-eu.org:8080/share/curve

Curves: Methods to discover and deliver avilabel harzard curves.

Methods
GETgetCurveModels()

Models: provide an index of all hazard models that are defined for a specific point of interest

request
query params
latxs:double
(required)
default: 		Latitude of point to select from
lonxs:double
(required)
default: 		Longitude of point to select from

responses
status:
200
representations
application/xml
<xs:element name='models'>
<xs:complexType>
<xs:sequence>
<xs:element name='model'>
<xs:complexType>
<xs:sequence>
<xs:element name='id' type='xs:integer'>
</xs:element>
<xs:element name='name' type='xs:string'>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
GETgetCurveImt()

IMT's: Provide all intensity measurement types (IMT) for which a specified model provides hazard curves information

request
query params
lonxs:double
(required)
default: 		Longitude of point to select from
latxs:double
(required)
default: 		Latitude of point to select from
idxs:int
(required)
default: 		Index of Hazard model

responses
status:
200
representations
application/xml
<xs:element name='imtcodes'>
<xs:complexType>
<xs:sequence>
<xs:element name='imtcode'>
<xs:complexType>
<xs:sequence>
<xs:element name='code' type='xs:string'>
</xs:element>
<xs:element name='imunittype' type='xs:string'>
</xs:element>
<xs:element name='imunitdescr' type='xs:string'>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
GETgetCurveSoil()

Site class: Provide site class with curves available, given model ID, IMT, POE, time span for which a specified model provides hazard information

request
query params
lonxs:double
(required)
default: 		Longitude of point to select from
latxs:double
(required)
default: 		Latitude of point to select from
idxs:int
(required)
default: 		Index of Hazard model
imtxs:string
(required)		Intensity measure type

responses
status:
200
representations
application/xml
<xs:element name='soiltype'>
<xs:complexType>
<xs:sequence>
<xs:element name='type' type='xs:string'>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
GETgetCurveAggreg()

Aggregation: Provide aggregation types with curves available, given model ID, IMT, POE, time span, site class for which a specified model provides hazard information

request
query params
lonxs:double
(required)
default: 		Longitude of point to select from
latxs:double
(required)
default: 		Latitude of point to select from
idxs:int
(required)
default: 		Index of Hazard model
imtxs:string
(required)		Intensity measure type
soilTypexs:string
(required)		Soil type or site characterization

responses
status:
200
representations
application/xml
<xs:element name='fractiles'>
<xs:complexType>
<xs:sequence>
<xs:element name='fractile'>
<xs:complexType>
<xs:sequence>
<xs:element name='aggregationtype' type='xs:string'>
</xs:element>
<xs:element name='aggregationlevel' type='xs:double'>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
GETgetCurveNrml()

Curve data (nrml): Provide the Curve in the Nrml Format for given model ID, IMT, site clas and aggregation type.

request
query params
lonxs:double
(required)
default: 		Longitude of point to select from
latxs:double
(required)
default: 		Latitude of point to select from
idxs:int
(required)
default: 		Index of Hazard model
imtxs:string
(required)		Intensity measure type
soilTypexs:string
(required)		Soil type or site characterization
aggregationtypexs:String
(required)
options: single, arithmetic, ordinal		Single (single value, if no branching) , arithmetic (for mean) or ordinal (for median and quantiles), and NULL, if map refers to a single endbranch of a multibranch model';
aggregationlevelxs:double
(required)		Ranging from 0 to 1 and having 0.5 for median / mean

responses
status:
200
representations
application/xml (ns2:hazardResult)

Source: ../documents/nrml/nrml.xsd

http://appsrvr.share-eu.org:8080/share/spectra

Harzard Spectras: services to discover and deliver avilabel harzard spectras.

Methods
GETgetSpectraModel()

Models: provide an index of all hazard spectras that are defined for a specific point of interest

request
query params
latxs:double
(required)
default: 		Latitude of point to select from
lonxs:double
(required)
default: 		Longitude of point to select from

responses
status:
200
representations
application/xml
<xs:element name='models'>
<xs:complexType>
<xs:sequence>
<xs:element name='model'>
<xs:complexType>
<xs:sequence>
<xs:element name='id' type='xs:integer'>
</xs:element>
<xs:element name='name' type='xs:string'>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
GETgetSpectraImt()

IMT's: Provide all intensity measurement types (IMT) for which a specified model provides hazard information

request
query params
lonxs:double
(required)
default: 		Longitude of point to select from
latxs:double
(required)
default: 		Latitude of point to select from
idxs:int
(required)
default: 		Index of Hazard model

responses
status:
200
representations
application/xml
<xs:element name='imtcodes'>
<xs:complexType>
<xs:sequence>
<xs:element name='imtcode'>
<xs:complexType>
<xs:sequence>
<xs:element name='code' type='xs:string'>
</xs:element>
<xs:element name='imunittype' type='xs:string'>
</xs:element>
<xs:element name='imunitdescr' type='xs:string'>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
GETgetSpectraPoe()

Poe and Timespan: Provide probability of exceedance and investigation timespan's with maps available, given model ID and intensity measurement types (IMT) for which a specified model provides hazard information

request
query params
lonxs:double
(required)
default: 		Longitude of point to select from
latxs:double
(required)
default: 		Latitude of point to select from
idxs:int
(required)
default: 		Index of Hazard model
imtxs:string
(required)		Intensity measure type

responses
status:
200
representations
application/xml
<xs:element name='exceedances'>
<xs:complexType>
<xs:sequence>
<xs:element name='exceedance'>
<xs:complexType>
<xs:sequence>
<xs:element name='hmapexceedprob' type='xs:double'>
</xs:element>
<xs:element name='hmapexceedyears' type='xs:integer'>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
GETgetSpectraSoil()

Site class: Provide site class with maps available, given model ID, IMT, POE, time span for which a specified model provides hazard information

request
query params
lonxs:double
(required)
default: 		Longitude of point to select from
latxs:double
(required)
default: 		Latitude of point to select from
idxs:int
(required)
default: 		Index of Hazard model
imtxs:string
(required)		Intensity measure type
poexs:double
(required)		Probability of exceedance
timespanpoexs:int
(required)		Investigation timespan

responses
status:
200
representations
application/xml
<xs:element name='soiltype'>
<xs:complexType>
<xs:sequence>
<xs:element name='type' type='xs:string'>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
GETgetSpectraAggreg()

Aggreagtion: Provide aggregation types with maps available, given model ID, IMT, POE, time span, site class for which a specified model provides hazard information

request
query params
lonxs:double
(required)
default: 		Longitude of point to select from
latxs:double
(required)
default: 		Latitude of point to select from
modelidxs:int
(required)
default: 		Index of Model to select results from
imtxs:string
(required)		Intensity measure type
poexs:double
(required)		Probability of exceedance
timespanpoexs:int
(required)		Investigation timespan
soilTypexs:string
(required)		Soil type or site characterization

responses
status:
200
representations
application/xml
<xs:element name='fractiles'>
<xs:complexType>
<xs:sequence>
<xs:element name='fractile'>
<xs:complexType>
<xs:sequence>
<xs:element name='aggregationtype' type='xs:string'>
</xs:element>
<xs:element name='aggregationlevel' type='xs:double'>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
GETgetSpectra()

Spectra Data: Provide the data for the selected hazard spectrum

request
query params
lonxs:double
(required)
default: 		Longitude of point to select from
latxs:double
(required)
default: 		Latitude of point to select from
modelidxs:int
(required)
default: 		Index of Model to select results from
imtxs:string
(required)		Intensity measure type
poexs:double
(required)		Probability of exceedance
timespanpoexs:int
(required)		Investigation timespan
soilTypexs:string
(required)		Soil type or site characterization
aggregationtypexs:String
(required)
options: single, arithmetic, ordinal		Single (single value, if no branching) , arithmetic (for mean) or ordinal (for median and quantiles), and NULL, if map refers to a single endbranch of a multibranch model';
aggregationlevelxs:double
(required)		Ranging from 0 to 1 and having 0.5 for median / mean

responses
status:
200
representations
application/xml (ns2:hazardSpectrum)

Source: ../documents/nrml/nrml.xsd

http://appsrvr.share-eu.org:8080/share/design-spectra/design_spectra_elastic_ec

Design Spectras:

Methods
GETgetDesignSpectra()

Design Spectra: Get the data of the elastic design spectra EC8. (Values need to be cheked for correctness!)

request
query params
lonxs:double
(required)
default: 		Longitude of point to select from
latxs:double
(required)
default: 		Latitude of point to select from
spectratypexs:string
(required)
default:
options: type1, bigMag, type2, smallMag		select type of spetra,
imtxs:string
(required)		Intensity measure type
design-accelerationxs:double
(required)
default: 		accleration for design spectra

responses
status:
200
representations
application/xml (ns2:hazardResult)

Source: ../documents/nrml/nrml.xsd