source: trunk/docs/client/what.rst @ 838

Last change on this file since 838 was 754, checked in by djay, 9 years ago

Add the ZOO-Client API reference in the official documentation.

  • Property svn:keywords set to Date Author
  • Property svn:mime-type set to text/plain
File size: 2.1 KB
Line 
1.. _client-what:
2
3What is ZOO-Client ?
4=========================
5
6ZOO-Client is a client-side JavaScript API which provides simple methods
7for interacting with `WPS
8<http://www.opengeospatial.org/standards/wps/>`__ server from web
9applications. It is helpful for sending requests to any WPS compliant
10server (such as :ref:`kernel_index`) and to parse the output responses
11using simple JavaScript.
12
13
14JavaScript
15-------------------------------
16
17ZOO-Client relies on modern JavaScript libraries and can be seamlessly
18integrated in new or existing web platforms or
19applications. ZOO-Client works by expanding the tags available in WPS
20specific templates using values provided by a JavaScript hash or
21object. It allows to build valid WPS requests and to send them to a
22WPS server. It also provides functions to easily parse and reuse the
23output XML responses. Read the :ref:`next section <client-howto>` to
24get started.
25
26Please, refer to the `ZOO-Client API documentation
27<http://www.zoo-project.org/jsDoc/index.html>`__ for accessing the
28up-to-date documentation.
29
30
31Templates
32-------------------------------
33
34ZOO-Client uses logic-less `Mustache <http://mustache.github.io/>`__
35templates for creating well-formed WPS requests. Please, refer to the
36`ZOO-Client API documentation
37<http://www.zoo-project.org/jsDoc//module-wpsPayload.html>`__ for more
38details about the functions using the templates.
39
40
41GetCapabilities
42..........................................................
43
44*GetCapabilities* requests are created using the following template:
45
46.. include:: ../../zoo-project/zoo-client/lib/tpl/payload_GetCapabilities.mustache
47    :code: xml
48
49
50
51DescribeProcess
52..........................................................
53
54*DescribeProcess* requests are created using the following template:
55
56.. include:: ../../zoo-project/zoo-client/lib/tpl/payload_DescribeProcess.mustache
57    :code: xml
58
59
60Execute
61..........................................................
62
63*Execute* requests are created using a more complex template, as shown bellow:
64
65.. include:: ../../zoo-project/zoo-client/lib/tpl/payload_Execute.mustache
66    :code: xml
67
Note: See TracBrowser for help on using the repository browser.

Search

Context Navigation

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png