| <?xml version="1.0" encoding="UTF-8"?> | |
| <!-- | |
| 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. | |
| --> | |
| <document xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="website.xsd"> | |
| <properties> | |
| <title>Home</title> | |
| <author email="sebawagner@apache.org"> | |
| Sebastian Wagner | |
| </author> | |
| </properties> | |
| <body> | |
| <section name="Introduction"> | |
| <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> | |
| </section> | |
| <section name="How to invoke Services via REST"> | |
| <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.apache.openmeetings.hibernate.beans.basic.Sessiondata"/><br/> | |
| <div style="margin-left:20px"> | |
| <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/> | |
| </div> | |
| </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/> | |
| <div style="margin-left:20px"> | |
| <ns:return>-11</ns:return/><br/> | |
| </div> | |
| </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.apache.openmeetings.db.dto.basic.ErrorResult"/><br/> | |
| <div style="margin-left:20px"> | |
| <ax218:errmessage>Username not found</ax218:errmessage/><br/> | |
| <ax218:errorId>-10</ax218:errorId/><br/> | |
| <ax218:errortype>Error</ax218:errortype/><br/> | |
| </div> | |
| </ns:return/><br/> | |
| </ns:getErrorByCodeResponse/><br/> | |
| </div> | |
| </section> | |
| </body> | |
| </document> |