We propose a standardised API for Web Services that provide nice modelling facilities. Thes services do not have to be running openModeller. Rather the standard api provides a way to use any modelling software package from the openModeller Desktop application - providing that the modelling package is presented with the standard openModeller Web Services Interface (hereafter referred to as OWSI). See also Use Case Scenario for Open Modeller Web Services API
![/!\](./modern/img/alert.png "/!\"){kind=small}
Note: We are using the document/literal style
Call Name
Input type
Input description
Return type
Return type description
ping
void
no input needed
xsdint
A response of '1' from the server indicating that its online
getLayers
void
no input needed
xsdstring AvailableLayers
An xml file document describing available layers on the server
getLayer xsdstring
The unique identifier for the layer to retrieve
mime attachment?
Binary file containing the layer.
getLayerUrl xsdstring
The unique id for the layer to retrieve
String
Url for grabbing the environment layer specified (provides an alternative for mime attachment approach descibed above)
getAlgorithms
void
no input needed
Xml document describing the available algorithms and the parameters that can be used with each.
createModel
A valid xml document describing the model
xsdstring
The Job Id of the model being run
getModel
xsd_string
Job Id
The model generated by the given Job Id serialized as XML
projectModel
Input is model definition as generated by create model. It descibes the climate / environmental scenario into which the model should be projected.
xsdtring
The Job Id of the model projection being run
getMapAsAttachment
xsdstring
Job Id
mime attachment
The map generated by the given Job Id
getMapAsUrl
xsdstring
Job Id
xsdstring
Url for grabbing the map generated by the given Job Id
getMapAsWMSUrl xsdstring
Job Id
xsdstring
Url for viewing the map generated by the given Job Id - as a WMS resource
getProgress
xsdstring
Job Id
float
Progress indicator as a percentage. In addition the following numbers have special meaning: -1 Queued, -2 Aborted
getLog
xsdstring
Job Id
xsdstring
Text output from the openModeller process for this Job Id
Note items marked with are not ye timplemented but planned for the future.