You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openmeetings.apache.org by se...@apache.org on 2011/12/15 12:06:23 UTC
svn commit: r1214698 [2/6] - /incubator/openmeetings/site/docs/
Added: incubator/openmeetings/site/docs/RestAPI.html
URL: http://svn.apache.org/viewvc/incubator/openmeetings/site/docs/RestAPI.html?rev=1214698&view=auto
==============================================================================
--- incubator/openmeetings/site/docs/RestAPI.html (added)
+++ incubator/openmeetings/site/docs/RestAPI.html Thu Dec 15 11:06:23 2011
@@ -0,0 +1,316 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+
+<!--
+Copyright 1999-2004 The Apache Software Foundation
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+
+<!-- Content Stylesheet for Site -->
+
+
+<!-- start the processing -->
+ <!-- ====================================================================== -->
+ <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
+ <!-- Main Page Section -->
+ <!-- ====================================================================== -->
+ <html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
+
+ <meta name="author" value="
+ Sebastian Wagner
+ ">
+ <meta name="email" value="sebawagner@apache.org">
+
+
+
+
+
+
+
+ <title>Apache OpenMeetings - Home</title>
+ <link rel="stylesheet" type="text/css" href="css/openmeetings.css">
+ </head>
+
+ <body bgcolor="#ffffff" text="#000000" link="#123465" vlink="#123465" alink="#000000">
+ <table border="0" width="100%" cellspacing="0">
+ <!-- TOP IMAGE -->
+ <tr>
+ <td align='LEFT'>
+ <td align="left">
+<a href="http://incubator.apache.org/openmeetings/"><img src="./images/logo-2.jpg" alt="Apache OpenMeetings" border="0"/></a>
+</td>
+ </td>
+ <td align='LEFT'>
+ <td width="80%" align="left" valign="bottom" >
+
+</td>
+ </td>
+ </tr>
+ </table>
+ <table border="0" width="100%" cellspacing="4">
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+
+ <tr>
+ <!-- LEFT SIDE NAVIGATION -->
+ <td width="10%" valign="top" nowrap="true">
+
+ <!-- special ACon Logo - leave here for next time
+ <a href="http://apachecon.com/2005/US/">
+ <img src="http://apache.org/images/ac2005us_blue_125x125.jpg" height="125"
+ width="125" border="0" alt="ApacheCon US 2005" />
+ </a> -->
+
+ <!-- regular menu -->
+
+
+ <!-- ============================================================ -->
+
+ <div class="ro">
+ <div class="lo">
+ <div class="ru">
+ <div class="lu">
+ <div class="inhalt">
+
+ <font color="#000000" face="arial,helvetica,sanserif" size="2pt" >
+ <b>General</b>
+ </a>
+ <hr style="width:100%; color:#999999; background-color:#999999; height:1px; border:0px;"/>
+ <ul>
+ <font color="#000000" face="arial,helvetica,sanserif" size="2pt">
+ <li> <a href="./index.html">Home</a>
+</li>
+ </font>
+ <font color="#000000" face="arial,helvetica,sanserif" size="2pt">
+ <li> <a href="./license.html">License</a>
+</li>
+ </font>
+ <font color="#000000" face="arial,helvetica,sanserif" size="2pt">
+ <li> <a href="http://www.apache.org/">ASF</a>
+</li>
+ </font>
+ <font color="#000000" face="arial,helvetica,sanserif" size="2pt">
+ <li> <a href="./downloads.html">Downloads</a>
+</li>
+ </font>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="ro">
+ <div class="lo">
+ <div class="ru">
+ <div class="lu">
+ <div class="inhalt">
+
+ <font color="#000000" face="arial,helvetica,sanserif" size="2pt" >
+ <b>Community</b>
+ </a>
+ <hr style="width:100%; color:#999999; background-color:#999999; height:1px; border:0px;"/>
+ <ul>
+ <font color="#000000" face="arial,helvetica,sanserif" size="2pt">
+ <li> <a href="./get-involved.html">Get Involved</a>
+</li>
+ </font>
+ <font color="#000000" face="arial,helvetica,sanserif" size="2pt">
+ <li> <a href="./team-list.html">Committers</a>
+</li>
+ </font>
+ <font color="#000000" face="arial,helvetica,sanserif" size="2pt">
+ <li> <a href="./mail-lists.html">Mailing Lists</a>
+</li>
+ </font>
+ <font color="#000000" face="arial,helvetica,sanserif" size="2pt">
+ <li> <a href=".https://cwiki.apache.org/OPENMEETINGS/">Wiki</a>
+</li>
+ </font>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="ro">
+ <div class="lo">
+ <div class="ru">
+ <div class="lu">
+ <div class="inhalt">
+
+ <font color="#000000" face="arial,helvetica,sanserif" size="2pt" >
+ <b>Development</b>
+ </a>
+ <hr style="width:100%; color:#999999; background-color:#999999; height:1px; border:0px;"/>
+ <ul>
+ <font color="#000000" face="arial,helvetica,sanserif" size="2pt">
+ <li> <a href="./svn.html">Source Code</a>
+</li>
+ </font>
+ <font color="#000000" face="arial,helvetica,sanserif" size="2pt">
+ <li> <a href="http://issues.apache.org/jira/browse/OPENMEETINGS">JIRA</a>
+</li>
+ </font>
+ <font color="#000000" face="arial,helvetica,sanserif" size="2pt">
+ <li> <a href="./dependencies.html">Dependencies</a>
+</li>
+ </font>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="ro">
+ <div class="lo">
+ <div class="ru">
+ <div class="lu">
+ <div class="inhalt">
+
+ <font color="#000000" face="arial,helvetica,sanserif" size="2pt" >
+ <b>Integration</b>
+ </a>
+ <hr style="width:100%; color:#999999; background-color:#999999; height:1px; border:0px;"/>
+ <ul>
+ <font color="#000000" face="arial,helvetica,sanserif" size="2pt">
+ <li> <a href="./SoapRestAPI.html">SOAP/REST API</a>
+</li>
+ </font>
+ <font color="#000000" face="arial,helvetica,sanserif" size="2pt">
+ <li> <a href="./RestAPI.html">REST API Sample</a>
+</li>
+ </font>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </div>
+ </div>
+ <br/>
+ <img src="images/apache-incubator-logo-no-borders.png" alt="apache-incubator-logo-no-borders.png" border="0"/>
+
+ </td>
+ <td width="90%" align="left" valign="top">
+ <table border="0" cellspacing="0" cellpadding="0" cellspacing="0" width="100%">
+ <tr><td ><!-- bgcolor="#EEEEEE" -->
+ <font color="#000000" face="verdana,arial,helvetica,sanserif">
+ <a name="Introduction"><strong>Introduction</strong></a>
+ <hr style="width:100%; color:#999999; background-color:#999999; height:1px; border:0px;"/>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p> For a detailed instruction which services, methods and params are available see the list in the SoapMethods. ALL methods that are implemented for the SOAP API are also available via REST.
+ </p>
+ </blockquote>
+ </p>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ <table border="0" cellspacing="0" cellpadding="0" cellspacing="0" width="100%">
+ <tr><td ><!-- bgcolor="#EEEEEE" -->
+ <font color="#000000" face="verdana,arial,helvetica,sanserif">
+ <a name="How to invoke Services via REST"><strong>How to invoke Services via REST</strong></a>
+ <hr style="width:100%; color:#999999; background-color:#999999; height:1px; border:0px;"/>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>For example for the method getSession in the UserService, you would use this URL via REST:
+ </p>
+ <p>Sample URL: </p>
+ <a href="http://demo.openmeetings.de/openmeetings/services/UserService/getSession">http://demo.openmeetings.de/openmeetings/services/UserService/getSession</a>
+ <p>Result: </p>
+ <div class="xmlcode">
+ <ns:getSessionResponse><br />
+ <ns:return type="org.openmeetings.app.hibernate.beans.basic.Sessiondata"><br />
+ <ax219:id>156971</ax219:id><br />
+ <ax219:language_id xsi:nil="true"/><br />
+ <ax219:organization_id xsi:nil="true"/><br />
+ <ax219:refresh_time>2011-07-03T14:40:44.000Z</ax219:refresh_time><br />
+ <ax219:sessionXml xsi:nil="true"/><br />
+ <ax219:session_id>26584705202d7c1de6cc8e7e28890e3d</ax219:session_id><br />
+ <ax219:starttermin_time>2011-07-03T14:40:44.000Z</ax219:starttermin_time><br />
+ <ax219:storePermanent xsi:nil="true"/><br />
+ <ax219:user_id xsi:nil="true"/><br />
+ </ns:return><br />
+ </ns:getSessionResponse><br />
+ </div>
+ <p>To login a user the call to auth would be:</p>
+ <p>Sample URL: </p>
+ <a href="http://demo.openmeetings.de/openmeetings/services/UserService/loginUser?SID=26584705202d7c1de6cc8e7e28890e3d&username=hans&userpass=test">http://demo.openmeetings.de/openmeetings/services/UserService/loginUser?SID=26584705202d7c1de6cc8e7e28890e3d&username=han&userpass=test</a>
+ <p>Result: </p>
+ <div class="xmlcode">
+ <ns:loginUserResponse><br />
+ <ns:return>-11</ns:return><br />
+ </ns:loginUserResponse><br />
+ </div>
+ <p>=> It does return -10, which is the error id cause we will not write down a SOAP login to our public server in this wiki. However the correct way to check this error would be to invoke the call to get the localized error message. So we invoke the method to get the error via REST:</p>
+ <p>Sample URL: </p>
+ <a href="http://demo.openmeetings.de/openmeetings/services/UserService/getErrorByCode?SID=26584705202d7c1de6cc8e7e28890e3d&errorid=-10&language_id=1">http://demo.openmeetings.de/openmeetings/services/UserService/getErrorByCode?SID=26584705202d7c1de6cc8e7e28890e3d&errorid=-10&language_id=1</a>
+ <p>Result:</p>
+ <div class="xmlcode">
+ <ns:getErrorByCodeResponse><br />
+ <ns:return type="org.openmeetings.app.data.beans.basic.ErrorResult"><br />
+ <ax218:errmessage>Username not found</ax218:errmessage><br />
+ <ax218:errorId>-10</ax218:errorId><br />
+ <ax218:errortype>Error</ax218:errortype><br />
+ </ns:return><br />
+ </ns:getErrorByCodeResponse><br />
+ </div>
+ </blockquote>
+ </p>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ </td>
+ </tr>
+
+ <!-- FOOTER -->
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+ <tr><td colspan="2">
+ <div align="center"><font color="#123465" size="-1"><em>
+ Copyright © 2003-2011, The Apache Software Foundation
+ </em></font></div>
+ </td></tr>
+ </table>
+ </body>
+ </html>
+<!-- end the processing -->
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Propchange: incubator/openmeetings/site/docs/RestAPI.html
------------------------------------------------------------------------------
svn:mime-type = text/plain