GaiaSup static page / apidoc.html

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
  <head>
    <title>Documentation - GaiaSup</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="keywords" content="GaiaSup,LBS,Geo,Spatial,Location Base Service,Spatial Publish Subscribe,SPS,ImonCloud" />
    <meta name="description" content="Spatial PubSub Service for your Geo / Spatial / Location Base Service in the cloud by Imonology">
    <meta name="author" content="Imonology LLC">
    <meta http-equiv="content-type" content="text/html; charset=utf-8" />

    <!-- styles -->
    <!--<link href="../../assets/css/bs_united.css" rel="stylesheet">-->
    <link href="/assets/css/bs_united.css" rel="stylesheet">
    <style type="text/css">
      body {
        padding-top: 60px;
        padding-bottom: 40px;
      }
    </style>
    <!--<link href="../../assets/css/bootstrap-responsive.css" rel="stylesheet">-->
    <link href="/assets/css/bootstrap-responsive.css" rel="stylesheet">

    <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
    <!--[if lt IE 9]>
      <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->

    <!-- fav and touch icons -->
    <!--<link rel="shortcut icon" href="./assets/ico/favicon.ico">-->
    <!--<link rel="apple-touch-icon-precomposed" sizes="144x144" href="./assets/ico/apple-touch-icon-144-precomposed.png">-->
    <!--<link rel="apple-touch-icon-precomposed" sizes="114x114" href="./assets/ico/apple-touch-icon-114-precomposed.png">-->
    <!--<link rel="apple-touch-icon-precomposed" sizes="72x72" href="./assets/ico/apple-touch-icon-72-precomposed.png">-->
    <!--<link rel="apple-touch-icon-precomposed" href="./assets/ico/apple-touch-icon-57-precomposed.png">-->
  </head>

  <body>

    <div class="navbar navbar-fixed-top">
      <div class="navbar-inner">
        <div class="container">
          <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </a>
          <a class="brand" href="/">GaiaSup</a>
          <div class="nav-collapse">
            <ul class="nav">
              <li><a href="/">Home</a></li>
              <li><a href="/pricing">Pricing</a></li>
              <li><a href="/manage">Manage</a></li>
              <li class="active"><a href="/doc/api">Documentation</a></li>
              <li><a data-toggle="modal" href="#contact">Contact us</a></li>
              <!--<li><a href="/contact">Contact us</a></li>-->
            </ul>

            <!-- The drop down menu -->
            <ul class="nav pull-right">
              <li><a href="/login">Log In / Sign Up</a></li>
              <!--<li class="divider-vertical"></li>-->
              <!--<li class="drop down">-->
              <!--<a class="dropdown-toggle" href="#" data-toggle="dropdown">Log In <strong class="caret"></strong></a>-->
              <!--<div class="dropdown-menu" style="padding: 15px; padding-bottom: 0px;">-->
                <!--<form id="frmLogin">-->
                  <!--<input id="txtUserID" style="margin-bottom: 15px;" type="text" name="txtUserID" size="30" />-->
                  <!--<input id="txtUserPW" style="margin-bottom: 15px;" type="password" name="txtUserPW" size="30" />-->

                  <!--<input class="btn btn-primary" style="clear: left; width: 100%; height: 32px; font-size: 13px;" type="button" id="btnLogin" name="btnLogin" value="Log In" />-->
                <!--</form>-->
              <!--</div>-->
              <!--</li>-->
            </ul>
          </div>
          <!--/.nav-collapse -->
        </div>
      </div>
    </div>

    <div class="container">
      <div class="hero-unit" id="restapi">
        <h2>REST API Documentation</h2>
        <hr/>
        <ul class="nav nav-pills" id="apifilter">
          <li class="active">
            <a href="#">All</a>
          </li>
          <li>
            <a href="#layer">Layer</a>
          </li>
          <li>
            <a href="#node">Node</a>
          </li>
          <li>
            <a href="#pos">Position</a>
          </li>
          <li>
            <a href="#msg">Message</a>
          </li>
          <li>
            <a href="#misc">Misc.</a>
          </li>
        </ul>
        <table class="table">
          <thead>
            <tr>
              <th class="span3">API Name</th>
              <th class="span1">Method</th>
              <th>Description</th>
            </tr>
          </thead>
          <tbody>
            <tr data-group="layer">
              <td><a href="/doc/api/register_layer">Register Layer</a></td>
              <td><center><span class="label label-success">GET</span></center></td>
              <td>Register a Layer under a given API key. Returns OK on success or already exist.</td>
            </tr>
            <tr data-group="node">
              <td><a href="/doc/api/register_node">Register Node</a></td>
              <td><center><span class="label label-success">GET</span></center></td>
              <td>Register a Node under a given API key and Layer. Returns OK on success or if already exist.</td>
            </tr>
            <tr data-group="pos">
              <td><a href="/doc/api/publish_pos">Publish Pos</a></td>
              <td><center><span class="label label-info">POST</span></center></td>
              <td>Publish self position for other Nodes to see.</td>
            </tr>
            <tr data-group="pos">
              <td><a href="/doc/api/query_square">Query Square</a></td>
              <td><center><span class="label label-success">GET</span></center></td>
              <td>Obtain the positions of other Nodes within a square area.</td>
            </tr>
            <tr data-group="node">
              <td><a href="/doc/api/query_node">Query Node (Single)</a></td>
              <td><center><span class="label label-success">GET</span></center></td>
              <td>Obtain the information of a Node.</td>
            </tr>
            <tr data-group="node">
              <td><a href="/doc/api/query_node_multi">Query Node (Multiple)</a></td>
              <td><center><span class="label label-info">POST</span></center></td>
              <td>Obtain the information of a list of Nodes.</td>
            </tr>
            <tr data-group="node">
              <td><a href="/doc/api/subscribe_node">Subscribe Node (Single)</a></td>
              <td><center><span class="label label-success">GET</span></center></td>
              <td>Subscribe the updates of a Node.</td>
            </tr>
            <tr data-group="node">
              <td><a href="/doc/api/subscribe_node_multi">Subscribe Node (Multiple)</a></td>
              <td><center><span class="label label-info">POST</span></center></td>
              <td>Subscribe the updates of a list of Nodes at once.</td>
            </tr>
            <tr data-group="misc">
              <td><a href="/doc/api/get_subscribers#gs_self">Get Subscribers (Self)</a></td>
              <td><center><span class="label label-success">GET</span></center></td>
              <td>Get the list of subscribers to the current Node.</td>
            </tr>
            <tr data-group="misc">
              <td><a href="/doc/api/get_subscribers#gs_other">Get Subscribers (Other)</a></td>
              <td><center><span class="label label-success">GET</span></center></td>
              <td>Get the subscriber list of another specified Node.</td>
            </tr>
            <tr data-group="misc">
              <td><a href="/doc/api/valid">Valid</a></td>
              <td><center><span class="label label-success">GET</span></center></td>
              <td>Validate whether a particular Node is registered.</td>
            </tr>
            <tr data-group="layer">
              <td><a href="/doc/api/revoke_layer">Revoke Layer</a></td>
              <td><center><span class="label label-success">GET</span></center></td>
              <td>Revoke a currently existing Layer.</td>
            </tr>
            <tr data-group="node">
              <td><a href="/doc/api/revoke_node">Revoke Node</a></td>
              <td><center><span class="label label-success">GET</span></center></td>
              <td>Revoke a currently existing Node</td>
            </tr>
            <tr data-group="msg">
              <td><a href="/doc/api/send_msg">Send Message (Single)</a></td>
              <td><center><span class="label label-info">POST</span></center></td>
              <td>Send message to a node.</td>
            </tr>
            <tr data-group="msg">
              <td><a href="/doc/api/send_msg_multi">Send Message (Multiple)</a></td>
              <td><center><span class="label label-info">POST</span></center></td>
              <td>Send message to some nodes at once.</td>
            </tr>
            <tr data-group="msg">
              <td><a href="/doc/api/recv_msg">Receive Message</a></td>
              <td><center><span class="label label-success">GET</span></center></td>
              <td>Receive new messages.</td>
            </tr>
            <tr data-group="msg">
              <td><a href="/doc/api/query_msg">Query Message</a></td>
              <td><center><span class="label label-success">GET</span></center></td>
              <td>Query from message history.</td>
            </tr>
          </tbody>
        </table>
      </div>

      <hr>

      <div class="hero-unit" id="restapi">
        <h2>Libraries</h2>
        <hr/>
        <ol>
          <li>
            <a href="#js">JavaScript</a>
          </li>
          <li>
            <a href="#python">Python</a>
          </li>
        </ol>
      </div>

    <hr>

    <footer>
    <center>
      <p>&copy; 2010-2012, <a href="http://imonology.com/" target="_blank">Imonology, LLC</a>. All rights reserved.</p>
    </center>
    </footer>

    </div>
    <!-- /container -->

    <!-- Modals -->
    <div class="modal hide fade" id="contact">
      <div class="modal-header">
        <a class="close" data-dismiss="modal">×</a>
        <h3>Contact us</h3>
      </div>
      <div class="modal-body">
        <p>You can send feedback or report bug to <a href="mailto:contact@GaiaSup.com">contact@GaiaSup.com</a></p>
      </div>
      <div class="modal-footer">
        <a data-dismiss="modal" href="#" class="btn btn-primary" id="ContactUsClose">Close</a>
      </div>
    </div>

    <!-- Le javascript
    ================================================== -->
    <!-- Placed at the end of the document so the pages load faster -->
    <script src="/assets/js/jquery.js"></script>
    <script src="/assets/js/bootstrap-transition.js"></script>
    <script src="/assets/js/bootstrap-alert.js"></script>
    <script src="/assets/js/bootstrap-modal.js"></script>
    <script src="/assets/js/bootstrap-dropdown.js"></script>
    <script src="/assets/js/bootstrap-scrollspy.js"></script>
    <script src="/assets/js/bootstrap-tab.js"></script>
    <script src="/assets/js/bootstrap-tooltip.js"></script>
    <script src="/assets/js/bootstrap-popover.js"></script>
    <script src="/assets/js/bootstrap-button.js"></script>
    <script src="/assets/js/bootstrap-collapse.js"></script>
    <script src="/assets/js/bootstrap-carousel.js"></script>
    <script src="/assets/js/bootstrap-typeahead.js"></script>

    <script src="/assets/js/custom/apidoc.js"></script>

  </body>
</html>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.