add info for apidoc

Myriam Bouchemit
1 parent 2cfa3a1a
Showing 9 changed files with 39 additions and 12 deletions Show diff stats
help/Methods_AMDA.xml
php/rest/getDataset.php
php/rest/getObsDataTree.php
php/rest/getOrbites.php
php/rest/getParameter.php
php/rest/getParameterList.php
php/rest/getStatus.php
php/rest/getTimeTable.php
php/rest/getTimeTablesList.php
@@ -1380,7 +1380,7 @@ of a set of typically orthogonal axes.
  
     <wsdl:service name="Methods_AMDA">
         <wsdl:port name="Methods_AMDAPort" binding="tns:Methods_AMDASoapBinding">
-            <soap:address location="http://cdpp3.irap.omp.eu/php/AMDA_METHODS_WSDL.php"/>
+            <soap:address location="http://amda.irap.omp.eu/php/AMDA_METHODS_WSDL.php"/>
         </wsdl:port>
     </wsdl:service>
 </wsdl:definitions>
@@ -20,10 +20,13 @@
  * @apiSuccess {String} success `true`
  * @apiSuccess {String} dataFileURLs URL of the files matching the criteria. If the file is empty, there is no data
  * matching these criteria.
+ * @apiSuccess {String} status status of the job ( done | in_progress )
  *
  * @apiSuccessExample Success-Response:
  *     HTTP/1.1 200 OK
+ *     [success] => 1
  *     http://amda.irap.omp.eu/AMDA/data/WSRESULT/getdataset_ace-imf-all_20130923T090000_20130924T130000.txt
+ *     [status] => done
  *
  * @apiErrorExample Error-Response:
  * {"error":"Cannot find info file for dataset ace-imf-any"}
@@ -12,7 +12,12 @@
  *
  * @apiSuccessExample Success-Response:
  *     HTTP/1.1 200 OK
- *     http://amda.irap.omp.eu/AMDA/data/WSRESULT/obsdatatree_impex_20180727_AmdaLocalDataBaseParameters.xml
+ *     [success] => 1
+ *         [WorkSpace] => stdClass Object
+ *      (
+ *          [LocalDataBaseParameters] => http://amda.irap.omp.eu/AMDA/data/WSRESULT/obsdatatree_impex_20180919_AmdaLocalDataBaseParameters.xml
+ *      )
+ *
  *
  * @apiErrorExample Error-Response:
  *     {"error":"No Amda Local DataBase Parameters description file"}
@@ -31,11 +31,14 @@
  *
  * @apiSuccess {String} success `true`
  * @apiSuccess {String} url_XYZ URL of the file containing the points.
+ * @apiSuccess {String} status status of the job ( done | in_progress )
  *
  
  * @apiSuccessExample Success-Response:
  *     HTTP/1.1 200 OK
- *     http://amda.irap.omp.eu/AMDA//data/WSRESULT/getorbites_ace_xyz_gse_km_20130923T090000_20130924T130000.txt
+ *     [success] => 1
+ *     http://amda.irap.omp.eu/AMDA/data/WSRESULT/getorbites_ace_xyz_gse_km_20130923T090000_20130924T130000.txt
+ *     [status] => done
  *
  * @apiErrorExample Error-Response:
  *     {"error":"Cannot find orbit data for ACE1 for 2013-09-23T09:00-2013-09-24T13:00 in km GSE( - )"}
@@ -22,10 +22,13 @@
  * @apiSuccess {String} success `true`
  * @apiSuccess {String} dataFileURLs URL of the files matching the criteria. If the file is empty, there is no data
  * matching these criteria.
+ * @apiSuccess {String} status status of the job ( done | in_progress )
  *
  * @apiSuccessExample Success-Response:
  *     HTTP/1.1 200 OK
- *     http://amda.irap.omp.eu/AMDA/data/WSRESULT/getparameter_c1_hia_dens_20130923T090000_20130924T130000.txt
+ *     [success] => 1
+ *     [dataFileURLS] => http://amda.irap.omp.eu/AMDA/data/WSRESULT/getparameter_c1_hia_dens_20130923T090000_20130924T130000.txt
+ *     [status] => done
  *
  * @apiErrorExample Error-Response:
  * {"error":"Exception detected : Cannot find parameter local file c1_hia_dens1"}
@@ -15,7 +15,18 @@
  
  * @apiSuccessExample Success-Response:
  *     HTTP/1.1 200 OK
- *     http://amda.irap.omp.eu/AMDA//data/WSRESULT/parameterlist_impex_20180912_AmdaLocalDataBaseParameters.xml
+ *     [success] => 1
+ *         [ParameterList] => stdClass Object
+ *      (
+ *          [LocalDataBaseParameters] => http://amda.irap.omp.eu/AMDA/data/WSRESULT/parameterlist_impex_20180919_AmdaLocalDataBaseParameters.xml
+ *      )
+ *      or with userID
+ *      (
+ *          [UserDefinedParameters] => http://amda.irap.omp.eu/AMDA/data/WSRESULT/parameterlist_userID_20180919_UserDefinedParameters.xml
+ *          [LocalDataBaseParameters] => http://amda.irap.omp.eu/AMDA/data/WSRESULT/parameterlist_userID_20180919_AmdaLocalDataBaseParameters.xml
+ *      )
+ *
+ *
  *
  * @apiErrorExample Error-Response:
  *     {"error":"Login procedure failed for impex1 : Check your password"}
@@ -15,7 +15,7 @@
  *
  * @apiSuccessExample Success-Response:
  *     HTTP/1.1 200 OK
- *     {"success":true,"status":"in progress"}
+ *     {"success":true,"status":"in progress"} or
  *     {"success":true,"status":"done","dataFileURLs":"http://amda.irap.omp.eu/AMDA/data/WSRESULT/getparameter_c1_hia_dens_20010923T090000_20130924T130000.txt"}
  *
  * @apiErrorExample Error-Response:
@@ -14,8 +14,9 @@
  * @apiSuccess {String} ttFileURL URL of the XML file containing the Time Table (VOTable format)
  *
  * @apiSuccessExample Success-Response:
- * HTTP/1.1 200 OK
- * http://amda.irap.omp.eu/AMDA/data/WSRESULT/timetable_impex_20180912_sharedtimeTable_0.xml
+ *     HTTP/1.1 200 OK
+ *     [success] => 1
+ *     [ttFileURL] => http://amda.irap.omp.eu/AMDA/data/WSRESULT/timetable_userID_20180919_tt_0.xml
  *
  * @apiErrorExample Error-Response:
  * {"error":"No such table sharedtimeTable_100 for user impex"}
 <?php
  
 /**
- * @api {get} getTimeTablesList.php getTimeTableList
+ * @api {get} getTimeTablesList.php getTimeTablesList
  * @apiDescription Provides the private list of Time Tables (Time Table or TT) owned by a user. When called without
  * userID, this web-service returns the list of shared Time Tables.
  *
- * @apiName getTimeTableList
+ * @apiName getTimeTablesList
  * @apiGroup webservices
  *
  * @apiParam {String} [userID] Identifier of the user in AMDA.
@@ -15,8 +15,9 @@
  * @apiSuccess {String} TimeTablesList URL of the XML file, which contains the list of Time Tables.
  *
  * @apiSuccessExample Success-Response:
- * HTTP/1.1 200 OK
- * http://amda.irap.omp.eu/data/WSRESULT/timetables_impex_20180905.xml
+ *     HTTP/1.1 200 OK
+ *     [success] => 1
+ *     [TimeTablesList] =>  http://amda.irap.omp.eu/data/WSRESULT/timetables_impex_20180905.xml
  *
  * @apiErrorExample Error-Response:
  *     {"error": "Workspace Error : Cannot load TimeTable list for userID"}